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

okta.IdentitySourceGroupMembership

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

    Manages a single member association between a user and a group in an Okta Identity Source. Each resource instance adds one user (identified by memberExternalId) to the specified identity source group. All three key attributes force resource replacement when changed.

    Example Usage

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

const example = new okta.IdentitySourceGroupMembership("example", {
    identitySourceId: "<identity-source-id>",
    groupOrExternalId: "GRPEXT123456EXAMPLE",
    memberExternalId: "USEREXT123456EXAMPLE",
});

    import pulumi
import pulumi_okta as okta

example = okta.IdentitySourceGroupMembership("example",
    identity_source_id="<identity-source-id>",
    group_or_external_id="GRPEXT123456EXAMPLE",
    member_external_id="USEREXT123456EXAMPLE")

    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.NewIdentitySourceGroupMembership(ctx, "example", &okta.IdentitySourceGroupMembershipArgs{
			IdentitySourceId:  pulumi.String("<identity-source-id>"),
			GroupOrExternalId: pulumi.String("GRPEXT123456EXAMPLE"),
			MemberExternalId:  pulumi.String("USEREXT123456EXAMPLE"),
		})
		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.IdentitySourceGroupMembership("example", new()
    {
        IdentitySourceId = "<identity-source-id>",
        GroupOrExternalId = "GRPEXT123456EXAMPLE",
        MemberExternalId = "USEREXT123456EXAMPLE",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.IdentitySourceGroupMembership;
import com.pulumi.okta.IdentitySourceGroupMembershipArgs;
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 IdentitySourceGroupMembership("example", IdentitySourceGroupMembershipArgs.builder()
            .identitySourceId("<identity-source-id>")
            .groupOrExternalId("GRPEXT123456EXAMPLE")
            .memberExternalId("USEREXT123456EXAMPLE")
            .build());

    }
}

    resources:
  example:
    type: okta:IdentitySourceGroupMembership
    properties:
      identitySourceId: <identity-source-id>
      groupOrExternalId: GRPEXT123456EXAMPLE
      memberExternalId: USEREXT123456EXAMPLE

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

resource "okta_identitysourcegroupmembership" "example" {
  identity_source_id   = "<identity-source-id>"
  group_or_external_id = "GRPEXT123456EXAMPLE"
  member_external_id   = "USEREXT123456EXAMPLE"
}

    Create IdentitySourceGroupMembership Resource

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

    Constructor syntax

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

@overload
def IdentitySourceGroupMembership(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  group_or_external_id: Optional[str] = None,
                                  identity_source_id: Optional[str] = None,
                                  member_external_id: Optional[str] = None)
    func NewIdentitySourceGroupMembership(ctx *Context, name string, args IdentitySourceGroupMembershipArgs, opts ...ResourceOption) (*IdentitySourceGroupMembership, error)
    public IdentitySourceGroupMembership(string name, IdentitySourceGroupMembershipArgs args, CustomResourceOptions? opts = null)
    public IdentitySourceGroupMembership(String name, IdentitySourceGroupMembershipArgs args)
public IdentitySourceGroupMembership(String name, IdentitySourceGroupMembershipArgs args, CustomResourceOptions options)

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


    resource "okta_identitysourcegroupmembership" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args IdentitySourceGroupMembershipArgs
    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 IdentitySourceGroupMembershipArgs
    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 IdentitySourceGroupMembershipArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentitySourceGroupMembershipArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentitySourceGroupMembershipArgs
    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 identitySourceGroupMembershipResource = new Okta.IdentitySourceGroupMembership("identitySourceGroupMembershipResource", new()
{
    GroupOrExternalId = "string",
    IdentitySourceId = "string",
    MemberExternalId = "string",
});

    example, err := okta.NewIdentitySourceGroupMembership(ctx, "identitySourceGroupMembershipResource", &okta.IdentitySourceGroupMembershipArgs{
	GroupOrExternalId: pulumi.String("string"),
	IdentitySourceId:  pulumi.String("string"),
	MemberExternalId:  pulumi.String("string"),
})

    resource "okta_identitysourcegroupmembership" "identitySourceGroupMembershipResource" {
  group_or_external_id = "string"
  identity_source_id   = "string"
  member_external_id   = "string"
}

    var identitySourceGroupMembershipResource = new IdentitySourceGroupMembership("identitySourceGroupMembershipResource", IdentitySourceGroupMembershipArgs.builder()
    .groupOrExternalId("string")
    .identitySourceId("string")
    .memberExternalId("string")
    .build());

    identity_source_group_membership_resource = okta.IdentitySourceGroupMembership("identitySourceGroupMembershipResource",
    group_or_external_id="string",
    identity_source_id="string",
    member_external_id="string")

    const identitySourceGroupMembershipResource = new okta.IdentitySourceGroupMembership("identitySourceGroupMembershipResource", {
    groupOrExternalId: "string",
    identitySourceId: "string",
    memberExternalId: "string",
});

    type: okta:IdentitySourceGroupMembership
