AWS singlesignon documentation change
Summary
Added examples section for group membership description request/response
Security assessment
The change adds usage examples for membership retrieval API. There is no evidence of security vulnerability fixes or security feature documentation in the added content.
Diff
diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_DescribeGroupMembership.md b/singlesignon/latest/IdentityStoreAPIReference/API_DescribeGroupMembership.md index 6c1221654..bc31a142f 100644 --- a//singlesignon/latest/IdentityStoreAPIReference/API_DescribeGroupMembership.md +++ b//singlesignon/latest/IdentityStoreAPIReference/API_DescribeGroupMembership.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 membership metadata and attributes from `MembershipId` 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_. - @@ -151,0 +146,27 @@ HTTP Status Code: 400 +## Examples + +### Example + +This example retrieves the member ID for the user and group ID for the group for the specified membership. + +#### Sample Request + + + { + "IdentityStoreId": "d-1234567890", + "MembershipId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" + } + + +#### Sample Response + + + { + "IdentityStoreId": "d-1234567890", + "MembershipId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE33333", + "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "MemberId": { + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" + } + } +