Skip to content

Commit 28d8504

Browse files
author
awstools
committed
feat(client-identitystore): IdentityStore API: added new KMSExceptionReason fields to the Exception object; added multiple new fields to the User APIs - UserStatus, Birthdate, Website and Photos; added multiple new metadata fields for User, Groups and Membership APIs - CreatedAt, CreatedBy, UpdatedAt and UpdatedBy.
1 parent 02e87fe commit 28d8504

26 files changed

+1287
-543
lines changed

clients/client-identitystore/README.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,7 @@
66

77
AWS SDK for JavaScript Identitystore Client for Node.js, Browser and React Native.
88

9-
<p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of
10-
your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
11-
Guide</a>.</p>
12-
<p>This reference guide describes the identity store operations that you can call
13-
programmatically and includes detailed information about data types and errors.</p>
14-
<note>
15-
<p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
16-
</note>
9+
<p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html"> IAM Identity Center User Guide</a>.</p> <p>This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.</p> <note> <p> IAM Identity Center uses the <code>sso</code>, <code>sso-directory</code>, and <code>identitystore</code> API namespaces. The <code>sso-directory</code> and <code>identitystore</code> namespaces authorize access to data in the Identity Store. Make sure your policies with IAM actions from these two namespaces are consistent to avoid conflicting authorization to the same data.</p> </note>
1710

1811
## Installing
1912

clients/client-identitystore/src/Identitystore.ts

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -335,14 +335,7 @@ export interface Identitystore {
335335
}
336336

337337
/**
338-
* <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of
339-
* your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
340-
* Guide</a>.</p>
341-
* <p>This reference guide describes the identity store operations that you can call
342-
* programmatically and includes detailed information about data types and errors.</p>
343-
* <note>
344-
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
345-
* </note>
338+
* <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html"> IAM Identity Center User Guide</a>.</p> <p>This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.</p> <note> <p> IAM Identity Center uses the <code>sso</code>, <code>sso-directory</code>, and <code>identitystore</code> API namespaces. The <code>sso-directory</code> and <code>identitystore</code> namespaces authorize access to data in the Identity Store. Make sure your policies with IAM actions from these two namespaces are consistent to avoid conflicting authorization to the same data.</p> </note>
346339
* @public
347340
*/
348341
export class Identitystore extends IdentitystoreClient implements Identitystore {}

clients/client-identitystore/src/IdentitystoreClient.ts

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -340,14 +340,7 @@ export type IdentitystoreClientResolvedConfigType = __SmithyResolvedConfiguratio
340340
export interface IdentitystoreClientResolvedConfig extends IdentitystoreClientResolvedConfigType {}
341341

342342
/**
343-
* <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of
344-
* your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html">IAM Identity Center User
345-
* Guide</a>.</p>
346-
* <p>This reference guide describes the identity store operations that you can call
347-
* programmatically and includes detailed information about data types and errors.</p>
348-
* <note>
349-
* <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
350-
* </note>
343+
* <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of your identities (users and groups). For more information, see the <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html"> IAM Identity Center User Guide</a>.</p> <p>This reference guide describes the identity store operations that you can call programmatically and includes detailed information about data types and errors.</p> <note> <p> IAM Identity Center uses the <code>sso</code>, <code>sso-directory</code>, and <code>identitystore</code> API namespaces. The <code>sso-directory</code> and <code>identitystore</code> namespaces authorize access to data in the Identity Store. Make sure your policies with IAM actions from these two namespaces are consistent to avoid conflicting authorization to the same data.</p> </note>
351344
* @public
352345
*/
353346
export class IdentitystoreClient extends __Client<

clients/client-identitystore/src/commands/CreateGroupCommand.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -58,15 +58,7 @@ export interface CreateGroupCommandOutput extends CreateGroupResponse, __Metadat
5858
* @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
5959
*
6060
* @throws {@link ConflictException} (client fault)
61-
* <p>This request cannot be completed for one of the following reasons:</p>
62-
* <ul>
63-
* <li>
64-
* <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
65-
* </li>
66-
* <li>
67-
* <p>The requested resource was being concurrently modified by another request.</p>
68-
* </li>
69-
* </ul>
61+
* <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
7062
*
7163
* @throws {@link ResourceNotFoundException} (client fault)
7264
* <p>Indicates that a requested resource is not found.</p>

clients/client-identitystore/src/commands/CreateGroupMembershipCommand.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,7 @@ export interface CreateGroupMembershipCommandOutput extends CreateGroupMembershi
6060
* @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
6161
*
6262
* @throws {@link ConflictException} (client fault)
63-
* <p>This request cannot be completed for one of the following reasons:</p>
64-
* <ul>
65-
* <li>
66-
* <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
67-
* </li>
68-
* <li>
69-
* <p>The requested resource was being concurrently modified by another request.</p>
70-
* </li>
71-
* </ul>
63+
* <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
7264
*
7365
* @throws {@link ResourceNotFoundException} (client fault)
7466
* <p>Indicates that a requested resource is not found.</p>

