AWS singlesignon documentation change
Summary
Added examples for updating group metadata and attributes, including display name, description, and removing description. Removed a redundant introductory sentence.
Security assessment
The changes provide usage examples for the UpdateGroup API but do not address security vulnerabilities or introduce security-related documentation. The examples demonstrate standard functionality without security implications.
Diff
diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_UpdateGroup.md b/singlesignon/latest/IdentityStoreAPIReference/API_UpdateGroup.md index db606affb..ad7f77fa0 100644 --- a//singlesignon/latest/IdentityStoreAPIReference/API_UpdateGroup.md +++ b//singlesignon/latest/IdentityStoreAPIReference/API_UpdateGroup.md @@ -5 +5 @@ -Request SyntaxRequest ParametersResponse ElementsErrorsSee Also +Request SyntaxRequest ParametersResponse ElementsErrorsExamplesSee Also @@ -9,2 +8,0 @@ Request SyntaxRequest ParametersResponse ElementsErrorsSee Also -Updates the specified group metadata and attributes in the specified identity store. - @@ -131,0 +130,76 @@ HTTP Status Code: 400 +## Examples + +### Example 1 + +This example updates the display name of the specified group to "Engineers". + +#### Sample Request + + + { + "IdentityStoreId": "d-1234567890", + "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Operations": [ + { + "AttributePath": "displayName", + "AttributeValue": "Engineers" + } + ] + } + + +#### Sample Response + + + No response + + +### Example 2 + +This example updates the description of the specified group to "Contains all engineers". + +#### Sample Request + + + { + "IdentityStoreId": "d-1234567890", + "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Operations": [ + { + "AttributePath": "description", + "AttributeValue": "Contains all engineers" + } + ] + } + + +#### Sample Response + + + No response + + +### Example 3 + +This example removes the description from the specified group. + +#### Sample Request + + + { + "IdentityStoreId": "d-1234567890", + "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Operations": [ + { + "AttributePath": "description", + } + ] + } + + +#### Sample Response + + + No response + +