AWS singlesignon documentation change
Summary
Added examples section with sample request/response for GetUserId API operation and removed note about member account access
Security assessment
Adds usage examples but deletes security-related access control note. No evidence of vulnerability remediation.
Diff
diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_GetUserId.md b/singlesignon/latest/IdentityStoreAPIReference/API_GetUserId.md index 8722f4672..dbcb9a0d9 100644 --- a//singlesignon/latest/IdentityStoreAPIReference/API_GetUserId.md +++ b//singlesignon/latest/IdentityStoreAPIReference/API_GetUserId.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 -Retrieves the `UserId` in an identity store. - -###### 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_. - @@ -127,0 +122,28 @@ HTTP Status Code: 400 +## Examples + +### Example + +This example retrieves the user ID based on the user name. + +#### Sample Request + + + { + "IdentityStoreId": "d-1234567890", + "AlternateIdentifier": { + "UniqueAttribute": { + "AttributePath": "userName", + "AttributeValue": "johndoe" + } + } + } + + +#### Sample Response + + + { + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "IdentityStoreId": "d-1234567890" + } +