clients/client-identitystore/src/commands/CreateUserCommand.ts

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -82,12 +82,22 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
8282
* PreferredLanguage: "STRING_VALUE",
8383
* Locale: "STRING_VALUE",
8484
* Timezone: "STRING_VALUE",
85+
* Photos: [ // Photos
86+
* { // Photo
87+
* Value: "STRING_VALUE", // required
88+
* Type: "STRING_VALUE",
89+
* Display: "STRING_VALUE",
90+
* Primary: true || false,
91+
* },
92+
* ],
93+
* Website: "STRING_VALUE",
94+
* Birthdate: "STRING_VALUE",
8595
* };
8696
* const command = new CreateUserCommand(input);
8797
* const response = await client.send(command);
8898
* // { // CreateUserResponse
89-
* // UserId: "STRING_VALUE", // required
9099
* // IdentityStoreId: "STRING_VALUE", // required
100+
* // UserId: "STRING_VALUE", // required
91101
* // };
92102
*
93103
* ```
@@ -99,15 +109,7 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
99109
* @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
100110
*
101111
* @throws {@link ConflictException} (client fault)
102-
* <p>This request cannot be completed for one of the following reasons:</p>
103-
* <ul>
104-
* <li>
105-
* <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
106-
* </li>
107-
* <li>
108-
* <p>The requested resource was being concurrently modified by another request.</p>
109-
* </li>
110-
* </ul>
112+
* <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
111113
*
112114
* @throws {@link ResourceNotFoundException} (client fault)
113115
* <p>Indicates that a requested resource is not found.</p>

clients/client-identitystore/src/commands/DeleteGroupCommand.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,7 @@ export interface DeleteGroupCommandOutput extends DeleteGroupResponse, __Metadat
5454
* @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
5555
*
5656
* @throws {@link ConflictException} (client fault)
57-
* <p>This request cannot be completed for one of the following reasons:</p>
58-
* <ul>
59-
* <li>
60-
* <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
61-
* </li>
62-
* <li>
63-
* <p>The requested resource was being concurrently modified by another request.</p>
64-
* </li>
65-
* </ul>
57+
* <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
6658
*
6759
* @throws {@link ResourceNotFoundException} (client fault)
6860
* <p>Indicates that a requested resource is not found.</p>

clients/client-identitystore/src/commands/DeleteGroupMembershipCommand.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,7 @@ export interface DeleteGroupMembershipCommandOutput extends DeleteGroupMembershi
5454
* @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
5555
*
5656
* @throws {@link ConflictException} (client fault)
57-
* <p>This request cannot be completed for one of the following reasons:</p>
58-
* <ul>
59-
* <li>
60-
* <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
61-
* </li>
62-
* <li>
63-
* <p>The requested resource was being concurrently modified by another request.</p>
64-
* </li>
65-
* </ul>
57+
* <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
6658
*
6759
* @throws {@link ResourceNotFoundException} (client fault)
6860
* <p>Indicates that a requested resource is not found.</p>

clients/client-identitystore/src/commands/DeleteUserCommand.ts

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,7 @@ export interface DeleteUserCommandOutput extends DeleteUserResponse, __MetadataB
5454
* @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
5555
*
5656
* @throws {@link ConflictException} (client fault)
57-
* <p>This request cannot be completed for one of the following reasons:</p>
58-
* <ul>
59-
* <li>
60-
* <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
61-
* </li>
62-
* <li>
63-
* <p>The requested resource was being concurrently modified by another request.</p>
64-
* </li>
65-
* </ul>
57+
* <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
6658
*
6759
* @throws {@link ResourceNotFoundException} (client fault)
6860
* <p>Indicates that a requested resource is not found.</p>

clients/client-identitystore/src/commands/DescribeGroupCommand.ts

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,7 @@ export interface DescribeGroupCommandInput extends DescribeGroupRequest {}
3232
export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __MetadataBearer {}
3333

3434
/**
35-
* <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity
36-
* store.</p>
37-
* <note>
38-
* <p>If you have administrator access to a member account, you can use this API from the member account.
39-
* Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
40-
* <i>Organizations User Guide</i>. </p>
41-
* </note>
35+
* <p>Retrieves the group metadata and attributes from <code>GroupId</code> in an identity store.</p> <note> <p>If you have access to a member account, you can use this API operation from the member account. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/manage-your-accounts.html#limiting-access-from-member-accounts">Limiting access to the identity store from member accounts</a> in the <i> IAM Identity Center User Guide</i>.</p> </note>
4236
* @example
4337
* Use a bare-bones client and the command you need to make an API call.
4438
* ```javascript
@@ -63,6 +57,10 @@ export interface DescribeGroupCommandOutput extends DescribeGroupResponse, __Met
6357
* // },
6458
* // ],
6559
* // Description: "STRING_VALUE",
60+
* // CreatedAt: new Date("TIMESTAMP"),
61+
* // UpdatedAt: new Date("TIMESTAMP"),
62+
* // CreatedBy: "STRING_VALUE",
63+
* // UpdatedBy: "STRING_VALUE",
6664
* // IdentityStoreId: "STRING_VALUE", // required
6765
* // };
6866
*

0 commit comments

Comments
 (0)