AWS singlesignon: CreateGroupMembership API: ARN identifiers and MembershipArn
Summary
Documents ARN-based identifiers for group, identity store, and membership; updates length/pattern constraints; adds MembershipArn response field; clarifies conflict error reasons and enum values.
Security assessment
API reference update to accept ARN identifiers and document new response/error fields; no vulnerability, credential, encryption, or authorization control is addressed.
Evidence
+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}`
Diff
diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_CreateGroupMembership.md b/singlesignon/latest/IdentityStoreAPIReference/API_CreateGroupMembership.md index de137f9..140cfee 100644 --- a//singlesignon/latest/IdentityStoreAPIReference/API_CreateGroupMembership.md +++ b//singlesignon/latest/IdentityStoreAPIReference/API_CreateGroupMembership.md @@ -32,0 +33,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`. + @@ -35 +37 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 47. +Length Constraints: Minimum length of 1. Maximum length of 100. @@ -37 +39 @@ 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}` @@ -45,0 +48,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`. + @@ -48 +52 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 36. +Length Constraints: Minimum length of 1. Maximum length of 93. @@ -50 +54 @@ 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})` @@ -57 +61 @@ Required: Yes -An object that contains the identifier of a group member. Setting the `UserID` field to the specific identifier for a user indicates that the user is a member of the group. +An object that contains the identifier of a group member. Setting the `UserId` field to the specific identifier for a user indicates that the user is a member of the group. @@ -69,0 +74 @@ Required: Yes + "MembershipArn": "**_string_** ", @@ -86 +91,12 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 36. +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})` + +**MembershipArn ** + + +The Amazon Resource Name (ARN) of the newly created group membership in the identity store. For example, `arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333`. + +Type: String + +Length Constraints: Minimum length of 60. Maximum length of 100. @@ -88 +104 @@ 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:::(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}` @@ -97 +113 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 47. +Length Constraints: Minimum length of 1. Maximum length of 100. @@ -99 +115 @@ 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}` @@ -137 +153 @@ 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. @@ -186 +202 @@ 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. @@ -261,0 +278 @@ This example adds the specified user as a member of the specified group. + "IdentityStoreId": "d-1234567890", @@ -263 +280 @@ This example adds the specified user as a member of the specified group. - "IdentityStoreId": "d-1234567890" + "MembershipArn": "arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333"