Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Okta Provider
  4. API Docs
  5. IdentitySourceGroup
Viewing docs for Okta v6.9.0
published on Wednesday, Jul 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

okta.IdentitySourceGroup

okta logo
Viewing docs for Okta v6.9.0
published on Wednesday, Jul 1, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-okta

    Manages a group within an Okta Identity Source. Groups created here are staged for import via a session; use okta.IdentitySourceImport to trigger the actual sync into Okta.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.IdentitySourceGroup("example", {
    identitySourceId: "<identity-source-id>",
    externalId: "GRPEXT123456EXAMPLE",
    profile: {
        displayName: "Engineering",
        description: "Engineering team group",
    },
});

    import pulumi
import pulumi_okta as okta

example = okta.IdentitySourceGroup("example",
    identity_source_id="<identity-source-id>",
    external_id="GRPEXT123456EXAMPLE",
    profile={
        "display_name": "Engineering",
        "description": "Engineering team group",
    })

    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.NewIdentitySourceGroup(ctx, "example", &okta.IdentitySourceGroupArgs{
			IdentitySourceId: pulumi.String("<identity-source-id>"),
			ExternalId:       pulumi.String("GRPEXT123456EXAMPLE"),
			Profile: &okta.IdentitySourceGroupProfileArgs{
				DisplayName: pulumi.String("Engineering"),
				Description: pulumi.String("Engineering team group"),
			},
		})
		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.IdentitySourceGroup("example", new()
    {
        IdentitySourceId = "<identity-source-id>",
        ExternalId = "GRPEXT123456EXAMPLE",
        Profile = new Okta.Inputs.IdentitySourceGroupProfileArgs
        {
            DisplayName = "Engineering",
            Description = "Engineering team group",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.IdentitySourceGroup;
import com.pulumi.okta.IdentitySourceGroupArgs;
import com.pulumi.okta.inputs.IdentitySourceGroupProfileArgs;
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 IdentitySourceGroup("example", IdentitySourceGroupArgs.builder()
            .identitySourceId("<identity-source-id>")
            .externalId("GRPEXT123456EXAMPLE")
            .profile(IdentitySourceGroupProfileArgs.builder()
                .displayName("Engineering")
                .description("Engineering team group")
                .build())
            .build());

    }
}

    resources:
  example:
    type: okta:IdentitySourceGroup
    properties:
      identitySourceId: <identity-source-id>
      externalId: GRPEXT123456EXAMPLE
      profile:
        displayName: Engineering
        description: Engineering team group

    pulumi {
  required_providers {
    okta = {
      source = "pulumi/okta"
    }
  }
}

resource "okta_identitysourcegroup" "example" {
  identity_source_id = "<identity-source-id>"
  external_id        = "GRPEXT123456EXAMPLE"
  profile = {
    display_name = "Engineering"
    description  = "Engineering team group"
  }
}

    Create IdentitySourceGroup Resource

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

    Constructor syntax

    new IdentitySourceGroup(name: string, args: IdentitySourceGroupArgs, opts?: CustomResourceOptions);
    @overload
def IdentitySourceGroup(resource_name: str,
                        args: IdentitySourceGroupArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def IdentitySourceGroup(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        external_id: Optional[str] = None,
                        identity_source_id: Optional[str] = None,
                        profile: Optional[IdentitySourceGroupProfileArgs] = None)
    func NewIdentitySourceGroup(ctx *Context, name string, args IdentitySourceGroupArgs, opts ...ResourceOption) (*IdentitySourceGroup, error)
    public IdentitySourceGroup(string name, IdentitySourceGroupArgs args, CustomResourceOptions? opts = null)
    public IdentitySourceGroup(String name, IdentitySourceGroupArgs args)
public IdentitySourceGroup(String name, IdentitySourceGroupArgs args, CustomResourceOptions options)

    type: okta:IdentitySourceGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "okta_identity_source_group" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IdentitySourceGroupArgs
    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 IdentitySourceGroupArgs
    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 IdentitySourceGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentitySourceGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentitySourceGroupArgs
    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 identitySourceGroupResource = new Okta.IdentitySourceGroup("identitySourceGroupResource", new()
{
    ExternalId = "string",
    IdentitySourceId = "string",
    Profile = new Okta.Inputs.IdentitySourceGroupProfileArgs
    {
        Description = "string",
        DisplayName = "string",
    },
});

    example, err := okta.NewIdentitySourceGroup(ctx, "identitySourceGroupResource", &okta.IdentitySourceGroupArgs{
	ExternalId:       pulumi.String("string"),
	IdentitySourceId: pulumi.String("string"),
	Profile: &okta.IdentitySourceGroupProfileArgs{
		Description: pulumi.String("string"),
		DisplayName: pulumi.String("string"),
	},
})

    resource "okta_identity_source_group" "identitySourceGroupResource" {
  lifecycle {
    create_before_destroy = true
  }
  external_id        = "string"
  identity_source_id = "string"
  profile = {
    description  = "string"
    display_name = "string"
  }
}

    var identitySourceGroupResource = new IdentitySourceGroup("identitySourceGroupResource", IdentitySourceGroupArgs.builder()
    .externalId("string")
    .identitySourceId("string")
    .profile(IdentitySourceGroupProfileArgs.builder()
        .description("string")
        .displayName("string")
        .build())
    .build());

    identity_source_group_resource = okta.IdentitySourceGroup("identitySourceGroupResource",
    external_id="string",
    identity_source_id="string",
    profile={
        "description": "string",
        "display_name": "string",
    })

    const identitySourceGroupResource = new okta.IdentitySourceGroup("identitySourceGroupResource", {
    externalId: "string",
    identitySourceId: "string",
    profile: {
        description: "string",
        displayName: "string",
    },
});

    type: okta:IdentitySourceGroup
properties:
    externalId: string
    identitySourceId: string
    profile:
        description: string
        displayName: string

    IdentitySourceGroup 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 IdentitySourceGroup resource accepts the following input properties:

    ExternalId string
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    Profile IdentitySourceGroupProfile
    Display attributes for the group.
    ExternalId string
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    Profile IdentitySourceGroupProfileArgs
    Display attributes for the group.
    external_id string
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identity_source_id string
    ID of the identity source. Forces replacement when changed.
    profile object
    Display attributes for the group.
    externalId String
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    profile IdentitySourceGroupProfile
    Display attributes for the group.
    externalId string
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identitySourceId string
    ID of the identity source. Forces replacement when changed.
    profile IdentitySourceGroupProfile
    Display attributes for the group.
    external_id str
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identity_source_id str
    ID of the identity source. Forces replacement when changed.
    profile IdentitySourceGroupProfileArgs
    Display attributes for the group.
    externalId String
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    profile Property Map
    Display attributes for the group.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing IdentitySourceGroup Resource

    Get an existing IdentitySourceGroup 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?: IdentitySourceGroupState, opts?: CustomResourceOptions): IdentitySourceGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        external_id: Optional[str] = None,
        identity_source_id: Optional[str] = None,
        profile: Optional[IdentitySourceGroupProfileArgs] = None) -> IdentitySourceGroup
    func GetIdentitySourceGroup(ctx *Context, name string, id IDInput, state *IdentitySourceGroupState, opts ...ResourceOption) (*IdentitySourceGroup, error)
    public static IdentitySourceGroup Get(string name, Input<string> id, IdentitySourceGroupState? state, CustomResourceOptions? opts = null)
    public static IdentitySourceGroup get(String name, Output<String> id, IdentitySourceGroupState state, CustomResourceOptions options)
    resources:  _:    type: okta:IdentitySourceGroup    get:      id: ${id}
    import {
  to = okta_identity_source_group.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:
    ExternalId string
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    Profile IdentitySourceGroupProfile
    Display attributes for the group.
    ExternalId string
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    Profile IdentitySourceGroupProfileArgs
    Display attributes for the group.
    external_id string
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identity_source_id string
    ID of the identity source. Forces replacement when changed.
    profile object
    Display attributes for the group.
    externalId String
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    profile IdentitySourceGroupProfile
    Display attributes for the group.
    externalId string
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identitySourceId string
    ID of the identity source. Forces replacement when changed.
    profile IdentitySourceGroupProfile
    Display attributes for the group.
    external_id str
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identity_source_id str
    ID of the identity source. Forces replacement when changed.
    profile IdentitySourceGroupProfileArgs
    Display attributes for the group.
    externalId String
    The external ID of the group in the upstream identity provider. Acts as the natural key for this resource. Forces replacement when changed.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    profile Property Map
    Display attributes for the group.

    Supporting Types

    IdentitySourceGroupProfile, IdentitySourceGroupProfileArgs

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

    Import

    Import using {identity_source_id}/{id}:

    $ pulumi import okta:index/identitySourceGroup:IdentitySourceGroup example <identity-source-id>/<group-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
    Schema (JSON)
    pulumi/pulumi-okta

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial