AWS singlesignon documentation change
Summary
Added examples section for group description request/response
Security assessment
The added examples demonstrate normal API usage patterns. No security-related content or vulnerability mitigation is present in the changes.
Diff
diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_DescribeGroup.md b/singlesignon/latest/IdentityStoreAPIReference/API_DescribeGroup.md index 68e8278e5..ddc6f58a0 100644 --- a//singlesignon/latest/IdentityStoreAPIReference/API_DescribeGroup.md +++ b//singlesignon/latest/IdentityStoreAPIReference/API_DescribeGroup.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 group metadata and attributes from `GroupId` 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_. - @@ -168,0 +163,25 @@ HTTP Status Code: 400 +## Examples + +### Example + +This example retrieves the group name and description for a group called Developers. + +#### Sample Request + + + { + "IdentityStoreId": "d-1234567890", + "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222" + } + + +#### Sample Response + + + { + "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "DisplayName": "Developers", + "Description": "Group that contains all developers", + "IdentityStoreId": "d-1234567890" + } +