AWS singlesignon documentation change
Summary
Added 'Extensions' parameter to retrieve enterprise attributes. Added new example showing enterprise extension usage.
Security assessment
Change adds support for retrieving enterprise attributes but doesn't address security vulnerabilities or document security features. Manager ID in example is standard attribute.
Diff
diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.md b/singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.md index ce58d60b4..c46a4ccae 100644 --- a//singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.md +++ b//singlesignon/latest/IdentityStoreAPIReference/API_ListUsers.md @@ -18,0 +19 @@ If you have access to a member account, you can use this API operation from the + "Extensions": [ "string" ], @@ -35,0 +37,15 @@ The request accepts the following data in JSON format. +**Extensions ** + + +A collection of extension names indicating what extensions the service should retrieve alongside other user attributes. `aws:identitystore:enterprise` is the only supported extension name. + +Type: Array of strings + +Array Members: Minimum number of 1 item. Maximum number of 10 items. + +Length Constraints: Minimum length of 1. Maximum length of 50. + +Pattern: `aws:identitystore:[a-z]{1,20}` + +Required: No + @@ -115,0 +132,3 @@ Required: No + "[Extensions](./API_User.html#singlesignon-Type-User-Extensions)": { + "**_string_** " : **_JSON value_** + }, @@ -293 +312 @@ HTTP Status Code: 400 -### Example +### Example 1 @@ -331,0 +351,52 @@ This example lists the users in the specified identity store. +### Example 2 + +This example lists users with extensions in the specified identity store. + +#### Sample Request + + + { + "IdentityStoreId": "d-1234567890", + "Extensions": ["aws:identitystore:enterprise"] + "MaxResults": 100, + "NextToken": "" + } + + +#### Sample Response + + + { + "Users": [ + { + "UserName": "john_doe", + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "Name": { + "FamilyName": "Doe", + "GivenName": "John" + }, + "Extensions": { + "aws:identitystore:enterprise": { + "employeeNumber": "701984", + "costCenter": "4130", + "organization": "Universal Studios", + "division": "Theme Park", + "department": "Tour Operations", + "manager": { + "value": "a1b2c3d4-5678-90ab-cdef-EXAMPLE44444" + } + } + } + }, + { + "UserName": "mary_major", + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE222222", + "Name": { + "FamilyName": "Major", + "GivenName": "Mary" + } + } + ], + "NextToken": "EXAMPLE-TOKEN" + } +