@aws-sdk/client-identitystore 3.925.0 → 3.927.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/README.md +1 -8
  2. package/dist-cjs/index.js +210 -7
  3. package/dist-es/models/models_0.js +43 -0
  4. package/dist-es/protocols/Aws_json1_1.js +163 -9
  5. package/dist-types/Identitystore.d.ts +1 -8
  6. package/dist-types/IdentitystoreClient.d.ts +1 -8
  7. package/dist-types/commands/CreateGroupCommand.d.ts +1 -9
  8. package/dist-types/commands/CreateGroupMembershipCommand.d.ts +1 -9
  9. package/dist-types/commands/CreateUserCommand.d.ts +12 -10
  10. package/dist-types/commands/DeleteGroupCommand.d.ts +1 -9
  11. package/dist-types/commands/DeleteGroupMembershipCommand.d.ts +1 -9
  12. package/dist-types/commands/DeleteUserCommand.d.ts +1 -9
  13. package/dist-types/commands/DescribeGroupCommand.d.ts +5 -7
  14. package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +5 -6
  15. package/dist-types/commands/DescribeUserCommand.d.ts +18 -8
  16. package/dist-types/commands/GetGroupIdCommand.d.ts +1 -6
  17. package/dist-types/commands/GetGroupMembershipIdCommand.d.ts +1 -6
  18. package/dist-types/commands/GetUserIdCommand.d.ts +2 -7
  19. package/dist-types/commands/IsMemberInGroupsCommand.d.ts +1 -6
  20. package/dist-types/commands/ListGroupMembershipsCommand.d.ts +5 -6
  21. package/dist-types/commands/ListGroupMembershipsForMemberCommand.d.ts +5 -6
  22. package/dist-types/commands/ListGroupsCommand.d.ts +5 -7
  23. package/dist-types/commands/ListUsersCommand.d.ts +18 -9
  24. package/dist-types/commands/UpdateGroupCommand.d.ts +2 -10
  25. package/dist-types/commands/UpdateUserCommand.d.ts +2 -10
  26. package/dist-types/index.d.ts +1 -8
  27. package/dist-types/models/models_0.d.ts +365 -202
  28. package/dist-types/ts3.4/models/models_0.d.ts +80 -6
  29. package/package.json +5 -5
