AWS SSO Identity Store
IAM Identity Center uses the sso , sso-directory , and identitystore API namespaces. The sso-directory and identitystore namespaces authorize access to data…
Identity & security#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
IAM Identity Center uses the sso , sso-directory , and identitystore API namespaces. The sso-directory and identitystore namespaces authorize access to data in the Identity Store. Make sure your policies with IAM actions from these two namespaces are consistent to avoid conflicting authorization to the same data. The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). You can use the identity store API operations in this guide to manage your identity data programmatically. The scope of these APIs allows you to create, read, update, delete, and list users, groups, and memberships. This guide also describes identity store operations that you can call and includes detailed information about data types and errors. If you use an external identity provider or Active Directory as your identity source, we recommend that you use the Create , Update , and Delete APIs with caution. Because IAM Identity Center doesn't support outbound synchronization, your identity source won't automatically update with the changes that you make to users or groups using these APIs. Amazon Web Services provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, and more). The SDKs provide a convenient way to programmatically access the identity store and other Amazon Web Services services. For more information about the Amazon Web Services SDKs, including how to download and install them, see Amazon Web Services Builder Center Toolbox .
Endpoints 22
Group
- POSTCreate group
/#X-Amz-Target=AWSIdentityStore.CreateGroupCreates a group within the specified identity store. - POSTDelete group
/#X-Amz-Target=AWSIdentityStore.DeleteGroupDelete a group within an identity store given GroupId . - POSTDescribe group
/#X-Amz-Target=AWSIdentityStore.DescribeGroupRetrieves 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… - POSTGet group id
/#X-Amz-Target=AWSIdentityStore.GetGroupIdRetrieves 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,… - POSTList groups
/#X-Amz-Target=AWSIdentityStore.ListGroupsLists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated.… - POSTUpdate group
/#X-Amz-Target=AWSIdentityStore.UpdateGroupUpdates the specified group metadata and attributes in the specified identity store.
Group membership
- POSTCreate group membership
/#X-Amz-Target=AWSIdentityStore.CreateGroupMembershipCreates a relationship between a member and a group. The following identifiers must be specified: GroupId , IdentityStoreId , and MemberId . - POSTDelete group membership
/#X-Amz-Target=AWSIdentityStore.DeleteGroupMembershipDelete a membership within a group given MembershipId . - POSTDescribe group membership
/#X-Amz-Target=AWSIdentityStore.DescribeGroupMembershipRetrieves membership metadata and attributes from MembershipId in an identity store. If you have access to a member account, you can use this API operation… - POSTGet group membership id
/#X-Amz-Target=AWSIdentityStore.GetGroupMembershipIdRetrieves the MembershipId in an identity store. If you have access to a member account, you can use this API operation from the member account. For more… - POSTIs member in groups
/#X-Amz-Target=AWSIdentityStore.IsMemberInGroupsChecks the user's membership in all requested groups and returns if the member exists in all queried groups. If you have access to a member account, you can… - POSTList group memberships
/#X-Amz-Target=AWSIdentityStore.ListGroupMembershipsFor the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form. If you have… - POSTList group memberships for member
/#X-Amz-Target=AWSIdentityStore.ListGroupMembershipsForMemberFor the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form. If you have…
User
- POSTCreate user
/#X-Amz-Target=AWSIdentityStore.CreateUserCreates a user within the specified identity store. - POSTDelete user
/#X-Amz-Target=AWSIdentityStore.DeleteUserDeletes a user within an identity store given UserId . - POSTDescribe user
/#X-Amz-Target=AWSIdentityStore.DescribeUserRetrieves the user metadata and attributes from the UserId in an identity store. If you have access to a member account, you can use this API operation from… - POSTGet user id
/#X-Amz-Target=AWSIdentityStore.GetUserIdRetrieves the UserId in an identity store. If you have access to a member account, you can use this API operation from the member account. For more… - POSTList users
/#X-Amz-Target=AWSIdentityStore.ListUsersLists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated.… - POSTUpdate user
/#X-Amz-Target=AWSIdentityStore.UpdateUserUpdates the specified user metadata and attributes in the specified identity store.
Identity store
- POSTDescribe identity store
/#X-Amz-Target=AWSIdentityStore.DescribeIdentityStoreRetrieves details about the specified identity store, including its Amazon Resource Name (ARN) and network configuration. - POSTList identity stores
/#X-Amz-Target=AWSIdentityStore.ListIdentityStoresLists the identity stores that you have access to. This operation returns only the identity store ID and Amazon Resource Name (ARN) of each identity store. To… - POSTUpdate identity store
/#X-Amz-Target=AWSIdentityStore.UpdateIdentityStoreUpdates the configuration of the specified identity store, including its network configuration.
API details
- Base URL
https://identitystore.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 22 operations on 22 pathsPOST 22
- Main resources
- Group membership 7Group 6User 6Identity store 3
- Description format
- AWS Smithy model, API version
2020-06-15 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS SSO Identity Store in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS SSO Identity Store collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create group” (POST /#X-Amz-Target=AWSIdentityStore.CreateGroup), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS SSO Identity Store?
IAM Identity Center uses the sso , sso-directory , and identitystore API namespaces. The sso-directory and identitystore namespaces authorize access to data… It is listed under Identity & security and has 22 endpoints.
Who publishes the AWS SSO Identity Store?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS SSO Identity Store?
Requests go to https://identitystore.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS SSO Identity Store?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS SSO Identity Store have?
22 operations on 22 paths (22 POST). The largest groups are Group membership, Group, User, Identity store.
Is forking the AWS SSO Identity Store free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.