@aws-sdk/client-identitystore 3.1141.0 → 3.1143.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.
- package/README.md +22 -1
- package/dist-cjs/index.js +186 -76
- package/dist-es/Identitystore.js +8 -0
- package/dist-es/commands/DescribeIdentityStoreCommand.js +4 -0
- package/dist-es/commands/ListIdentityStoresCommand.js +4 -0
- package/dist-es/commands/UpdateIdentityStoreCommand.js +4 -0
- package/dist-es/commands/index.js +3 -0
- package/dist-es/models/enums.js +4 -4
- package/dist-es/models/errors.js +34 -34
- package/dist-es/pagination/ListIdentityStoresPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/schemas/schemas_0.js +118 -37
- package/dist-types/Identitystore.d.ts +30 -1
- package/dist-types/IdentitystoreClient.d.ts +6 -3
- package/dist-types/commands/CreateGroupCommand.d.ts +3 -1
- package/dist-types/commands/CreateGroupMembershipCommand.d.ts +2 -1
- package/dist-types/commands/CreateUserCommand.d.ts +2 -0
- package/dist-types/commands/DeleteGroupCommand.d.ts +1 -0
- package/dist-types/commands/DeleteUserCommand.d.ts +1 -0
- package/dist-types/commands/DescribeGroupCommand.d.ts +3 -1
- package/dist-types/commands/DescribeGroupMembershipCommand.d.ts +1 -0
- package/dist-types/commands/DescribeIdentityStoreCommand.d.ts +99 -0
- package/dist-types/commands/DescribeUserCommand.d.ts +2 -0
- package/dist-types/commands/GetGroupIdCommand.d.ts +2 -1
- package/dist-types/commands/GetGroupMembershipIdCommand.d.ts +2 -1
- package/dist-types/commands/GetUserIdCommand.d.ts +1 -0
- package/dist-types/commands/ListGroupMembershipsCommand.d.ts +2 -1
- package/dist-types/commands/ListGroupMembershipsForMemberCommand.d.ts +2 -1
- package/dist-types/commands/ListGroupsCommand.d.ts +3 -1
- package/dist-types/commands/ListIdentityStoresCommand.d.ts +90 -0
- package/dist-types/commands/ListUsersCommand.d.ts +2 -0
- package/dist-types/commands/UpdateGroupCommand.d.ts +8 -2
- package/dist-types/commands/UpdateIdentityStoreCommand.d.ts +102 -0
- package/dist-types/commands/UpdateUserCommand.d.ts +8 -2
- package/dist-types/commands/index.d.ts +3 -0
- package/dist-types/index.d.ts +1 -1
- package/dist-types/models/enums.d.ts +12 -12
- package/dist-types/models/errors.d.ts +41 -41
- package/dist-types/models/models_0.d.ts +458 -150
- package/dist-types/pagination/ListIdentityStoresPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/schemas/schemas_0.d.ts +12 -0
- package/dist-types/ts3.4/Identitystore.d.ts +59 -0
- package/dist-types/ts3.4/IdentitystoreClient.d.ts +18 -0
- package/dist-types/ts3.4/commands/DescribeIdentityStoreCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/ListIdentityStoresCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateGroupCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateIdentityStoreCommand.d.ts +39 -0
- package/dist-types/ts3.4/commands/UpdateUserCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +3 -0
- package/dist-types/ts3.4/models/enums.d.ts +6 -6
- package/dist-types/ts3.4/models/errors.d.ts +15 -15
- package/dist-types/ts3.4/models/models_0.d.ts +116 -44
- package/dist-types/ts3.4/pagination/ListIdentityStoresPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/schemas/schemas_0.d.ts +12 -0
- package/package.json +1 -1
|
@@ -139,36 +139,6 @@ export interface AttributeOperation {
|
|
|
139
139
|
*/
|
|
140
140
|
AttributeValue?: __DocumentType | undefined;
|
|
141
141
|
}
|
|
142
|
-
/**
|
|
143
|
-
* @public
|
|
144
|
-
*/
|
|
145
|
-
export interface GetGroupIdRequest {
|
|
146
|
-
/**
|
|
147
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
148
|
-
* @public
|
|
149
|
-
*/
|
|
150
|
-
IdentityStoreId: string | undefined;
|
|
151
|
-
/**
|
|
152
|
-
* <p>A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is <code> displayName</code>.</p>
|
|
153
|
-
* @public
|
|
154
|
-
*/
|
|
155
|
-
AlternateIdentifier: AlternateIdentifier | undefined;
|
|
156
|
-
}
|
|
157
|
-
/**
|
|
158
|
-
* @public
|
|
159
|
-
*/
|
|
160
|
-
export interface GetGroupIdResponse {
|
|
161
|
-
/**
|
|
162
|
-
* <p>The identifier for a group in the identity store.</p>
|
|
163
|
-
* @public
|
|
164
|
-
*/
|
|
165
|
-
GroupId: string | undefined;
|
|
166
|
-
/**
|
|
167
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
168
|
-
* @public
|
|
169
|
-
*/
|
|
170
|
-
IdentityStoreId: string | undefined;
|
|
171
|
-
}
|
|
172
142
|
/**
|
|
173
143
|
* <p>An object containing the identifier of a group member.</p>
|
|
174
144
|
* @public
|
|
@@ -179,7 +149,7 @@ export type MemberId = MemberId.UserIdMember | MemberId.$UnknownMember;
|
|
|
179
149
|
*/
|
|
180
150
|
export declare namespace MemberId {
|
|
181
151
|
/**
|
|
182
|
-
* <p>
|
|
152
|
+
* <p>The identifier for a user in the identity store.</p> <p>You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code> or user ARN <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
183
153
|
* @public
|
|
184
154
|
*/
|
|
185
155
|
interface UserIdMember {
|
|
@@ -205,14 +175,14 @@ export declare namespace MemberId {
|
|
|
205
175
|
/**
|
|
206
176
|
* @public
|
|
207
177
|
*/
|
|
208
|
-
export interface
|
|
178
|
+
export interface CreateGroupMembershipRequest {
|
|
209
179
|
/**
|
|
210
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
180
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
211
181
|
* @public
|
|
212
182
|
*/
|
|
213
183
|
IdentityStoreId: string | undefined;
|
|
214
184
|
/**
|
|
215
|
-
* <p>The identifier for a group in the identity store.</p>
|
|
185
|
+
* <p>The identifier for a group in the identity store.</p> <p>You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code> or group ARN <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
216
186
|
* @public
|
|
217
187
|
*/
|
|
218
188
|
GroupId: string | undefined;
|
|
@@ -225,122 +195,132 @@ export interface GetGroupMembershipIdRequest {
|
|
|
225
195
|
/**
|
|
226
196
|
* @public
|
|
227
197
|
*/
|
|
228
|
-
export interface
|
|
198
|
+
export interface CreateGroupMembershipResponse {
|
|
229
199
|
/**
|
|
230
|
-
* <p>The identifier for
|
|
200
|
+
* <p>The globally unique identifier for the identity store.</p>
|
|
201
|
+
* @public
|
|
202
|
+
*/
|
|
203
|
+
IdentityStoreId: string | undefined;
|
|
204
|
+
/**
|
|
205
|
+
* <p>The identifier for a newly created <code>GroupMembership</code> in an identity store.</p>
|
|
231
206
|
* @public
|
|
232
207
|
*/
|
|
233
208
|
MembershipId: string | undefined;
|
|
234
209
|
/**
|
|
235
|
-
* <p>The
|
|
210
|
+
* <p>The Amazon Resource Name (ARN) of the newly created group membership in the identity store. For example, <code>arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code>.</p>
|
|
236
211
|
* @public
|
|
237
212
|
*/
|
|
238
|
-
|
|
213
|
+
MembershipArn: string | undefined;
|
|
239
214
|
}
|
|
240
215
|
/**
|
|
241
216
|
* @public
|
|
242
217
|
*/
|
|
243
|
-
export interface
|
|
218
|
+
export interface DeleteGroupMembershipRequest {
|
|
244
219
|
/**
|
|
245
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
220
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
246
221
|
* @public
|
|
247
222
|
*/
|
|
248
223
|
IdentityStoreId: string | undefined;
|
|
249
224
|
/**
|
|
250
|
-
* <p>
|
|
225
|
+
* <p>The identifier for a <code>GroupMembership</code> in an identity store.</p> <p>You can specify the group membership by ID or by Amazon Resource Name (ARN). For example, membership ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code> or membership ARN <code>arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code>.</p>
|
|
251
226
|
* @public
|
|
252
227
|
*/
|
|
253
|
-
|
|
228
|
+
MembershipId: string | undefined;
|
|
254
229
|
}
|
|
255
230
|
/**
|
|
256
231
|
* @public
|
|
257
232
|
*/
|
|
258
|
-
export interface
|
|
233
|
+
export interface DeleteGroupMembershipResponse {
|
|
234
|
+
}
|
|
235
|
+
/**
|
|
236
|
+
* @public
|
|
237
|
+
*/
|
|
238
|
+
export interface DescribeGroupMembershipRequest {
|
|
259
239
|
/**
|
|
260
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
240
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
261
241
|
* @public
|
|
262
242
|
*/
|
|
263
243
|
IdentityStoreId: string | undefined;
|
|
264
244
|
/**
|
|
265
|
-
* <p>The identifier for a
|
|
245
|
+
* <p>The identifier for a <code>GroupMembership</code> in an identity store.</p> <p>You can specify the group membership by ID or by Amazon Resource Name (ARN). For example, membership ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code> or membership ARN <code>arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code>.</p>
|
|
266
246
|
* @public
|
|
267
247
|
*/
|
|
268
|
-
|
|
248
|
+
MembershipId: string | undefined;
|
|
269
249
|
}
|
|
270
250
|
/**
|
|
271
251
|
* @public
|
|
272
252
|
*/
|
|
273
|
-
export interface
|
|
253
|
+
export interface DescribeGroupMembershipResponse {
|
|
274
254
|
/**
|
|
275
255
|
* <p>The globally unique identifier for the identity store.</p>
|
|
276
256
|
* @public
|
|
277
257
|
*/
|
|
278
258
|
IdentityStoreId: string | undefined;
|
|
259
|
+
/**
|
|
260
|
+
* <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
MembershipId: string | undefined;
|
|
264
|
+
/**
|
|
265
|
+
* <p>The Amazon Resource Name (ARN) of the group membership in the identity store. For example, <code>arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code>.</p>
|
|
266
|
+
* @public
|
|
267
|
+
*/
|
|
268
|
+
MembershipArn: string | undefined;
|
|
279
269
|
/**
|
|
280
270
|
* <p>The identifier for a group in the identity store.</p>
|
|
281
271
|
* @public
|
|
282
272
|
*/
|
|
283
273
|
GroupId: string | undefined;
|
|
284
274
|
/**
|
|
285
|
-
* <p>An object
|
|
275
|
+
* <p>An object containing the identifier of a group member.</p>
|
|
286
276
|
* @public
|
|
287
277
|
*/
|
|
288
278
|
MemberId: MemberId | undefined;
|
|
289
|
-
}
|
|
290
|
-
/**
|
|
291
|
-
* @public
|
|
292
|
-
*/
|
|
293
|
-
export interface CreateGroupMembershipResponse {
|
|
294
279
|
/**
|
|
295
|
-
* <p>The
|
|
280
|
+
* <p>The date and time the group membership was created.</p>
|
|
296
281
|
* @public
|
|
297
282
|
*/
|
|
298
|
-
|
|
283
|
+
CreatedAt?: Date | undefined;
|
|
299
284
|
/**
|
|
300
|
-
* <p>The
|
|
285
|
+
* <p>The date and time the group membership was last updated.</p>
|
|
301
286
|
* @public
|
|
302
287
|
*/
|
|
303
|
-
|
|
304
|
-
}
|
|
305
|
-
/**
|
|
306
|
-
* @public
|
|
307
|
-
*/
|
|
308
|
-
export interface DeleteGroupMembershipRequest {
|
|
288
|
+
UpdatedAt?: Date | undefined;
|
|
309
289
|
/**
|
|
310
|
-
* <p>The
|
|
290
|
+
* <p>The identifier of the user or system that created the group membership.</p>
|
|
311
291
|
* @public
|
|
312
292
|
*/
|
|
313
|
-
|
|
293
|
+
CreatedBy?: string | undefined;
|
|
314
294
|
/**
|
|
315
|
-
* <p>The identifier
|
|
295
|
+
* <p>The identifier of the user or system that last updated the group membership.</p>
|
|
316
296
|
* @public
|
|
317
297
|
*/
|
|
318
|
-
|
|
319
|
-
}
|
|
320
|
-
/**
|
|
321
|
-
* @public
|
|
322
|
-
*/
|
|
323
|
-
export interface DeleteGroupMembershipResponse {
|
|
298
|
+
UpdatedBy?: string | undefined;
|
|
324
299
|
}
|
|
325
300
|
/**
|
|
326
301
|
* @public
|
|
327
302
|
*/
|
|
328
|
-
export interface
|
|
303
|
+
export interface GetGroupMembershipIdRequest {
|
|
329
304
|
/**
|
|
330
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
305
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
331
306
|
* @public
|
|
332
307
|
*/
|
|
333
308
|
IdentityStoreId: string | undefined;
|
|
334
309
|
/**
|
|
335
|
-
* <p>The identifier for a <code>
|
|
310
|
+
* <p>The identifier for a group in the identity store.</p> <p>You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code> or group ARN <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
336
311
|
* @public
|
|
337
312
|
*/
|
|
338
|
-
|
|
313
|
+
GroupId: string | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
|
|
316
|
+
* @public
|
|
317
|
+
*/
|
|
318
|
+
MemberId: MemberId | undefined;
|
|
339
319
|
}
|
|
340
320
|
/**
|
|
341
321
|
* @public
|
|
342
322
|
*/
|
|
343
|
-
export interface
|
|
323
|
+
export interface GetGroupMembershipIdResponse {
|
|
344
324
|
/**
|
|
345
325
|
* <p>The globally unique identifier for the identity store.</p>
|
|
346
326
|
* @public
|
|
@@ -352,47 +332,73 @@ export interface DescribeGroupMembershipResponse {
|
|
|
352
332
|
*/
|
|
353
333
|
MembershipId: string | undefined;
|
|
354
334
|
/**
|
|
355
|
-
* <p>The
|
|
335
|
+
* <p>The Amazon Resource Name (ARN) of the group membership in the identity store. For example, <code>arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code>.</p>
|
|
356
336
|
* @public
|
|
357
337
|
*/
|
|
358
|
-
|
|
338
|
+
MembershipArn: string | undefined;
|
|
339
|
+
}
|
|
340
|
+
/**
|
|
341
|
+
* @public
|
|
342
|
+
*/
|
|
343
|
+
export interface IsMemberInGroupsRequest {
|
|
344
|
+
/**
|
|
345
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
346
|
+
* @public
|
|
347
|
+
*/
|
|
348
|
+
IdentityStoreId: string | undefined;
|
|
359
349
|
/**
|
|
360
350
|
* <p>An object containing the identifier of a group member.</p>
|
|
361
351
|
* @public
|
|
362
352
|
*/
|
|
363
353
|
MemberId: MemberId | undefined;
|
|
364
354
|
/**
|
|
365
|
-
* <p>
|
|
355
|
+
* <p>A list of identifiers for groups in the identity store.</p> <p>You can specify each group by ID or by Amazon Resource Name (ARN). For example, group ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code> or group ARN <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
366
356
|
* @public
|
|
367
357
|
*/
|
|
368
|
-
|
|
358
|
+
GroupIds: string[] | undefined;
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* <p>Indicates whether a resource is a member of a group in the identity store.</p>
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
export interface GroupMembershipExistenceResult {
|
|
369
365
|
/**
|
|
370
|
-
* <p>The
|
|
366
|
+
* <p>The identifier for a group in the identity store.</p>
|
|
371
367
|
* @public
|
|
372
368
|
*/
|
|
373
|
-
|
|
369
|
+
GroupId?: string | undefined;
|
|
374
370
|
/**
|
|
375
|
-
* <p>
|
|
371
|
+
* <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
|
|
376
372
|
* @public
|
|
377
373
|
*/
|
|
378
|
-
|
|
374
|
+
MemberId?: MemberId | undefined;
|
|
379
375
|
/**
|
|
380
|
-
* <p>
|
|
376
|
+
* <p>Indicates whether a membership relation exists or not.</p>
|
|
381
377
|
* @public
|
|
382
378
|
*/
|
|
383
|
-
|
|
379
|
+
MembershipExists?: boolean | undefined;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
export interface IsMemberInGroupsResponse {
|
|
385
|
+
/**
|
|
386
|
+
* <p>A list containing the results of membership existence checks.</p>
|
|
387
|
+
* @public
|
|
388
|
+
*/
|
|
389
|
+
Results: GroupMembershipExistenceResult[] | undefined;
|
|
384
390
|
}
|
|
385
391
|
/**
|
|
386
392
|
* @public
|
|
387
393
|
*/
|
|
388
394
|
export interface ListGroupMembershipsRequest {
|
|
389
395
|
/**
|
|
390
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
396
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
391
397
|
* @public
|
|
392
398
|
*/
|
|
393
399
|
IdentityStoreId: string | undefined;
|
|
394
400
|
/**
|
|
395
|
-
* <p>The identifier for a group in the identity store.</p>
|
|
401
|
+
* <p>The identifier for a group in the identity store.</p> <p>You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code> or group ARN <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
396
402
|
* @public
|
|
397
403
|
*/
|
|
398
404
|
GroupId: string | undefined;
|
|
@@ -402,7 +408,7 @@ export interface ListGroupMembershipsRequest {
|
|
|
402
408
|
*/
|
|
403
409
|
MaxResults?: number | undefined;
|
|
404
410
|
/**
|
|
405
|
-
* <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code> and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to
|
|
411
|
+
* <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code> and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
|
|
406
412
|
* @public
|
|
407
413
|
*/
|
|
408
414
|
NextToken?: string | undefined;
|
|
@@ -421,7 +427,12 @@ export interface GroupMembership {
|
|
|
421
427
|
* <p>The identifier for a <code>GroupMembership</code> object in an identity store.</p>
|
|
422
428
|
* @public
|
|
423
429
|
*/
|
|
424
|
-
MembershipId
|
|
430
|
+
MembershipId: string | undefined;
|
|
431
|
+
/**
|
|
432
|
+
* <p>The Amazon Resource Name (ARN) of the group membership in the identity store. For example, <code>arn:aws:identitystore:::membership/a1b2c3d4-5678-90ab-cdef-EXAMPLE33333</code>.</p>
|
|
433
|
+
* @public
|
|
434
|
+
*/
|
|
435
|
+
MembershipArn: string | undefined;
|
|
425
436
|
/**
|
|
426
437
|
* <p>The identifier for a group in the identity store.</p>
|
|
427
438
|
* @public
|
|
@@ -463,7 +474,47 @@ export interface ListGroupMembershipsResponse {
|
|
|
463
474
|
*/
|
|
464
475
|
GroupMemberships: GroupMembership[] | undefined;
|
|
465
476
|
/**
|
|
466
|
-
* <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to
|
|
477
|
+
* <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
|
|
478
|
+
* @public
|
|
479
|
+
*/
|
|
480
|
+
NextToken?: string | undefined;
|
|
481
|
+
}
|
|
482
|
+
/**
|
|
483
|
+
* @public
|
|
484
|
+
*/
|
|
485
|
+
export interface ListGroupMembershipsForMemberRequest {
|
|
486
|
+
/**
|
|
487
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
488
|
+
* @public
|
|
489
|
+
*/
|
|
490
|
+
IdentityStoreId: string | undefined;
|
|
491
|
+
/**
|
|
492
|
+
* <p>An object that contains the identifier of a group member. Setting the <code>UserID</code> field to the specific identifier for a user indicates that the user is a member of the group.</p>
|
|
493
|
+
* @public
|
|
494
|
+
*/
|
|
495
|
+
MemberId: MemberId | undefined;
|
|
496
|
+
/**
|
|
497
|
+
* <p>The maximum number of results to be returned per request. This parameter is used in all <code>List</code> requests to specify how many results to return in one page.</p>
|
|
498
|
+
* @public
|
|
499
|
+
*/
|
|
500
|
+
MaxResults?: number | undefined;
|
|
501
|
+
/**
|
|
502
|
+
* <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
|
|
503
|
+
* @public
|
|
504
|
+
*/
|
|
505
|
+
NextToken?: string | undefined;
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* @public
|
|
509
|
+
*/
|
|
510
|
+
export interface ListGroupMembershipsForMemberResponse {
|
|
511
|
+
/**
|
|
512
|
+
* <p>A list of <code>GroupMembership</code> objects in the group for a specified member.</p>
|
|
513
|
+
* @public
|
|
514
|
+
*/
|
|
515
|
+
GroupMemberships: GroupMembership[] | undefined;
|
|
516
|
+
/**
|
|
517
|
+
* <p>The pagination token used for the <code>ListUsers</code>, <code>ListGroups</code>, and <code> ListGroupMemberships</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results. </p>
|
|
467
518
|
* @public
|
|
468
519
|
*/
|
|
469
520
|
NextToken?: string | undefined;
|
|
@@ -473,7 +524,7 @@ export interface ListGroupMembershipsResponse {
|
|
|
473
524
|
*/
|
|
474
525
|
export interface CreateGroupRequest {
|
|
475
526
|
/**
|
|
476
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
527
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
477
528
|
* @public
|
|
478
529
|
*/
|
|
479
530
|
IdentityStoreId: string | undefined;
|
|
@@ -492,31 +543,46 @@ export interface CreateGroupRequest {
|
|
|
492
543
|
* @public
|
|
493
544
|
*/
|
|
494
545
|
export interface CreateGroupResponse {
|
|
546
|
+
/**
|
|
547
|
+
* <p>The globally unique identifier for the identity store.</p>
|
|
548
|
+
* @public
|
|
549
|
+
*/
|
|
550
|
+
IdentityStoreId: string | undefined;
|
|
495
551
|
/**
|
|
496
552
|
* <p>The identifier of the newly created group in the identity store.</p>
|
|
497
553
|
* @public
|
|
498
554
|
*/
|
|
499
555
|
GroupId: string | undefined;
|
|
500
556
|
/**
|
|
501
|
-
* <p>The
|
|
557
|
+
* <p>The Amazon Resource Name (ARN) of the newly created group in the identity store. For example, <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
502
558
|
* @public
|
|
503
559
|
*/
|
|
504
|
-
|
|
560
|
+
GroupArn: string | undefined;
|
|
561
|
+
/**
|
|
562
|
+
* <p>The revision of the newly created group in the identity store.</p>
|
|
563
|
+
* @public
|
|
564
|
+
*/
|
|
565
|
+
Revision: string | undefined;
|
|
505
566
|
}
|
|
506
567
|
/**
|
|
507
568
|
* @public
|
|
508
569
|
*/
|
|
509
570
|
export interface DeleteGroupRequest {
|
|
510
571
|
/**
|
|
511
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
572
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
512
573
|
* @public
|
|
513
574
|
*/
|
|
514
575
|
IdentityStoreId: string | undefined;
|
|
515
576
|
/**
|
|
516
|
-
* <p>The identifier for a group in the identity store.</p>
|
|
577
|
+
* <p>The identifier for a group in the identity store.</p> <p>You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code> or group ARN <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
517
578
|
* @public
|
|
518
579
|
*/
|
|
519
580
|
GroupId: string | undefined;
|
|
581
|
+
/**
|
|
582
|
+
* <p>The expected current revision of the group. When you provide this value, the group is deleted only if it matches the current revision of the group in the identity store. If the value doesn't match, the operation fails with a <code>ConflictException</code>. If you don't provide this value, the group is deleted regardless of its current revision.</p>
|
|
583
|
+
* @public
|
|
584
|
+
*/
|
|
585
|
+
Revision?: string | undefined;
|
|
520
586
|
}
|
|
521
587
|
/**
|
|
522
588
|
* @public
|
|
@@ -528,12 +594,12 @@ export interface DeleteGroupResponse {
|
|
|
528
594
|
*/
|
|
529
595
|
export interface DescribeGroupRequest {
|
|
530
596
|
/**
|
|
531
|
-
* <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p>
|
|
597
|
+
* <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
532
598
|
* @public
|
|
533
599
|
*/
|
|
534
600
|
IdentityStoreId: string | undefined;
|
|
535
601
|
/**
|
|
536
|
-
* <p>The identifier for a group in the identity store.</p>
|
|
602
|
+
* <p>The identifier for a group in the identity store.</p> <p>You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code> or group ARN <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
537
603
|
* @public
|
|
538
604
|
*/
|
|
539
605
|
GroupId: string | undefined;
|
|
@@ -542,11 +608,26 @@ export interface DescribeGroupRequest {
|
|
|
542
608
|
* @public
|
|
543
609
|
*/
|
|
544
610
|
export interface DescribeGroupResponse {
|
|
611
|
+
/**
|
|
612
|
+
* <p>The globally unique identifier for the identity store.</p>
|
|
613
|
+
* @public
|
|
614
|
+
*/
|
|
615
|
+
IdentityStoreId: string | undefined;
|
|
545
616
|
/**
|
|
546
617
|
* <p>The identifier for a group in the identity store.</p>
|
|
547
618
|
* @public
|
|
548
619
|
*/
|
|
549
620
|
GroupId: string | undefined;
|
|
621
|
+
/**
|
|
622
|
+
* <p>The Amazon Resource Name (ARN) of the group in the identity store. For example, <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
623
|
+
* @public
|
|
624
|
+
*/
|
|
625
|
+
GroupArn: string | undefined;
|
|
626
|
+
/**
|
|
627
|
+
* <p>The current revision of the group in the identity store. This value changes each time the group is modified.</p>
|
|
628
|
+
* @public
|
|
629
|
+
*/
|
|
630
|
+
Revision: string | undefined;
|
|
550
631
|
/**
|
|
551
632
|
* <p>The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.</p>
|
|
552
633
|
* @public
|
|
@@ -582,11 +663,41 @@ export interface DescribeGroupResponse {
|
|
|
582
663
|
* @public
|
|
583
664
|
*/
|
|
584
665
|
UpdatedBy?: string | undefined;
|
|
666
|
+
}
|
|
667
|
+
/**
|
|
668
|
+
* @public
|
|
669
|
+
*/
|
|
670
|
+
export interface GetGroupIdRequest {
|
|
671
|
+
/**
|
|
672
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
673
|
+
* @public
|
|
674
|
+
*/
|
|
675
|
+
IdentityStoreId: string | undefined;
|
|
676
|
+
/**
|
|
677
|
+
* <p>A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid path is <code> displayName</code>.</p>
|
|
678
|
+
* @public
|
|
679
|
+
*/
|
|
680
|
+
AlternateIdentifier: AlternateIdentifier | undefined;
|
|
681
|
+
}
|
|
682
|
+
/**
|
|
683
|
+
* @public
|
|
684
|
+
*/
|
|
685
|
+
export interface GetGroupIdResponse {
|
|
585
686
|
/**
|
|
586
687
|
* <p>The globally unique identifier for the identity store.</p>
|
|
587
688
|
* @public
|
|
588
689
|
*/
|
|
589
690
|
IdentityStoreId: string | undefined;
|
|
691
|
+
/**
|
|
692
|
+
* <p>The identifier for a group in the identity store.</p>
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
GroupId: string | undefined;
|
|
696
|
+
/**
|
|
697
|
+
* <p>The Amazon Resource Name (ARN) of the group in the identity store. For example, <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
698
|
+
* @public
|
|
699
|
+
*/
|
|
700
|
+
GroupArn: string | undefined;
|
|
590
701
|
}
|
|
591
702
|
/**
|
|
592
703
|
* <p>A query filter used by <code>ListUsers</code> and <code>ListGroups</code>. This filter object provides the attribute name and attribute value to search users or groups.</p>
|
|
@@ -609,17 +720,17 @@ export interface Filter {
|
|
|
609
720
|
*/
|
|
610
721
|
export interface ListGroupsRequest {
|
|
611
722
|
/**
|
|
612
|
-
* <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p>
|
|
723
|
+
* <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
613
724
|
* @public
|
|
614
725
|
*/
|
|
615
726
|
IdentityStoreId: string | undefined;
|
|
616
727
|
/**
|
|
617
|
-
* <p>The maximum number of results to be returned per request. This parameter is used in
|
|
728
|
+
* <p>The maximum number of results to be returned per request. This parameter is used in all <code>List</code> requests to specify how many results to return in one page.</p>
|
|
618
729
|
* @public
|
|
619
730
|
*/
|
|
620
731
|
MaxResults?: number | undefined;
|
|
621
732
|
/**
|
|
622
|
-
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to
|
|
733
|
+
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
|
|
623
734
|
* @public
|
|
624
735
|
*/
|
|
625
736
|
NextToken?: string | undefined;
|
|
@@ -636,11 +747,26 @@ export interface ListGroupsRequest {
|
|
|
636
747
|
* @public
|
|
637
748
|
*/
|
|
638
749
|
export interface Group {
|
|
750
|
+
/**
|
|
751
|
+
* <p>The globally unique identifier for the identity store.</p>
|
|
752
|
+
* @public
|
|
753
|
+
*/
|
|
754
|
+
IdentityStoreId: string | undefined;
|
|
639
755
|
/**
|
|
640
756
|
* <p>The identifier for a group in the identity store.</p>
|
|
641
757
|
* @public
|
|
642
758
|
*/
|
|
643
759
|
GroupId: string | undefined;
|
|
760
|
+
/**
|
|
761
|
+
* <p>The Amazon Resource Name (ARN) of the group in the identity store. For example, <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
762
|
+
* @public
|
|
763
|
+
*/
|
|
764
|
+
GroupArn: string | undefined;
|
|
765
|
+
/**
|
|
766
|
+
* <p>The current revision of the group in the identity store. This value changes each time the group is modified. You can provide it as the <code>Revision</code> parameter of an <code>UpdateGroup</code> or <code>DeleteGroup</code> request to make the operation conditional on the group not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.</p>
|
|
767
|
+
* @public
|
|
768
|
+
*/
|
|
769
|
+
Revision: string | undefined;
|
|
644
770
|
/**
|
|
645
771
|
* <p>The display name value for the group. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.</p> <p>Prefix search supports a maximum of 1,000 characters for the string.</p>
|
|
646
772
|
* @public
|
|
@@ -676,11 +802,6 @@ export interface Group {
|
|
|
676
802
|
* @public
|
|
677
803
|
*/
|
|
678
804
|
UpdatedBy?: string | undefined;
|
|
679
|
-
/**
|
|
680
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
681
|
-
* @public
|
|
682
|
-
*/
|
|
683
|
-
IdentityStoreId: string | undefined;
|
|
684
805
|
}
|
|
685
806
|
/**
|
|
686
807
|
* @public
|
|
@@ -692,7 +813,7 @@ export interface ListGroupsResponse {
|
|
|
692
813
|
*/
|
|
693
814
|
Groups: Group[] | undefined;
|
|
694
815
|
/**
|
|
695
|
-
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to
|
|
816
|
+
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
|
|
696
817
|
* @public
|
|
697
818
|
*/
|
|
698
819
|
NextToken?: string | undefined;
|
|
@@ -702,12 +823,12 @@ export interface ListGroupsResponse {
|
|
|
702
823
|
*/
|
|
703
824
|
export interface UpdateGroupRequest {
|
|
704
825
|
/**
|
|
705
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
826
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
706
827
|
* @public
|
|
707
828
|
*/
|
|
708
829
|
IdentityStoreId: string | undefined;
|
|
709
830
|
/**
|
|
710
|
-
* <p>The identifier for a group in the identity store.</p>
|
|
831
|
+
* <p>The identifier for a group in the identity store.</p> <p>You can specify the group by ID or by Amazon Resource Name (ARN). For example, group ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code> or group ARN <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
711
832
|
* @public
|
|
712
833
|
*/
|
|
713
834
|
GroupId: string | undefined;
|
|
@@ -716,102 +837,194 @@ export interface UpdateGroupRequest {
|
|
|
716
837
|
* @public
|
|
717
838
|
*/
|
|
718
839
|
Operations: AttributeOperation[] | undefined;
|
|
840
|
+
/**
|
|
841
|
+
* <p>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 <code>ConflictException</code>. If you don't provide this value, the update is applied unconditionally.</p>
|
|
842
|
+
* @public
|
|
843
|
+
*/
|
|
844
|
+
Revision?: string | undefined;
|
|
719
845
|
}
|
|
720
846
|
/**
|
|
721
847
|
* @public
|
|
722
848
|
*/
|
|
723
849
|
export interface UpdateGroupResponse {
|
|
850
|
+
/**
|
|
851
|
+
* <p>The globally unique identifier for the identity store.</p>
|
|
852
|
+
* @public
|
|
853
|
+
*/
|
|
854
|
+
IdentityStoreId: string | undefined;
|
|
855
|
+
/**
|
|
856
|
+
* <p>The identifier for a group in the identity store.</p>
|
|
857
|
+
* @public
|
|
858
|
+
*/
|
|
859
|
+
GroupId: string | undefined;
|
|
860
|
+
/**
|
|
861
|
+
* <p>The Amazon Resource Name (ARN) of the group in the identity store. For example, <code>arn:aws:identitystore:::group/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222</code>.</p>
|
|
862
|
+
* @public
|
|
863
|
+
*/
|
|
864
|
+
GroupArn: string | undefined;
|
|
865
|
+
/**
|
|
866
|
+
* <p>The revision of the group after the requested update is applied.</p>
|
|
867
|
+
* @public
|
|
868
|
+
*/
|
|
869
|
+
Revision: string | undefined;
|
|
724
870
|
}
|
|
725
871
|
/**
|
|
726
872
|
* @public
|
|
727
873
|
*/
|
|
728
|
-
export interface
|
|
874
|
+
export interface DescribeIdentityStoreRequest {
|
|
729
875
|
/**
|
|
730
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
876
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
731
877
|
* @public
|
|
732
878
|
*/
|
|
733
879
|
IdentityStoreId: string | undefined;
|
|
880
|
+
}
|
|
881
|
+
/**
|
|
882
|
+
* <p>The network configuration that controls how an identity store can be accessed. This object is returned as part of service API responses.</p>
|
|
883
|
+
* @public
|
|
884
|
+
*/
|
|
885
|
+
export interface NetworkConfigurationDetails {
|
|
734
886
|
/**
|
|
735
|
-
* <p>
|
|
887
|
+
* <p>Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to <code>true</code>, requests must originate from a VPC endpoint.</p>
|
|
736
888
|
* @public
|
|
737
889
|
*/
|
|
738
|
-
|
|
890
|
+
VpceAccessRequired: boolean | undefined;
|
|
739
891
|
/**
|
|
740
|
-
* <p>A list of
|
|
892
|
+
* <p>A list of virtual private cloud (VPC) IDs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in <code>ApiAllowSourceIps</code> if one is configured. If this field is empty, access isn't restricted to specific VPCs, but the VPC endpoint requirement from <code>VpceAccessRequired</code> still applies.</p>
|
|
741
893
|
* @public
|
|
742
894
|
*/
|
|
743
|
-
|
|
895
|
+
ApiRestrictSourceVpcs?: string[] | undefined;
|
|
896
|
+
/**
|
|
897
|
+
* <p>A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store's other API network controls: it's permitted even if it doesn't come through a VPC endpoint required by <code>VpceAccessRequired</code>, and even if it doesn't originate from a VPC in <code>ApiRestrictSourceVpcs</code>. If this field is empty, no such IP address exception applies.</p>
|
|
898
|
+
* @public
|
|
899
|
+
*/
|
|
900
|
+
ApiAllowSourceIps?: string[] | undefined;
|
|
901
|
+
/**
|
|
902
|
+
* <p>A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If this field is empty, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement.</p>
|
|
903
|
+
* @public
|
|
904
|
+
*/
|
|
905
|
+
ScimAllowSourceIps?: string[] | undefined;
|
|
744
906
|
}
|
|
745
907
|
/**
|
|
746
|
-
* <p>Indicates whether a resource is a member of a group in the identity store.</p>
|
|
747
908
|
* @public
|
|
748
909
|
*/
|
|
749
|
-
export interface
|
|
910
|
+
export interface DescribeIdentityStoreResponse {
|
|
750
911
|
/**
|
|
751
|
-
* <p>The identifier for
|
|
912
|
+
* <p>The globally unique identifier for the identity store.</p>
|
|
752
913
|
* @public
|
|
753
914
|
*/
|
|
754
|
-
|
|
915
|
+
IdentityStoreId: string | undefined;
|
|
755
916
|
/**
|
|
756
|
-
* <p>
|
|
917
|
+
* <p>The Amazon Resource Name (ARN) of the identity store. For example, <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
757
918
|
* @public
|
|
758
919
|
*/
|
|
759
|
-
|
|
920
|
+
IdentityStoreArn: string | undefined;
|
|
760
921
|
/**
|
|
761
|
-
* <p>
|
|
922
|
+
* <p>The network configuration of the identity store. This configuration controls whether access through a virtual private cloud (VPC) endpoint is required, and which source VPCs and IP addresses are allowed.</p>
|
|
762
923
|
* @public
|
|
763
924
|
*/
|
|
764
|
-
|
|
925
|
+
NetworkConfiguration?: NetworkConfigurationDetails | undefined;
|
|
765
926
|
}
|
|
766
927
|
/**
|
|
767
928
|
* @public
|
|
768
929
|
*/
|
|
769
|
-
export interface
|
|
930
|
+
export interface ListIdentityStoresRequest {
|
|
770
931
|
/**
|
|
771
|
-
* <p>
|
|
932
|
+
* <p>The maximum number of results to return per request. This parameter is used in all <code> List</code> operations to specify how many results to return on one page. If you don't specify a value, the operation uses a default page size.</p>
|
|
772
933
|
* @public
|
|
773
934
|
*/
|
|
774
|
-
|
|
935
|
+
MaxResults?: number | undefined;
|
|
936
|
+
/**
|
|
937
|
+
* <p>The pagination token used for the <code>ListIdentityStores</code> API operation. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
|
|
938
|
+
* @public
|
|
939
|
+
*/
|
|
940
|
+
NextToken?: string | undefined;
|
|
775
941
|
}
|
|
776
942
|
/**
|
|
943
|
+
* <p>A structure that contains the identifiers for an identity store: its globally unique identifier (ID) and Amazon Resource Name (ARN).</p>
|
|
777
944
|
* @public
|
|
778
945
|
*/
|
|
779
|
-
export interface
|
|
946
|
+
export interface IdentityStore {
|
|
780
947
|
/**
|
|
781
948
|
* <p>The globally unique identifier for the identity store.</p>
|
|
782
949
|
* @public
|
|
783
950
|
*/
|
|
784
951
|
IdentityStoreId: string | undefined;
|
|
785
952
|
/**
|
|
786
|
-
* <p>
|
|
953
|
+
* <p>The Amazon Resource Name (ARN) of the identity store. For example, <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
787
954
|
* @public
|
|
788
955
|
*/
|
|
789
|
-
|
|
956
|
+
IdentityStoreArn: string | undefined;
|
|
957
|
+
}
|
|
958
|
+
/**
|
|
959
|
+
* @public
|
|
960
|
+
*/
|
|
961
|
+
export interface ListIdentityStoresResponse {
|
|
790
962
|
/**
|
|
791
|
-
* <p>
|
|
963
|
+
* <p>A list of <code>IdentityStore</code> objects, each of which contains the identifiers for an identity store that you have access to.</p>
|
|
792
964
|
* @public
|
|
793
965
|
*/
|
|
794
|
-
|
|
966
|
+
IdentityStores: IdentityStore[] | undefined;
|
|
795
967
|
/**
|
|
796
|
-
* <p>The pagination token used for the <code>
|
|
968
|
+
* <p>The pagination token used for the <code>ListIdentityStores</code> API operation. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
|
|
797
969
|
* @public
|
|
798
970
|
*/
|
|
799
971
|
NextToken?: string | undefined;
|
|
800
972
|
}
|
|
801
973
|
/**
|
|
974
|
+
* <p>The network configuration that controls how an identity store can be accessed. You provide this object in a request.</p>
|
|
802
975
|
* @public
|
|
803
976
|
*/
|
|
804
|
-
export interface
|
|
977
|
+
export interface NetworkConfiguration {
|
|
805
978
|
/**
|
|
806
|
-
* <p>
|
|
979
|
+
* <p>Specifies whether the identity store can be accessed only through a virtual private cloud (VPC) endpoint. When set to <code>true</code>, requests must originate from a VPC endpoint.</p> <p>This value must be set to either <code>true</code> or <code>false</code> when you provide <code>NetworkConfiguration</code> in a request.</p>
|
|
807
980
|
* @public
|
|
808
981
|
*/
|
|
809
|
-
|
|
982
|
+
VpceAccessRequired: boolean | undefined;
|
|
810
983
|
/**
|
|
811
|
-
* <p>
|
|
984
|
+
* <p>A list of virtual private cloud (VPC) IDs that are allowed to access the identity store API operations. A request is denied unless it originates from a VPC in this list, or from an IP address in <code>ApiAllowSourceIps</code> if you specified one. If you don't specify a value, access isn't restricted to specific VPCs, but the VPC endpoint requirement set by <code>VpceAccessRequired</code> still applies.</p>
|
|
812
985
|
* @public
|
|
813
986
|
*/
|
|
814
|
-
|
|
987
|
+
ApiRestrictSourceVpcs?: string[] | undefined;
|
|
988
|
+
/**
|
|
989
|
+
* <p>A list of IP address CIDR ranges that are allowed to access the identity store API operations. A request from an IP address in this list bypasses the identity store's other API network controls: it's permitted even if it doesn't come through a VPC endpoint required by <code>VpceAccessRequired</code>, and even if it doesn't originate from a VPC in <code>ApiRestrictSourceVpcs</code>. If you don't specify a value, no such IP address exception applies.</p>
|
|
990
|
+
* @public
|
|
991
|
+
*/
|
|
992
|
+
ApiAllowSourceIps?: string[] | undefined;
|
|
993
|
+
/**
|
|
994
|
+
* <p>A list of IP address CIDR ranges that are allowed to access the identity store through the System for Cross-domain Identity Management (SCIM) protocol. Requests from IP addresses outside these ranges are denied. If you don't specify a value, SCIM requests remain subject to the identity store's other network controls, such as the VPC endpoint requirement set by <code>VpceAccessRequired</code>.</p> <p>For example, to allow SCIM traffic from the public internet while still requiring the identity store API operations to be accessed through a VPC endpoint, set <code>VpceAccessRequired</code> to <code>true</code> and set this value to <code>0.0.0.0/0</code>.</p>
|
|
995
|
+
* @public
|
|
996
|
+
*/
|
|
997
|
+
ScimAllowSourceIps?: string[] | undefined;
|
|
998
|
+
}
|
|
999
|
+
/**
|
|
1000
|
+
* @public
|
|
1001
|
+
*/
|
|
1002
|
+
export interface UpdateIdentityStoreRequest {
|
|
1003
|
+
/**
|
|
1004
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
1005
|
+
* @public
|
|
1006
|
+
*/
|
|
1007
|
+
IdentityStoreId: string | undefined;
|
|
1008
|
+
/**
|
|
1009
|
+
* <p>The network configuration to apply to the identity store. This controls whether access through a virtual private cloud (VPC) endpoint is required and the source VPCs and IP addresses that are allowed to access the identity store.</p> <p>When you provide <code>NetworkConfiguration</code> in a request, the service performs a full replacement of the identity store's current network configuration with the values you specify. Any values that you omit are cleared. To preserve or change the allowed source VPCs or IP address ranges, include the complete set of values that you want in the request. To clear a list, omit it; an empty list is not accepted.</p>
|
|
1010
|
+
* @public
|
|
1011
|
+
*/
|
|
1012
|
+
NetworkConfiguration?: NetworkConfiguration | undefined;
|
|
1013
|
+
}
|
|
1014
|
+
/**
|
|
1015
|
+
* @public
|
|
1016
|
+
*/
|
|
1017
|
+
export interface UpdateIdentityStoreResponse {
|
|
1018
|
+
/**
|
|
1019
|
+
* <p>The globally unique identifier for the identity store.</p>
|
|
1020
|
+
* @public
|
|
1021
|
+
*/
|
|
1022
|
+
IdentityStoreId: string | undefined;
|
|
1023
|
+
/**
|
|
1024
|
+
* <p>The Amazon Resource Name (ARN) of the identity store. For example, <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
1025
|
+
* @public
|
|
1026
|
+
*/
|
|
1027
|
+
IdentityStoreArn: string | undefined;
|
|
815
1028
|
}
|
|
816
1029
|
/**
|
|
817
1030
|
* <p>The email address associated with the user.</p>
|
|
@@ -876,7 +1089,7 @@ export interface Name {
|
|
|
876
1089
|
*/
|
|
877
1090
|
export interface PhoneNumber {
|
|
878
1091
|
/**
|
|
879
|
-
* <p>A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567"
|
|
1092
|
+
* <p>A string containing a phone number. For example, "8675309" or "+1 (800) 123-4567".</p>
|
|
880
1093
|
* @public
|
|
881
1094
|
*/
|
|
882
1095
|
Value?: string | undefined;
|
|
@@ -943,7 +1156,7 @@ export interface Role {
|
|
|
943
1156
|
*/
|
|
944
1157
|
export interface CreateUserRequest {
|
|
945
1158
|
/**
|
|
946
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
1159
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
947
1160
|
* @public
|
|
948
1161
|
*/
|
|
949
1162
|
IdentityStoreId: string | undefined;
|
|
@@ -1052,21 +1265,36 @@ export interface CreateUserResponse {
|
|
|
1052
1265
|
* @public
|
|
1053
1266
|
*/
|
|
1054
1267
|
UserId: string | undefined;
|
|
1268
|
+
/**
|
|
1269
|
+
* <p>The Amazon Resource Name (ARN) of the newly created user in the identity store. For example, <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
1270
|
+
* @public
|
|
1271
|
+
*/
|
|
1272
|
+
UserArn: string | undefined;
|
|
1273
|
+
/**
|
|
1274
|
+
* <p>The revision of the newly created user in the identity store.</p>
|
|
1275
|
+
* @public
|
|
1276
|
+
*/
|
|
1277
|
+
Revision: string | undefined;
|
|
1055
1278
|
}
|
|
1056
1279
|
/**
|
|
1057
1280
|
* @public
|
|
1058
1281
|
*/
|
|
1059
1282
|
export interface DeleteUserRequest {
|
|
1060
1283
|
/**
|
|
1061
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
1284
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
1062
1285
|
* @public
|
|
1063
1286
|
*/
|
|
1064
1287
|
IdentityStoreId: string | undefined;
|
|
1065
1288
|
/**
|
|
1066
|
-
* <p>The identifier for a user in the identity store.</p>
|
|
1289
|
+
* <p>The identifier for a user in the identity store.</p> <p>You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code> or user ARN <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
1067
1290
|
* @public
|
|
1068
1291
|
*/
|
|
1069
1292
|
UserId: string | undefined;
|
|
1293
|
+
/**
|
|
1294
|
+
* <p>The expected current revision of the user. When you provide this value, the user is deleted only if it matches the current revision of the user in the identity store. If the value doesn't match, the operation fails with a <code>ConflictException</code>. If you don't provide this value, the user is deleted regardless of its current revision.</p>
|
|
1295
|
+
* @public
|
|
1296
|
+
*/
|
|
1297
|
+
Revision?: string | undefined;
|
|
1070
1298
|
}
|
|
1071
1299
|
/**
|
|
1072
1300
|
* @public
|
|
@@ -1078,12 +1306,12 @@ export interface DeleteUserResponse {
|
|
|
1078
1306
|
*/
|
|
1079
1307
|
export interface DescribeUserRequest {
|
|
1080
1308
|
/**
|
|
1081
|
-
* <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p>
|
|
1309
|
+
* <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
1082
1310
|
* @public
|
|
1083
1311
|
*/
|
|
1084
1312
|
IdentityStoreId: string | undefined;
|
|
1085
1313
|
/**
|
|
1086
|
-
* <p>The identifier for a user in the identity store.</p>
|
|
1314
|
+
* <p>The identifier for a user in the identity store.</p> <p>You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code> or user ARN <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
1087
1315
|
* @public
|
|
1088
1316
|
*/
|
|
1089
1317
|
UserId: string | undefined;
|
|
@@ -1107,6 +1335,16 @@ export interface DescribeUserResponse {
|
|
|
1107
1335
|
* @public
|
|
1108
1336
|
*/
|
|
1109
1337
|
UserId: string | undefined;
|
|
1338
|
+
/**
|
|
1339
|
+
* <p>The Amazon Resource Name (ARN) of the user in the identity store. For example, <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
1340
|
+
* @public
|
|
1341
|
+
*/
|
|
1342
|
+
UserArn: string | undefined;
|
|
1343
|
+
/**
|
|
1344
|
+
* <p>The current revision of the user in the identity store. This value changes each time the user is modified.</p>
|
|
1345
|
+
* @public
|
|
1346
|
+
*/
|
|
1347
|
+
Revision: string | undefined;
|
|
1110
1348
|
/**
|
|
1111
1349
|
* <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.</p>
|
|
1112
1350
|
* @public
|
|
@@ -1228,12 +1466,47 @@ export interface DescribeUserResponse {
|
|
|
1228
1466
|
*/
|
|
1229
1467
|
Extensions?: Record<string, __DocumentType> | undefined;
|
|
1230
1468
|
}
|
|
1469
|
+
/**
|
|
1470
|
+
* @public
|
|
1471
|
+
*/
|
|
1472
|
+
export interface GetUserIdRequest {
|
|
1473
|
+
/**
|
|
1474
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
1475
|
+
* @public
|
|
1476
|
+
*/
|
|
1477
|
+
IdentityStoreId: string | undefined;
|
|
1478
|
+
/**
|
|
1479
|
+
* <p>A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For the unique attribute, the only valid paths are <code> userName</code> and <code>emails.value</code>.</p>
|
|
1480
|
+
* @public
|
|
1481
|
+
*/
|
|
1482
|
+
AlternateIdentifier: AlternateIdentifier | undefined;
|
|
1483
|
+
}
|
|
1484
|
+
/**
|
|
1485
|
+
* @public
|
|
1486
|
+
*/
|
|
1487
|
+
export interface GetUserIdResponse {
|
|
1488
|
+
/**
|
|
1489
|
+
* <p>The globally unique identifier for the identity store.</p>
|
|
1490
|
+
* @public
|
|
1491
|
+
*/
|
|
1492
|
+
IdentityStoreId: string | undefined;
|
|
1493
|
+
/**
|
|
1494
|
+
* <p>The identifier for a user in the identity store.</p>
|
|
1495
|
+
* @public
|
|
1496
|
+
*/
|
|
1497
|
+
UserId: string | undefined;
|
|
1498
|
+
/**
|
|
1499
|
+
* <p>The Amazon Resource Name (ARN) of the user in the identity store. For example, <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
1500
|
+
* @public
|
|
1501
|
+
*/
|
|
1502
|
+
UserArn: string | undefined;
|
|
1503
|
+
}
|
|
1231
1504
|
/**
|
|
1232
1505
|
* @public
|
|
1233
1506
|
*/
|
|
1234
1507
|
export interface ListUsersRequest {
|
|
1235
1508
|
/**
|
|
1236
|
-
* <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p>
|
|
1509
|
+
* <p>The globally unique identifier for the identity store, such as <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and <code>1234567890</code> is a randomly generated string that contains numbers and lower case letters. This value is generated at the time that a new identity store is created.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
1237
1510
|
* @public
|
|
1238
1511
|
*/
|
|
1239
1512
|
IdentityStoreId: string | undefined;
|
|
@@ -1243,19 +1516,19 @@ export interface ListUsersRequest {
|
|
|
1243
1516
|
*/
|
|
1244
1517
|
Extensions?: string[] | undefined;
|
|
1245
1518
|
/**
|
|
1246
|
-
* <p>The maximum number of results to be returned per request. This parameter is used in
|
|
1519
|
+
* <p>The maximum number of results to be returned per request. This parameter is used in all <code>List</code> requests to specify how many results to return in one page.</p>
|
|
1247
1520
|
* @public
|
|
1248
1521
|
*/
|
|
1249
1522
|
MaxResults?: number | undefined;
|
|
1250
1523
|
/**
|
|
1251
|
-
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to
|
|
1524
|
+
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
|
|
1252
1525
|
* @public
|
|
1253
1526
|
*/
|
|
1254
1527
|
NextToken?: string | undefined;
|
|
1255
1528
|
/**
|
|
1256
1529
|
* <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and <code> ListGroups</code> requests. </p>
|
|
1257
1530
|
*
|
|
1258
|
-
* @deprecated Using filters with ListUsers API is deprecated, please use
|
|
1531
|
+
* @deprecated Using filters with ListUsers API is deprecated, please use GetUserId API instead.
|
|
1259
1532
|
* @public
|
|
1260
1533
|
*/
|
|
1261
1534
|
Filters?: Filter[] | undefined;
|
|
@@ -1275,6 +1548,16 @@ export interface User {
|
|
|
1275
1548
|
* @public
|
|
1276
1549
|
*/
|
|
1277
1550
|
UserId: string | undefined;
|
|
1551
|
+
/**
|
|
1552
|
+
* <p>The Amazon Resource Name (ARN) of the user in the identity store. For example, <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
1553
|
+
* @public
|
|
1554
|
+
*/
|
|
1555
|
+
UserArn: string | undefined;
|
|
1556
|
+
/**
|
|
1557
|
+
* <p>The current revision of the user in the identity store. This value changes each time the user is modified. You can provide it as the <code>Revision</code> parameter of an <code>UpdateUser</code> or <code>DeleteUser</code> request to make the operation conditional on the user not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.</p>
|
|
1558
|
+
* @public
|
|
1559
|
+
*/
|
|
1560
|
+
Revision: string | undefined;
|
|
1278
1561
|
/**
|
|
1279
1562
|
* <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.</p>
|
|
1280
1563
|
* @public
|
|
@@ -1406,7 +1689,7 @@ export interface ListUsersResponse {
|
|
|
1406
1689
|
*/
|
|
1407
1690
|
Users: User[] | undefined;
|
|
1408
1691
|
/**
|
|
1409
|
-
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to
|
|
1692
|
+
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to retrieve the next page of results.</p>
|
|
1410
1693
|
* @public
|
|
1411
1694
|
*/
|
|
1412
1695
|
NextToken?: string | undefined;
|
|
@@ -1416,12 +1699,12 @@ export interface ListUsersResponse {
|
|
|
1416
1699
|
*/
|
|
1417
1700
|
export interface UpdateUserRequest {
|
|
1418
1701
|
/**
|
|
1419
|
-
* <p>The globally unique identifier for the identity store.</p>
|
|
1702
|
+
* <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
|
|
1420
1703
|
* @public
|
|
1421
1704
|
*/
|
|
1422
1705
|
IdentityStoreId: string | undefined;
|
|
1423
1706
|
/**
|
|
1424
|
-
* <p>The identifier for a user in the identity store.</p>
|
|
1707
|
+
* <p>The identifier for a user in the identity store.</p> <p>You can specify the user by ID or by Amazon Resource Name (ARN). For example, user ID <code>a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code> or user ARN <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
1425
1708
|
* @public
|
|
1426
1709
|
*/
|
|
1427
1710
|
UserId: string | undefined;
|
|
@@ -1430,9 +1713,34 @@ export interface UpdateUserRequest {
|
|
|
1430
1713
|
* @public
|
|
1431
1714
|
*/
|
|
1432
1715
|
Operations: AttributeOperation[] | undefined;
|
|
1716
|
+
/**
|
|
1717
|
+
* <p>The expected current revision of the user. When you provide this value, the update is applied only if it matches the current revision of the user in the identity store, which prevents you from overwriting concurrent changes. If the value doesn't match, the operation fails with a <code>ConflictException</code>. If you don't provide this value, the update is applied unconditionally.</p>
|
|
1718
|
+
* @public
|
|
1719
|
+
*/
|
|
1720
|
+
Revision?: string | undefined;
|
|
1433
1721
|
}
|
|
1434
1722
|
/**
|
|
1435
1723
|
* @public
|
|
1436
1724
|
*/
|
|
1437
1725
|
export interface UpdateUserResponse {
|
|
1726
|
+
/**
|
|
1727
|
+
* <p>The globally unique identifier for the identity store.</p>
|
|
1728
|
+
* @public
|
|
1729
|
+
*/
|
|
1730
|
+
IdentityStoreId: string | undefined;
|
|
1731
|
+
/**
|
|
1732
|
+
* <p>The identifier for a user in the identity store.</p>
|
|
1733
|
+
* @public
|
|
1734
|
+
*/
|
|
1735
|
+
UserId: string | undefined;
|
|
1736
|
+
/**
|
|
1737
|
+
* <p>The Amazon Resource Name (ARN) of the user in the identity store. For example, <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>
|
|
1738
|
+
* @public
|
|
1739
|
+
*/
|
|
1740
|
+
UserArn: string | undefined;
|
|
1741
|
+
/**
|
|
1742
|
+
* <p>The revision of the user after the requested update is applied.</p>
|
|
1743
|
+
* @public
|
|
1744
|
+
*/
|
|
1745
|
+
Revision: string | undefined;
|
|
1438
1746
|
}
|