properties:
    groupOrExternalId: string
    identitySourceId: string
    memberExternalId: string

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

    GroupOrExternalId string
    External ID of the identity source group. Forces replacement when changed.
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    MemberExternalId string
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    GroupOrExternalId string
    External ID of the identity source group. Forces replacement when changed.
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    MemberExternalId string
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    group_or_external_id string
    External ID of the identity source group. Forces replacement when changed.
    identity_source_id string
    ID of the identity source. Forces replacement when changed.
    member_external_id string
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    groupOrExternalId String
    External ID of the identity source group. Forces replacement when changed.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    memberExternalId String
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    groupOrExternalId string
    External ID of the identity source group. Forces replacement when changed.
    identitySourceId string
    ID of the identity source. Forces replacement when changed.
    memberExternalId string
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    group_or_external_id str
    External ID of the identity source group. Forces replacement when changed.
    identity_source_id str
    ID of the identity source. Forces replacement when changed.
    member_external_id str
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    groupOrExternalId String
    External ID of the identity source group. Forces replacement when changed.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    memberExternalId String
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MemberExternalIds List<string>
    A list of all member external IDs currently in the group (populated after creation).
    Id string
    The provider-assigned unique ID for this managed resource.
    MemberExternalIds []string
    A list of all member external IDs currently in the group (populated after creation).
    id string
    The provider-assigned unique ID for this managed resource.
    member_external_ids list(string)
    A list of all member external IDs currently in the group (populated after creation).
    id String
    The provider-assigned unique ID for this managed resource.
    memberExternalIds List<String>
    A list of all member external IDs currently in the group (populated after creation).
    id string
    The provider-assigned unique ID for this managed resource.
    memberExternalIds string[]
    A list of all member external IDs currently in the group (populated after creation).
    id str
    The provider-assigned unique ID for this managed resource.
    member_external_ids Sequence[str]
    A list of all member external IDs currently in the group (populated after creation).
    id String
    The provider-assigned unique ID for this managed resource.
    memberExternalIds List<String>
    A list of all member external IDs currently in the group (populated after creation).

    Look up Existing IdentitySourceGroupMembership Resource

    Get an existing IdentitySourceGroupMembership 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?: IdentitySourceGroupMembershipState, opts?: CustomResourceOptions): IdentitySourceGroupMembership
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        group_or_external_id: Optional[str] = None,
        identity_source_id: Optional[str] = None,
        member_external_id: Optional[str] = None,
        member_external_ids: Optional[Sequence[str]] = None) -> IdentitySourceGroupMembership
    func GetIdentitySourceGroupMembership(ctx *Context, name string, id IDInput, state *IdentitySourceGroupMembershipState, opts ...ResourceOption) (*IdentitySourceGroupMembership, error)
    public static IdentitySourceGroupMembership Get(string name, Input<string> id, IdentitySourceGroupMembershipState? state, CustomResourceOptions? opts = null)
    public static IdentitySourceGroupMembership get(String name, Output<String> id, IdentitySourceGroupMembershipState state, CustomResourceOptions options)
    resources:  _:    type: okta:IdentitySourceGroupMembership    get:      id: ${id}
    import {
  to = okta_identitysourcegroupmembership.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:
    GroupOrExternalId string
    External ID of the identity source group. Forces replacement when changed.
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    MemberExternalId string
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    MemberExternalIds List<string>
    A list of all member external IDs currently in the group (populated after creation).
    GroupOrExternalId string
    External ID of the identity source group. Forces replacement when changed.
    IdentitySourceId string
    ID of the identity source. Forces replacement when changed.
    MemberExternalId string
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    MemberExternalIds []string
    A list of all member external IDs currently in the group (populated after creation).
    group_or_external_id string
    External ID of the identity source group. Forces replacement when changed.
    identity_source_id string
    ID of the identity source. Forces replacement when changed.
    member_external_id string
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    member_external_ids list(string)
    A list of all member external IDs currently in the group (populated after creation).
    groupOrExternalId String
    External ID of the identity source group. Forces replacement when changed.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    memberExternalId String
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    memberExternalIds List<String>
    A list of all member external IDs currently in the group (populated after creation).
    groupOrExternalId string
    External ID of the identity source group. Forces replacement when changed.
    identitySourceId string
    ID of the identity source. Forces replacement when changed.
    memberExternalId string
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    memberExternalIds string[]
    A list of all member external IDs currently in the group (populated after creation).
    group_or_external_id str
    External ID of the identity source group. Forces replacement when changed.
    identity_source_id str
    ID of the identity source. Forces replacement when changed.
    member_external_id str
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    member_external_ids Sequence[str]
    A list of all member external IDs currently in the group (populated after creation).
    groupOrExternalId String
    External ID of the identity source group. Forces replacement when changed.
    identitySourceId String
    ID of the identity source. Forces replacement when changed.
    memberExternalId String
    The external ID of the user to be added as a member of the group in Okta. Forces replacement when changed.
    memberExternalIds List<String>
    A list of all member external IDs currently in the group (populated after creation).

    Import

    Import using {identity_source_id}/{group_or_external_id}/{id}:

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

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial