Get Group Id

identitystore_get_group_id

R Documentation

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.
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(
  GroupId = "string",
  IdentityStoreId = "string"
)

Request syntax

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