AWS singlesignon documentation change
Summary
Added examples section with sample request/response for ListUsers API, removed introductory note about member account access
Security assessment
Change focuses on adding usage examples while removing security context about access limitations. No indication of security vulnerability fixes or new security features.
Diff
diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.md b/singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.md index 6027fd601..3ae89b184 100644 --- a//singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.md +++ b//singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.md @@ -5 +5 @@ -Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also +Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsExamplesSee Also @@ -9,6 +8,0 @@ Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also -Lists all users in the identity store. Returns a paginated list of complete `User` objects. Filtering for a `User` by the `UserName` attribute is deprecated. Instead, use the `GetUserId` API action. - -###### Note - -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](https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts) in the _AWS IAM Identity Center User Guide_. - @@ -210,0 +205,41 @@ HTTP Status Code: 400 +## Examples + +### Example + +This example lists the users in the specified identity store. + +#### Sample Request + + + { + "IdentityStoreId": "d-1234567890", + "MaxResults": 100, + "NextToken": "" + } + + +#### Sample Response + + + { + "Users": [ + { + "UserName": "john_doe", + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Name": { + "FamilyName": "Doe", + "GivenName": "John" + } + }, + { + "UserName": "mary_major", + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE222222", + "Name": { + "FamilyName": "Major", + "GivenName": "Mary" + } + } + ], + "NextToken": "EXAMPLE-TOKEN" + } +