@@ -27,13 +27,7 @@ declare const ListGroupsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects.
31
- * Filtering for a <code>Group</code> by the <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</p>
32
- * <note>
33
- * <p>If you have administrator access to a member account, you can use this API from the member account.
34
- * Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
35
- * <i>Organizations User Guide</i>. </p>
36
- * </note>
30
+ * <p>Lists all groups in the identity store. Returns a paginated list of complete <code>Group</code> objects. Filtering for a <code>Group</code> by the <code>DisplayName</code> attribute is deprecated. Instead, use the <code>GetGroupId</code> API action.</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>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -67,6 +61,10 @@ declare const ListGroupsCommand_base: {
67
61
  * // },
68
62
  * // ],
69
63
  * // Description: "STRING_VALUE",
64
+ * // CreatedAt: new Date("TIMESTAMP"),
65
+ * // UpdatedAt: new Date("TIMESTAMP"),
66
+ * // CreatedBy: "STRING_VALUE",
67
+ * // UpdatedBy: "STRING_VALUE",
70
68
  * // IdentityStoreId: "STRING_VALUE", // required
71
69
  * // },
72
70
  * // ],
@@ -27,13 +27,7 @@ declare const ListUsersCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects.
31
- * Filtering for a <code>User</code> by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</p>
32
- * <note>
33
- * <p>If you have administrator access to a member account, you can use this API from the member account.
34
- * Read about <a href="https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_accounts_access.html">member accounts</a> in the
35
- * <i>Organizations User Guide</i>.</p>
36
- * </note>
30
+ * <p>Lists all users in the identity store. Returns a paginated list of complete <code>User</code> objects. Filtering for a <code>User</code> by the <code>UserName</code> attribute is deprecated. Instead, use the <code>GetUserId</code> API action.</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>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -58,8 +52,9 @@ declare const ListUsersCommand_base: {
58
52
  * // { // ListUsersResponse
59
53
  * // Users: [ // Users // required
60
54
  * // { // User
61
- * // UserName: "STRING_VALUE",
55
+ * // IdentityStoreId: "STRING_VALUE", // required
62
56
  * // UserId: "STRING_VALUE", // required
57
+ * // UserName: "STRING_VALUE",
63
58
  * // ExternalIds: [ // ExternalIds
64
59
  * // { // ExternalId
65
60
  * // Issuer: "STRING_VALUE", // required
@@ -108,7 +103,21 @@ declare const ListUsersCommand_base: {
108
103
  * // PreferredLanguage: "STRING_VALUE",
109
104
  * // Locale: "STRING_VALUE",
110
105
  * // Timezone: "STRING_VALUE",
111
- * // IdentityStoreId: "STRING_VALUE", // required
106
+ * // UserStatus: "ENABLED" || "DISABLED",
107
+ * // Photos: [ // Photos
108
+ * // { // Photo
109
+ * // Value: "STRING_VALUE", // required
110
+ * // Type: "STRING_VALUE",
111
+ * // Display: "STRING_VALUE",
112
+ * // Primary: true || false,
113
+ * // },
114
+ * // ],
115
+ * // Website: "STRING_VALUE",
116
+ * // Birthdate: "STRING_VALUE",
117
+ * // CreatedAt: new Date("TIMESTAMP"),
118
+ * // CreatedBy: "STRING_VALUE",
119
+ * // UpdatedAt: new Date("TIMESTAMP"),
120
+ * // UpdatedBy: "STRING_VALUE",
112
121
  * // },
113
122
  * // ],
114
123
  * // NextToken: "STRING_VALUE",
@@ -27,7 +27,7 @@ declare const UpdateGroupCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>For the specified group in the specified identity store, updates the group metadata and attributes.</p>
30
+ * <p>Updates the specified group metadata and attributes in the specified identity store.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -59,15 +59,7 @@ declare const UpdateGroupCommand_base: {
59
59
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
60
60
  *
61
61
  * @throws {@link ConflictException} (client fault)
62
- * <p>This request cannot be completed for one of the following reasons:</p>
63
- * <ul>
64
- * <li>
65
- * <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
66
- * </li>
67
- * <li>
68
- * <p>The requested resource was being concurrently modified by another request.</p>
69
- * </li>
70
- * </ul>
62
+ * <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>
71
63
  *
72
64
  * @throws {@link ResourceNotFoundException} (client fault)
73
65
  * <p>Indicates that a requested resource is not found.</p>
@@ -27,7 +27,7 @@ declare const UpdateUserCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>For the specified user in the specified identity store, updates the user metadata and attributes.</p>
30
+ * <p>Updates the specified user metadata and attributes in the specified identity store.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -59,15 +59,7 @@ declare const UpdateUserCommand_base: {
59
59
  * @see {@link IdentitystoreClientResolvedConfig | config} for IdentitystoreClient's `config` shape.
60
60
  *
61
61
  * @throws {@link ConflictException} (client fault)
62
- * <p>This request cannot be completed for one of the following reasons:</p>
63
- * <ul>
64
- * <li>
65
- * <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p>
66
- * </li>
67
- * <li>
68
- * <p>The requested resource was being concurrently modified by another request.</p>
69
- * </li>
70
- * </ul>
62
+ * <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>
71
63
  *
72
64
  * @throws {@link ResourceNotFoundException} (client fault)
73
65
  * <p>Indicates that a requested resource is not found.</p>
@@ -1,12 +1,5 @@
1
1
  /**
2
- * <p>The Identity Store service used by IAM Identity Center provides a single place to retrieve all of
3
- * 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
4
- * Guide</a>.</p>
5
- * <p>This reference guide describes the identity store operations that you can call
6
- * programmatically and includes detailed information about data types and errors.</p>
7
- * <note>
8
- * <p>IAM Identity Center uses the <code>sso</code> and <code>identitystore</code> API namespaces.</p>
9
- * </note>
2
+ * <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>
10
3
  *
11
4
  * @packageDocumentation
12
5
  */