AWS singlesignon: DescribeUser: add ARN support and Revision/UserArn fields
Summary
Updates the DescribeUser API reference to document that IdentityStoreId and UserId can be specified as ARNs in addition to IDs, widens the length constraints and regex patterns accordingly, adds the new Revision and UserArn response fields, expands the resource-type enum (GROUP_MEMBERSHIP, RESOURCE_POLICY), and refreshes the request/response examples.
Security assessment
This is a purely descriptive API reference update: it documents that identifiers may be passed as ARNs, adjusts length/pattern constraints, and adds Revision/UserArn output fields. It does not describe a vulnerability, a fix, or a security control, so it is not security-related.
Evidence
+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`.
Diff
diff --git a/singlesignon/latest/IdentityStoreAPIReference/API_DescribeUser.md b/singlesignon/latest/IdentityStoreAPIReference/API_DescribeUser.md index a25d915..677587a 100644 --- a//singlesignon/latest/IdentityStoreAPIReference/API_DescribeUser.md +++ b//singlesignon/latest/IdentityStoreAPIReference/API_DescribeUser.md @@ -51,0 +52,2 @@ The globally unique identifier for the identity store, such as `d-1234567890`. I +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`. + @@ -54 +56 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 36. +Length Constraints: Minimum length of 1. Maximum length of 93. @@ -56 +58 @@ 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})` @@ -64,0 +67,2 @@ The identifier for a user in the identity store. +You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID `a1b2c3d4-5678-90ab-cdef-EXAMPLE11111` or user ARN `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. + @@ -67 +71 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 47. +Length Constraints: Minimum length of 1. Maximum length of 100. @@ -69 +73 @@ 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}` @@ -136,0 +141 @@ Required: Yes + "Revision": "**_string_** ", @@ -147,0 +153 @@ Required: Yes + "UserArn": "**_string_** ", @@ -244 +250 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 36. +Length Constraints: Minimum length of 1. Maximum length of 93. @@ -246 +252 @@ 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})` @@ -316,0 +323,11 @@ Pattern: `[\p{L}\p{M}\p{S}\p{N}\p{P}\t\n\r ]+` +**Revision ** + + +The current revision of the user in the identity store. This value changes each time the user is modified. + +Type: String + +Length Constraints: Minimum length of 1. Maximum length of 64. + +Pattern: `[0-9]+` + @@ -361,0 +379,11 @@ Type: String +**UserArn ** + + +The Amazon Resource Name (ARN) of the user in the identity store. For example, `arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111`. + +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}` + @@ -369 +397 @@ Type: String -Length Constraints: Minimum length of 1. Maximum length of 47. +Length Constraints: Minimum length of 1. Maximum length of 100. @@ -371 +399 @@ 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}` @@ -476 +504 @@ 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. @@ -530 +558 @@ This example retrieves only the core information about a user called John Doe. - "UserId": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p" + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111" @@ -537,0 +566,3 @@ This example retrieves only the core information about a user called John Doe. + "IdentityStoreId": "d-1234567890", + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "UserArn": "arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", @@ -539 +569,0 @@ This example retrieves only the core information about a user called John Doe. - "UserId": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p", @@ -543 +573 @@ This example retrieves only the core information about a user called John Doe. - "GivenName": "John", + "GivenName": "John" @@ -571 +601 @@ This example retrieves only the core information about a user called John Doe. - "IdentityStoreId": "d-1234567890" + "Revision": "1699564800000" @@ -583 +613 @@ This example retrieves both core and enterprise information about a user called - "UserId": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p", + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", @@ -591,0 +622,3 @@ This example retrieves both core and enterprise information about a user called + "IdentityStoreId": "d-1234567890", + "UserId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", + "UserArn": "arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", @@ -593 +625,0 @@ This example retrieves both core and enterprise information about a user called - "UserId": "1a2b3c4d-5e6f-7g8h-9i0j-1k2l3m4n5o6p", @@ -597 +629 @@ This example retrieves both core and enterprise information about a user called - "GivenName": "John", + "GivenName": "John" @@ -625 +657 @@ This example retrieves both core and enterprise information about a user called - "IdentityStoreId": "d-1234567890", + "Revision": "1699564800000", @@ -673 +705 @@ To use the Amazon Web Services Documentation, Javascript must be enabled. Please -DescribeGroupMembership +DescribeIdentityStore