1. Packages
  2. Packages
  3. Okta Provider
  4. API Docs
  5. getIdentitySourceUsers
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

    Retrieves a user record from an Okta Identity Source by external ID.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as okta from "@pulumi/okta";
    
    const example = okta.getIdentitySourceUsers({
        identitySourceId: "<identity-source-id>",
        externalId: "USEREXT123456EXAMPLE",
    });
    export const userEmail = example.then(example => example.profile?.email);
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.get_identity_source_users(identity_source_id="<identity-source-id>",
        external_id="USEREXT123456EXAMPLE")
    pulumi.export("userEmail", example.profile.email)
    
    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 {
    		example, err := okta.GetIdentitySourceUsers(ctx, &okta.GetIdentitySourceUsersArgs{
    			IdentitySourceId: "<identity-source-id>",
    			ExternalId:       "USEREXT123456EXAMPLE",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("userEmail", example.Profile.Email)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Okta.GetIdentitySourceUsers.Invoke(new()
        {
            IdentitySourceId = "<identity-source-id>",
            ExternalId = "USEREXT123456EXAMPLE",
        });
    
        return new Dictionary<string, object?>
        {
            ["userEmail"] = example.Apply(getIdentitySourceUsersResult => getIdentitySourceUsersResult.Profile?.Email),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.okta.OktaFunctions;
    import com.pulumi.okta.inputs.GetIdentitySourceUsersArgs;
    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) {
            final var example = OktaFunctions.getIdentitySourceUsers(GetIdentitySourceUsersArgs.builder()
                .identitySourceId("<identity-source-id>")
                .externalId("USEREXT123456EXAMPLE")
                .build());
    
            ctx.export("userEmail", example.profile().email());
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: okta:getIdentitySourceUsers
          arguments:
            identitySourceId: <identity-source-id>
            externalId: USEREXT123456EXAMPLE
    outputs:
      userEmail: ${example.profile.email}
    
    pulumi {
      required_providers {
        okta = {
          source = "pulumi/okta"
        }
      }
    }
    
    data "okta_getidentitysourceusers" "example" {
      identity_source_id = "<identity-source-id>"
      external_id        = "USEREXT123456EXAMPLE"
    }
    
    output "userEmail" {
      value = data.okta_getidentitysourceusers.example.profile.email
    }
    

    Using getIdentitySourceUsers

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIdentitySourceUsers(args: GetIdentitySourceUsersArgs, opts?: InvokeOptions): Promise<GetIdentitySourceUsersResult>
    function getIdentitySourceUsersOutput(args: GetIdentitySourceUsersOutputArgs, opts?: InvokeOptions): Output<GetIdentitySourceUsersResult>
    def get_identity_source_users(external_id: Optional[str] = None,
                                  id: Optional[str] = None,
                                  identity_source_id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetIdentitySourceUsersResult
    def get_identity_source_users_output(external_id: pulumi.Input[Optional[str]] = None,
                                  id: pulumi.Input[Optional[str]] = None,
                                  identity_source_id: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetIdentitySourceUsersResult]
    func GetIdentitySourceUsers(ctx *Context, args *GetIdentitySourceUsersArgs, opts ...InvokeOption) (*GetIdentitySourceUsersResult, error)
    func GetIdentitySourceUsersOutput(ctx *Context, args *GetIdentitySourceUsersOutputArgs, opts ...InvokeOption) GetIdentitySourceUsersResultOutput

    > Note: This function is named GetIdentitySourceUsers in the Go SDK.

    public static class GetIdentitySourceUsers 
    {
        public static Task<GetIdentitySourceUsersResult> InvokeAsync(GetIdentitySourceUsersArgs args, InvokeOptions? opts = null)
        public static Output<GetIdentitySourceUsersResult> Invoke(GetIdentitySourceUsersInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIdentitySourceUsersResult> getIdentitySourceUsers(GetIdentitySourceUsersArgs args, InvokeOptions options)
    public static Output<GetIdentitySourceUsersResult> getIdentitySourceUsers(GetIdentitySourceUsersArgs args, InvokeOptions options)
    
    fn::invoke:
      function: okta:index/getIdentitySourceUsers:getIdentitySourceUsers
      arguments:
        # arguments dictionary
    data "okta_getidentitysourceusers" "name" {
        # arguments
    }

    The following arguments are supported:

    ExternalId string
    IdentitySourceId string
    Id string
    ExternalId string
    IdentitySourceId string
    Id string
    external_id string
    identity_source_id string
    id string
    externalId String
    identitySourceId String
    id String
    externalId string
    identitySourceId string
    id string
    externalId String
    identitySourceId String
    id String

    getIdentitySourceUsers Result

    The following output properties are available:

    Supporting Types

    GetIdentitySourceUsersProfile

    Email string
    FirstName string
    HomeAddress string
    LastName string
    MobilePhone string
    SecondEmail string
    UserName string
    Email string
    FirstName string
    HomeAddress string
    LastName string
    MobilePhone string
    SecondEmail string
    UserName string
    email string
    first_name string
    home_address string
    last_name string
    mobile_phone string
    second_email string
    user_name string
    email String
    firstName String
    homeAddress String
    lastName String
    mobilePhone String
    secondEmail String
    userName String
    email string
    firstName string
    homeAddress string
    lastName string
    mobilePhone string
    secondEmail string
    userName string
    email String
    firstName String
    homeAddress String
    lastName String
    mobilePhone String
    secondEmail String
    userName String

    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