AWS singlesignon: Document Revision optimistic locking and ARN support for UpdateGroup
Summary
Adds a Revision parameter for optimistic concurrency control (fails with ConflictException on mismatch), documents ARN-based identifiers, expands length/pattern constraints, adds response syntax/elements, and updates error and example content.
Security assessment
The Revision field is an optimistic-locking/data-integrity control to prevent lost updates from concurrent modifications, not a fix for a specific vulnerability; ARN and pattern changes are identifier-format documentation. No auth, encryption, or credential handling is involved.
Evidence
The expected current revision of the group. When you provide this value, the update is applied only if it matches the current revision of the group in the identity store, which prevents you from overwriting concurrent changes.
Diff
diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_UpdateGroup.md b/singlesignon/latest/IdentityStoreAPIReference/API_UpdateGroup.md index f56b49c..7f96ac2 100644 --- a//singlesignon/latest/IdentityStoreAPIReference/API_UpdateGroup.md +++ b//singlesignon/latest/IdentityStoreAPIReference/API_UpdateGroup.md @@ -7 +7 @@ -Request SyntaxRequest ParametersResponse ElementsErrorsExamplesSee Also +Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsExamplesSee Also @@ -24 +24,2 @@ Updates the specified group metadata and attributes in the specified identity st - ] + ], + "Revision": "string" @@ -37,0 +39,2 @@ The identifier for a group in the identity store. +You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE22222` or group ARN `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`. + @@ -40 +43 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 47. +Length Constraints: Minimum length of 1. Maximum length of 100. @@ -42 +45 @@ Length Constraints: Minimum length of 1. Maximum length of 47. -Pattern: `([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` +Pattern: `(arn:aws[a-z-]*:identitystore:::(user|group|membership)/)?([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` @@ -50,0 +54,2 @@ The globally unique identifier for the identity store. +You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID `d-1234567890` or identity store ARN `arn:aws:identitystore::111122223333:identitystore/d-1234567890`. + @@ -53 +58 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 36. +Length Constraints: Minimum length of 1. Maximum length of 93. @@ -55 +60 @@ Length Constraints: Minimum length of 1. Maximum length of 36. -Pattern: `d-[0-9a-f]{10}$|^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}` +Pattern: `(arn:aws[a-z-]*:identitystore::\d{12}:identitystore/)?(d-[0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})` @@ -69,0 +75,23 @@ Required: Yes +**Revision ** + + +The expected current revision of the group. When you provide this value, the update is applied only if it matches the current revision of the group in the identity store, which prevents you from overwriting concurrent changes. If the value doesn't match, the operation fails with a `ConflictException`. If you don't provide this value, the update is applied unconditionally. + +Type: String + +Length Constraints: Minimum length of 1. Maximum length of 64. + +Pattern: `[0-9]+` + +Required: No + +## Response Syntax + + + { + "GroupArn": "**_string_** ", + "GroupId": "**_string_** ", + "IdentityStoreId": "**_string_** ", + "Revision": "**_string_** " + } + @@ -72 +100,47 @@ Required: Yes -If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. +If the action is successful, the service sends back an HTTP 200 response. + +The following data is returned in JSON format by the service. + +**GroupArn ** + + +The Amazon Resource Name (ARN) of the group in the identity store. For example, `arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222`. + +Type: String + +Length Constraints: Minimum length of 60. Maximum length of 100. + +Pattern: `arn:aws[a-z-]*:identitystore:::(user|group|membership)/([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` + +**GroupId ** + + +The identifier for a group in the identity store. + +Type: String + +Length Constraints: Minimum length of 1. Maximum length of 100. + +Pattern: `(arn:aws[a-z-]*:identitystore:::(user|group|membership)/)?([0-9a-f]{10}-|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}` + +**IdentityStoreId ** + + +The globally unique identifier for the identity store. + +Type: String + +Length Constraints: Minimum length of 1. Maximum length of 93. + +Pattern: `(arn:aws[a-z-]*:identitystore::\d{12}:identitystore/)?(d-[0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})` + +**Revision ** + + +The revision of the group after the requested update is applied. + +Type: String + +Length Constraints: Minimum length of 1. Maximum length of 64. + +Pattern: `[0-9]+` @@ -110 +184 @@ This request cannot be completed for one of the following reasons: -Indicates the reason for a conflict error when the service is unable to access a Customer Managed KMS key. For non-KMS permission errors, this field is not included. +Indicates the reason for the conflict error. `UNIQUENESS_CONSTRAINT_VIOLATION` indicates that the request would violate an existing uniqueness constraint, such as a user name or other unique attribute that is already in use. `CONCURRENT_MODIFICATION` indicates that the resource was modified by another request during this operation. @@ -159 +233 @@ The identifier for a resource in the identity store that can be used as `UserId` -An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE. +An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, GROUP_MEMBERSHIP, RESOURCE_POLICY, and IDENTITY_STORE. @@ -218 +292 @@ HTTP Status Code: 400 -This example updates the display name of the specified group to "Engineers". +This example updates the display name of the specified group to "Engineers" and passes the current `Revision` so that your update is applied only if the group hasn't changed since you last read it (optimistic locking). The response returns the new `Revision`. @@ -225,0 +300 @@ This example updates the display name of the specified group to "Engineers". + "Revision": "1699564800000", @@ -238 +313,6 @@ This example updates the display name of the specified group to "Engineers". - No response + { + "IdentityStoreId": "d-1234567890", + "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "GroupArn": "arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Revision": "1699651200000" + } @@ -243 +323 @@ This example updates the display name of the specified group to "Engineers". -This example updates the description of the specified group to "Contains all engineers". +This example updates the description of the specified group to "Contains all engineers." If you omit `Revision`, your update is applied unconditionally. @@ -263 +343,6 @@ This example updates the description of the specified group to "Contains all eng - No response + { + "IdentityStoreId": "d-1234567890", + "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "GroupArn": "arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Revision": "1699651200000" + } @@ -278 +363 @@ This example removes the description from the specified group. - "AttributePath": "description", + "AttributePath": "description" @@ -287 +372,6 @@ This example removes the description from the specified group. - No response + { + "IdentityStoreId": "d-1234567890", + "GroupId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "GroupArn": "arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", + "Revision": "1699651200000" + } @@ -325 +415 @@ ListUsers -UpdateUser +UpdateIdentityStore