Skip to content

Retrieves GroupId in an identity store

Description

Retrieves GroupId in an identity store.

If you have access to a member account, you can use this API operation from the member account. For more information, see Limiting access to the identity store from member accounts in the IAM Identity Center User Guide.

Usage

identitystore_get_group_id(IdentityStoreId, AlternateIdentifier)

Arguments

  • IdentityStoreId

    [required] The globally unique identifier for the identity store.

    You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID d-1234567890 or identity store ARN arn:aws:identitystore::111122223333:identitystore/d-1234567890.

  • AlternateIdentifier

    [required] A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is displayName.

Value

A list with the following syntax:

list(
  IdentityStoreId = "string",
  GroupId = "string",
  GroupArn = "string"
)

Request syntax

svc$get_group_id(
  IdentityStoreId = "string",
  AlternateIdentifier = list(
    ExternalId = list(
      Issuer = "string",
      Id = "string"
    ),
    UniqueAttribute = list(
      AttributePath = "string",
      AttributeValue = list()
    )
  )
)