1. Packages
  2. Packages
  3. Okta Provider
  4. API Docs
  5. IdentitySourceUser
Viewing docs for Okta v6.9.0
published on Wednesday, Jul 1, 2026 by Pulumi
okta logo
Viewing docs for Okta v6.9.0
published on Wednesday, Jul 1, 2026 by Pulumi

    Manages an individual user in an Okta Identity Source. This resource creates or updates a single user record directly in the identity source (without requiring a session), using the external ID as the unique key.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = new okta.IdentitySourceUser("example", {
        identitySourceId: "<identity-source-id>",
        identitySourceUserId: "USEREXT123456EXAMPLE",
        profile: {
            userName: "jdoe@example.com",
            email: "jdoe@example.com",
            firstName: "Jane",
            lastName: "Doe",
        },
    });
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.IdentitySourceUser("example",
        identity_source_id="<identity-source-id>",
        identity_source_user_id="USEREXT123456EXAMPLE",
        profile={
            "user_name": "jdoe@example.com",
            "email": "jdoe@example.com",
            "first_name": "Jane",
            "last_name": "Doe",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-okta/sdk/v6/go/okta"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := okta.NewIdentitySourceUser(ctx, "example", &okta.IdentitySourceUserArgs{
    			IdentitySourceId:     pulumi.String("<identity-source-id>"),
    			IdentitySourceUserId: pulumi.String("USEREXT123456EXAMPLE"),
    			Profile: &okta.IdentitySourceUserProfileArgs{
    				UserName:  pulumi.String("jdoe@example.com"),
    				Email:     pulumi.String("jdoe@example.com"),
    				FirstName: pulumi.String("Jane"),
    				LastName:  pulumi.String("Doe"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Okta.IdentitySourceUser("example", new()
        {
            IdentitySourceId = "<identity-source-id>",
            IdentitySourceUserId = "USEREXT123456EXAMPLE",
            Profile = new Okta.Inputs.IdentitySourceUserProfileArgs
            {
                UserName = "jdoe@example.com",
                Email = "jdoe@example.com",
                FirstName = "Jane",
                LastName = "Doe",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.IdentitySourceUser;
    import com.pulumi.okta.IdentitySourceUserArgs;
    import com.pulumi.okta.inputs.IdentitySourceUserProfileArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new IdentitySourceUser("example", IdentitySourceUserArgs.builder()
                .identitySourceId("<identity-source-id>")
                .identitySourceUserId("USEREXT123456EXAMPLE")
                .profile(IdentitySourceUserProfileArgs.builder()
                    .userName("jdoe@example.com")
                    .email("jdoe@example.com")
                    .firstName("Jane")
                    .lastName("Doe")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: okta:IdentitySourceUser
        properties:
          identitySourceId: <identity-source-id>
          identitySourceUserId: USEREXT123456EXAMPLE
          profile:
            userName: jdoe@example.com
            email: jdoe@example.com
            firstName: Jane
            lastName: Doe
    
    pulumi {
      required_providers {
        okta = {
          source = "pulumi/okta"
        }
      }
    }
    
    resource "okta_identitysourceuser" "example" {
      identity_source_id      = "<identity-source-id>"
      identity_source_user_id = "USEREXT123456EXAMPLE"
      profile = {
        user_name  = "jdoe@example.com"
        email      = "jdoe@example.com"
        first_name = "Jane"
        last_name  = "Doe"
      }
    }
    

    Create IdentitySourceUser Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IdentitySourceUser(name: string, args: IdentitySourceUserArgs, opts?: CustomResourceOptions);
    @overload
    def IdentitySourceUser(resource_name: str,
                           args: IdentitySourceUserArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def IdentitySourceUser(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           identity_source_id: Optional[str] = None,
                           identity_source_user_id: Optional[str] = None,
                           profile: Optional[IdentitySourceUserProfileArgs] = None)
    func NewIdentitySourceUser(ctx *Context, name string, args IdentitySourceUserArgs, opts ...ResourceOption) (*IdentitySourceUser, error)
    public IdentitySourceUser(string name, IdentitySourceUserArgs args, CustomResourceOptions? opts = null)
    public IdentitySourceUser(String name, IdentitySourceUserArgs args)
    public IdentitySourceUser(String name, IdentitySourceUserArgs args, CustomResourceOptions options)
    
    type: okta:IdentitySourceUser
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "okta_identitysourceuser" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args IdentitySourceUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args IdentitySourceUserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args IdentitySourceUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentitySourceUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentitySourceUserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var identitySourceUserResource = new Okta.IdentitySourceUser("identitySourceUserResource", new()
    {
        IdentitySourceId = "string",
        IdentitySourceUserId = "string",
        Profile = new Okta.Inputs.IdentitySourceUserProfileArgs
        {
            Email = "string",
            FirstName = "string",
            HomeAddress = "string",
            LastName = "string",
            MobilePhone = "string",
            SecondEmail = "string",
            UserName = "string",
        },
    });
    
    example, err := okta.NewIdentitySourceUser(ctx, "identitySourceUserResource", &okta.IdentitySourceUserArgs{
    	IdentitySourceId:     pulumi.String("string"),
    	IdentitySourceUserId: pulumi.String("string"),
    	Profile: &okta.IdentitySourceUserProfileArgs{
    		Email:       pulumi.String("string"),
    		FirstName:   pulumi.String("string"),
    		HomeAddress: pulumi.String("string"),
    		LastName:    pulumi.String("string"),
    		MobilePhone: pulumi.String("string"),
    		SecondEmail: pulumi.String("string"),
    		UserName:    pulumi.String("string"),
    	},
    })
    
    resource "okta_identitysourceuser" "identitySourceUserResource" {
      identity_source_id      = "string"
      identity_source_user_id = "string"
      profile = {
        email        = "string"
        first_name   = "string"
        home_address = "string"
        last_name    = "string"
        mobile_phone = "string"
        second_email = "string"
        user_name    = "string"
      }
    }
    
    var identitySourceUserResource = new IdentitySourceUser("identitySourceUserResource", IdentitySourceUserArgs.builder()
        .identitySourceId("string")
        .identitySourceUserId("string")
        .profile(IdentitySourceUserProfileArgs.builder()
            .email("string")
            .firstName("string")
            .homeAddress("string")
            .lastName("string")
            .mobilePhone("string")
            .secondEmail("string")
            .userName("string")
            .build())
        .build());
    
    identity_source_user_resource = okta.IdentitySourceUser("identitySourceUserResource",
        identity_source_id="string",
        identity_source_user_id="string",
        profile={
            "email": "string",
            "first_name": "string",
            "home_address": "string",
            "last_name": "string",
            "mobile_phone": "string",
            "second_email": "string",
            "user_name": "string",
        })
    
    const identitySourceUserResource = new okta.IdentitySourceUser("identitySourceUserResource", {
        identitySourceId: "string",
        identitySourceUserId: "string",
        profile: {
            email: "string",
            firstName: "string",
            homeAddress: "string",
            lastName: "string",
            mobilePhone: "string",
            secondEmail: "string",
            userName: "string",
        },
    });
    
    type: okta:IdentitySourceUser
    properties:
        identitySourceId: string
        identitySourceUserId: string
        profile:
            email: string
            firstName: string
            homeAddress: string
            lastName: string
            mobilePhone: string
            secondEmail: string
            userName: string
    

    IdentitySourceUser Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The IdentitySourceUser resource accepts the following input properties:

    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    IdentitySourceUserId string
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    Profile IdentitySourceUserProfile
    User profile attributes.
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    IdentitySourceUserId string
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    Profile IdentitySourceUserProfileArgs
    User profile attributes.
    identity_source_id string
    ID of the identity source. Forces replacement when changed.
    identity_source_user_id string
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    profile object
    User profile attributes.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    identitySourceUserId String
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    profile IdentitySourceUserProfile
    User profile attributes.
    identitySourceId string
    ID of the identity source. Forces replacement when changed.
    identitySourceUserId string
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    profile IdentitySourceUserProfile
    User profile attributes.
    identity_source_id str
    ID of the identity source. Forces replacement when changed.
    identity_source_user_id str
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    profile IdentitySourceUserProfileArgs
    User profile attributes.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    identitySourceUserId String
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    profile Property Map
    User profile attributes.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the IdentitySourceUser resource produces the following output properties:

    Created string
    Timestamp when the user was created in the identity source (RFC3339).
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    Timestamp when the user was last updated in the identity source (RFC3339).
    Created string
    Timestamp when the user was created in the identity source (RFC3339).
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdated string
    Timestamp when the user was last updated in the identity source (RFC3339).
    created string
    Timestamp when the user was created in the identity source (RFC3339).
    id string
    The provider-assigned unique ID for this managed resource.
    last_updated string
    Timestamp when the user was last updated in the identity source (RFC3339).
    created String
    Timestamp when the user was created in the identity source (RFC3339).
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    Timestamp when the user was last updated in the identity source (RFC3339).
    created string
    Timestamp when the user was created in the identity source (RFC3339).
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdated string
    Timestamp when the user was last updated in the identity source (RFC3339).
    created str
    Timestamp when the user was created in the identity source (RFC3339).
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated str
    Timestamp when the user was last updated in the identity source (RFC3339).
    created String
    Timestamp when the user was created in the identity source (RFC3339).
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdated String
    Timestamp when the user was last updated in the identity source (RFC3339).

    Look up Existing IdentitySourceUser Resource

    Get an existing IdentitySourceUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: IdentitySourceUserState, opts?: CustomResourceOptions): IdentitySourceUser
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created: Optional[str] = None,
            identity_source_id: Optional[str] = None,
            identity_source_user_id: Optional[str] = None,
            last_updated: Optional[str] = None,
            profile: Optional[IdentitySourceUserProfileArgs] = None) -> IdentitySourceUser
    func GetIdentitySourceUser(ctx *Context, name string, id IDInput, state *IdentitySourceUserState, opts ...ResourceOption) (*IdentitySourceUser, error)
    public static IdentitySourceUser Get(string name, Input<string> id, IdentitySourceUserState? state, CustomResourceOptions? opts = null)
    public static IdentitySourceUser get(String name, Output<String> id, IdentitySourceUserState state, CustomResourceOptions options)
    resources:  _:    type: okta:IdentitySourceUser    get:      id: ${id}
    import {
      to = okta_identitysourceuser.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Created string
    Timestamp when the user was created in the identity source (RFC3339).
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    IdentitySourceUserId string
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    LastUpdated string
    Timestamp when the user was last updated in the identity source (RFC3339).
    Profile IdentitySourceUserProfile
    User profile attributes.
    Created string
    Timestamp when the user was created in the identity source (RFC3339).
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    IdentitySourceUserId string
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    LastUpdated string
    Timestamp when the user was last updated in the identity source (RFC3339).
    Profile IdentitySourceUserProfileArgs
    User profile attributes.
    created string
    Timestamp when the user was created in the identity source (RFC3339).
    identity_source_id string
    ID of the identity source. Forces replacement when changed.
    identity_source_user_id string
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    last_updated string
    Timestamp when the user was last updated in the identity source (RFC3339).
    profile object
    User profile attributes.
    created String
    Timestamp when the user was created in the identity source (RFC3339).
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    identitySourceUserId String
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    lastUpdated String
    Timestamp when the user was last updated in the identity source (RFC3339).
    profile IdentitySourceUserProfile
    User profile attributes.
    created string
    Timestamp when the user was created in the identity source (RFC3339).
    identitySourceId string
    ID of the identity source. Forces replacement when changed.
    identitySourceUserId string
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    lastUpdated string
    Timestamp when the user was last updated in the identity source (RFC3339).
    profile IdentitySourceUserProfile
    User profile attributes.
    created str
    Timestamp when the user was created in the identity source (RFC3339).
    identity_source_id str
    ID of the identity source. Forces replacement when changed.
    identity_source_user_id str
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    last_updated str
    Timestamp when the user was last updated in the identity source (RFC3339).
    profile IdentitySourceUserProfileArgs
    User profile attributes.
    created String
    Timestamp when the user was created in the identity source (RFC3339).
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    identitySourceUserId String
    The external ID of the user in the identity source. Used as the resource identifier. Forces replacement when changed.
    lastUpdated String
    Timestamp when the user was last updated in the identity source (RFC3339).
    profile Property Map
    User profile attributes.

    Supporting Types

    IdentitySourceUserProfile, IdentitySourceUserProfileArgs

    Email string
    Email address of the user.
    FirstName string
    First name of the user.
    HomeAddress string
    Home address of the user.
    LastName string
    Last name of the user.
    MobilePhone string
    Mobile phone number of the user.
    SecondEmail string
    Alternative email address of the user.
    UserName string
    Username of the user.
    Email string
    Email address of the user.
    FirstName string
    First name of the user.
    HomeAddress string
    Home address of the user.
    LastName string
    Last name of the user.
    MobilePhone string
    Mobile phone number of the user.
    SecondEmail string
    Alternative email address of the user.
    UserName string
    Username of the user.
    email string
    Email address of the user.
    first_name string
    First name of the user.
    home_address string
    Home address of the user.
    last_name string
    Last name of the user.
    mobile_phone string
    Mobile phone number of the user.
    second_email string
    Alternative email address of the user.
    user_name string
    Username of the user.
    email String
    Email address of the user.
    firstName String
    First name of the user.
    homeAddress String
    Home address of the user.
    lastName String
    Last name of the user.
    mobilePhone String
    Mobile phone number of the user.
    secondEmail String
    Alternative email address of the user.
    userName String
    Username of the user.
    email string
    Email address of the user.
    firstName string
    First name of the user.
    homeAddress string
    Home address of the user.
    lastName string
    Last name of the user.
    mobilePhone string
    Mobile phone number of the user.
    secondEmail string
    Alternative email address of the user.
    userName string
    Username of the user.
    email str
    Email address of the user.
    first_name str
    First name of the user.
    home_address str
    Home address of the user.
    last_name str
    Last name of the user.
    mobile_phone str
    Mobile phone number of the user.
    second_email str
    Alternative email address of the user.
    user_name str
    Username of the user.
    email String
    Email address of the user.
    firstName String
    First name of the user.
    homeAddress String
    Home address of the user.
    lastName String
    Last name of the user.
    mobilePhone String
    Mobile phone number of the user.
    secondEmail String
    Alternative email address of the user.
    userName String
    Username of the user.

    Import

    Import using {identity_source_id}/{id}:

    $ pulumi import okta:index/identitySourceUser:IdentitySourceUser example <identity-source-id>/<external-id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Okta pulumi/pulumi-okta
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the okta Terraform Provider.
    okta logo
    Viewing docs for Okta v6.9.0
    published on Wednesday, Jul 1, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial