Data retrieval APIs for AWS IAM Identity Center directory
AWS IAM Identity Center directory provides the following APIs for data retrieval.
Actions | Description | Access level |
---|---|---|
DescribeDirectory | Retrieve information about the directory that AWS IAM Identity Center provides by default | Read |
DescribeGroup | Query the group data, not including user and group members | Read |
DescribeGroups | Retrieve information about groups from the directory that AWS IAM Identity Center provides by default | Read |
DescribeProvisioningTenant | Describes the provisioning tenant | Read |
DescribeUser | Retrieve information about a user from the directory that AWS IAM Identity Center provides by default | Read |
DescribeUserByUniqueAttribute | Describe user with a valid unique attribute represented for the user | Read |
DescribeUsers | Retrieve information about user from the directory that AWS IAM Identity Center provides by default | Read |
GetAWSSPConfigurationForDirectory | Retrieve the AWS IAM Identity Center Service Provider configurations for the directory | Read |
GetGroupId | Retrieve ID information about group from the directory that AWS IAM Identity Center provides by default | Read |
GetUserId | Retrieve ID information about user from the directory that AWS IAM Identity Center provides by default | Read |
GetUserPoolInfo | (Deprecated) Grants permission to get UserPool Info | Read |
IsMemberInGroup | Check if a member is a part of the group in the directory that AWS IAM Identity Center provides by default | Read |
IsMemberInGroups | Check if a member is a part of multiple groups in the directory that AWS IAM Identity Center provides by default | Read |
ListBearerTokens | List bearer tokens for a given provisioning tenant | Read |
ListExternalIdPCertificates | List the external IdP certificates of a given directory and IdP | Read |
ListExternalIdPConfigurationsForDirectory | List all the External Identity Provider configurations created for the directory | Read |
ListGroups | List groups from the directory that AWS IAM Identity Center provides by default | Read |
ListGroupsForMember | List groups of the target member | Read |
ListGroupsForUser | List groups for a user from the directory that AWS IAM Identity Center provides by default | Read |
ListMembersInGroup | Retrieve all members that are part of a group in the directory that AWS IAM Identity Center provides by default | Read |
ListMfaDevicesForUser | List all active MFA devices and their MFA device metadata for a user | Read |
ListProvisioningTenants | List provisioning tenants for a given directory | Read |
ListUsers | List users from the directory that AWS IAM Identity Center provides by default | Read |
SearchGroups | Search for groups within the associated directory | Read |
SearchUsers | Search for users within the associated directory | Read |