Describe Group

identitystore_describe_group

R Documentation

Retrieves the group metadata and attributes from GroupId in an identity store¶

Description¶

Retrieves the group metadata and attributes from 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_describe_group(IdentityStoreId, GroupId)

Arguments¶

IdentityStoreId

[required] The globally unique identifier for the identity store, such as d-1234567890. In this example, ⁠d-⁠ is a fixed prefix, and 1234567890 is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.

GroupId

[required] The identifier for a group in the identity store.

Value¶

A list with the following syntax:

list(
  GroupId = "string",
  DisplayName = "string",
  ExternalIds = list(
    list(
      Issuer = "string",
      Id = "string"
    )
  ),
  Description = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  CreatedBy = "string",
  UpdatedBy = "string",
  IdentityStoreId = "string"
)

Request syntax¶

svc$describe_group(
  IdentityStoreId = "string",
  GroupId = "string"
)