Data retrieval APIs for AWS IAM Identity Center directory - AWS Online Register of Data Formats

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
DescribeDirectoryRetrieve information about the directory that AWS IAM Identity Center provides by defaultRead
DescribeGroupQuery the group data, not including user and group membersRead
DescribeGroupsRetrieve information about groups from the directory that AWS IAM Identity Center provides by defaultRead
DescribeProvisioningTenantDescribes the provisioning tenantRead
DescribeUserRetrieve information about a user from the directory that AWS IAM Identity Center provides by defaultRead
DescribeUserByUniqueAttributeDescribe user with a valid unique attribute represented for the userRead
DescribeUsersRetrieve information about user from the directory that AWS IAM Identity Center provides by defaultRead
GetAWSSPConfigurationForDirectoryRetrieve the AWS IAM Identity Center Service Provider configurations for the directoryRead
GetGroupIdRetrieve ID information about group from the directory that AWS IAM Identity Center provides by defaultRead
GetUserIdRetrieve ID information about user from the directory that AWS IAM Identity Center provides by defaultRead
GetUserPoolInfo(Deprecated) Grants permission to get UserPool InfoRead
IsMemberInGroupCheck if a member is a part of the group in the directory that AWS IAM Identity Center provides by defaultRead
IsMemberInGroupsCheck if a member is a part of multiple groups in the directory that AWS IAM Identity Center provides by defaultRead
ListBearerTokensList bearer tokens for a given provisioning tenantRead
ListExternalIdPCertificatesList the external IdP certificates of a given directory and IdPRead
ListExternalIdPConfigurationsForDirectoryList all the External Identity Provider configurations created for the directoryRead
ListGroupsList groups from the directory that AWS IAM Identity Center provides by defaultRead
ListGroupsForMemberList groups of the target memberRead
ListGroupsForUserList groups for a user from the directory that AWS IAM Identity Center provides by defaultRead
ListMembersInGroupRetrieve all members that are part of a group in the directory that AWS IAM Identity Center provides by defaultRead
ListMfaDevicesForUserList all active MFA devices and their MFA device metadata for a userRead
ListProvisioningTenantsList provisioning tenants for a given directoryRead
ListUsersList users from the directory that AWS IAM Identity Center provides by defaultRead
SearchGroupsSearch for groups within the associated directoryRead
SearchUsersSearch for users within the associated directoryRead