1. Packages
  2. Packages
  3. Okta Provider
  4. API Docs
  5. getIdentitySourceGroups
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 group 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.getIdentitySourceGroups({
        identitySourceId: "<identity-source-id>",
        externalId: "GROUPEXT123456EXAMPLE",
    });
    export const groupOktaId = example.then(example => example.id);
    export const groupDisplayName = example.then(example => example.profile?.displayName);
    
    import pulumi
    import pulumi_okta as okta
    
    example = okta.get_identity_source_groups(identity_source_id="<identity-source-id>",
        external_id="GROUPEXT123456EXAMPLE")
    pulumi.export("groupOktaId", example.id)
    pulumi.export("groupDisplayName", example.profile.display_name)
    
    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.GetIdentitySourceGroups(ctx, &okta.GetIdentitySourceGroupsArgs{
    			IdentitySourceId: "<identity-source-id>",
    			ExternalId:       "GROUPEXT123456EXAMPLE",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("groupOktaId", example.Id)
    		ctx.Export("groupDisplayName", example.Profile.DisplayName)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Okta = Pulumi.Okta;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Okta.GetIdentitySourceGroups.Invoke(new()
        {
            IdentitySourceId = "<identity-source-id>",
            ExternalId = "GROUPEXT123456EXAMPLE",
        });
    
        return new Dictionary<string, object?>
        {
            ["groupOktaId"] = example.Apply(getIdentitySourceGroupsResult => getIdentitySourceGroupsResult.Id),
            ["groupDisplayName"] = example.Apply(getIdentitySourceGroupsResult => getIdentitySourceGroupsResult.Profile?.DisplayName),
        };
    });
    
    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.GetIdentitySourceGroupsArgs;
    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.getIdentitySourceGroups(GetIdentitySourceGroupsArgs.builder()
                .identitySourceId("<identity-source-id>")
                .externalId("GROUPEXT123456EXAMPLE")
                .build());
    
            ctx.export("groupOktaId", example.id());
            ctx.export("groupDisplayName", example.profile().displayName());
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: okta:getIdentitySourceGroups
          arguments:
            identitySourceId: <identity-source-id>
            externalId: GROUPEXT123456EXAMPLE
    outputs:
      groupOktaId: ${example.id}
      groupDisplayName: ${example.profile.displayName}
    
    pulumi {
      required_providers {
        okta = {
          source = "pulumi/okta"
        }
      }
    }
    
    data "okta_getidentitysourcegroups" "example" {
      identity_source_id = "<identity-source-id>"
      external_id        = "GROUPEXT123456EXAMPLE"
    }
    
    output "groupOktaId" {
      value = data.okta_getidentitysourcegroups.example.id
    }
    output "groupDisplayName" {
      value = data.okta_getidentitysourcegroups.example.profile.display_name
    }
    

    Using getIdentitySourceGroups

    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 getIdentitySourceGroups(args: GetIdentitySourceGroupsArgs, opts?: InvokeOptions): Promise<GetIdentitySourceGroupsResult>
    function getIdentitySourceGroupsOutput(args: GetIdentitySourceGroupsOutputArgs, opts?: InvokeOptions): Output<GetIdentitySourceGroupsResult>
    def get_identity_source_groups(external_id: Optional[str] = None,
                                   id: Optional[str] = None,
                                   identity_source_id: Optional[str] = None,
                                   profile: Optional[GetIdentitySourceGroupsProfile] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetIdentitySourceGroupsResult
    def get_identity_source_groups_output(external_id: pulumi.Input[Optional[str]] = None,
                                   id: pulumi.Input[Optional[str]] = None,
                                   identity_source_id: pulumi.Input[Optional[str]] = None,
                                   profile: pulumi.Input[Optional[GetIdentitySourceGroupsProfileArgs]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetIdentitySourceGroupsResult]
    func GetIdentitySourceGroups(ctx *Context, args *GetIdentitySourceGroupsArgs, opts ...InvokeOption) (*GetIdentitySourceGroupsResult, error)
    func GetIdentitySourceGroupsOutput(ctx *Context, args *GetIdentitySourceGroupsOutputArgs, opts ...InvokeOption) GetIdentitySourceGroupsResultOutput

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

    public static class GetIdentitySourceGroups 
    {
        public static Task<GetIdentitySourceGroupsResult> InvokeAsync(GetIdentitySourceGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetIdentitySourceGroupsResult> Invoke(GetIdentitySourceGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIdentitySourceGroupsResult> getIdentitySourceGroups(GetIdentitySourceGroupsArgs args, InvokeOptions options)
    public static Output<GetIdentitySourceGroupsResult> getIdentitySourceGroups(GetIdentitySourceGroupsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: okta:index/getIdentitySourceGroups:getIdentitySourceGroups
      arguments:
        # arguments dictionary
    data "okta_get_identity_source_groups" "name" {
        # arguments
    }

    The following arguments are supported:

    ExternalId string
    The external ID of the group in the identity source.
    IdentitySourceId string
    ID of the identity source.
    Id string
    Okta-assigned ID of the group (populated after read).
    Profile GetIdentitySourceGroupsProfile
    ExternalId string
    The external ID of the group in the identity source.
    IdentitySourceId string
    ID of the identity source.
    Id string
    Okta-assigned ID of the group (populated after read).
    Profile GetIdentitySourceGroupsProfile
    external_id string
    The external ID of the group in the identity source.
    identity_source_id string
    ID of the identity source.
    id string
    Okta-assigned ID of the group (populated after read).
    profile object
    externalId String
    The external ID of the group in the identity source.
    identitySourceId String
    ID of the identity source.
    id String
    Okta-assigned ID of the group (populated after read).
    profile GetIdentitySourceGroupsProfile
    externalId string
    The external ID of the group in the identity source.
    identitySourceId string
    ID of the identity source.
    id string
    Okta-assigned ID of the group (populated after read).
    profile GetIdentitySourceGroupsProfile
    external_id str
    The external ID of the group in the identity source.
    identity_source_id str
    ID of the identity source.
    id str
    Okta-assigned ID of the group (populated after read).
    profile GetIdentitySourceGroupsProfile
    externalId String
    The external ID of the group in the identity source.
    identitySourceId String
    ID of the identity source.
    id String
    Okta-assigned ID of the group (populated after read).
    profile Property Map

    getIdentitySourceGroups Result

    The following output properties are available:

    ExternalId string
    The external ID of the group in the identity source.
    Id string
    Okta-assigned ID of the group (populated after read).
    IdentitySourceId string
    ID of the identity source.
    Profile GetIdentitySourceGroupsProfile
    ExternalId string
    The external ID of the group in the identity source.
    Id string
    Okta-assigned ID of the group (populated after read).
    IdentitySourceId string
    ID of the identity source.
    Profile GetIdentitySourceGroupsProfile
    external_id string
    The external ID of the group in the identity source.
    id string
    Okta-assigned ID of the group (populated after read).
    identity_source_id string
    ID of the identity source.
    profile object
    externalId String
    The external ID of the group in the identity source.
    id String
    Okta-assigned ID of the group (populated after read).
    identitySourceId String
    ID of the identity source.
    profile GetIdentitySourceGroupsProfile
    externalId string
    The external ID of the group in the identity source.
    id string
    Okta-assigned ID of the group (populated after read).
    identitySourceId string
    ID of the identity source.
    profile GetIdentitySourceGroupsProfile
    external_id str
    The external ID of the group in the identity source.
    id str
    Okta-assigned ID of the group (populated after read).
    identity_source_id str
    ID of the identity source.
    profile GetIdentitySourceGroupsProfile
    externalId String
    The external ID of the group in the identity source.
    id String
    Okta-assigned ID of the group (populated after read).
    identitySourceId String
    ID of the identity source.
    profile Property Map

    Supporting Types

    GetIdentitySourceGroupsProfile

    Description string
    Description of the group.
    DisplayName string
    Display name of the group.
    Description string
    Description of the group.
    DisplayName string
    Display name of the group.
    description string
    Description of the group.
    display_name string
    Display name of the group.
    description String
    Description of the group.
    displayName String
    Display name of the group.
    description string
    Description of the group.
    displayName string
    Display name of the group.
    description str
    Description of the group.
    display_name str
    Display name of the group.
    description String
    Description of the group.
    displayName String
    Display name of the group.

    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