@aws-sdk/client-identitystore 3.379.1 → 3.385.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/dist-types/models/models_0.d.ts +187 -0
- package/package.json +5 -5
|
@@ -10,6 +10,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
10
10
|
readonly $fault: "client";
|
|
11
11
|
Message?: string;
|
|
12
12
|
/**
|
|
13
|
+
* @public
|
|
13
14
|
* <p>The identifier for each request. This value is a globally unique ID that is generated by
|
|
14
15
|
* the identity store service for each sent request, and is then returned inside the exception
|
|
15
16
|
* if the request fails.</p>
|
|
@@ -26,38 +27,46 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
26
27
|
*/
|
|
27
28
|
export interface Address {
|
|
28
29
|
/**
|
|
30
|
+
* @public
|
|
29
31
|
* <p>The
|
|
30
32
|
* street
|
|
31
33
|
* of the address.</p>
|
|
32
34
|
*/
|
|
33
35
|
StreetAddress?: string;
|
|
34
36
|
/**
|
|
37
|
+
* @public
|
|
35
38
|
* <p>A string of the address locality.</p>
|
|
36
39
|
*/
|
|
37
40
|
Locality?: string;
|
|
38
41
|
/**
|
|
42
|
+
* @public
|
|
39
43
|
* <p>The
|
|
40
44
|
* region
|
|
41
45
|
* of the address.</p>
|
|
42
46
|
*/
|
|
43
47
|
Region?: string;
|
|
44
48
|
/**
|
|
49
|
+
* @public
|
|
45
50
|
* <p>The postal code of the address.</p>
|
|
46
51
|
*/
|
|
47
52
|
PostalCode?: string;
|
|
48
53
|
/**
|
|
54
|
+
* @public
|
|
49
55
|
* <p>The country of the address.</p>
|
|
50
56
|
*/
|
|
51
57
|
Country?: string;
|
|
52
58
|
/**
|
|
59
|
+
* @public
|
|
53
60
|
* <p>A string containing a formatted version of the address for display.</p>
|
|
54
61
|
*/
|
|
55
62
|
Formatted?: string;
|
|
56
63
|
/**
|
|
64
|
+
* @public
|
|
57
65
|
* <p>A string representing the type of address. For example, "Home."</p>
|
|
58
66
|
*/
|
|
59
67
|
Type?: string;
|
|
60
68
|
/**
|
|
69
|
+
* @public
|
|
61
70
|
* <p>A Boolean value representing whether this is the primary address for the associated
|
|
62
71
|
* resource.</p>
|
|
63
72
|
*/
|
|
@@ -69,10 +78,12 @@ export interface Address {
|
|
|
69
78
|
*/
|
|
70
79
|
export interface ExternalId {
|
|
71
80
|
/**
|
|
81
|
+
* @public
|
|
72
82
|
* <p>The issuer for an external identifier.</p>
|
|
73
83
|
*/
|
|
74
84
|
Issuer: string | undefined;
|
|
75
85
|
/**
|
|
86
|
+
* @public
|
|
76
87
|
* <p>The identifier issued to this resource by an external identity provider.</p>
|
|
77
88
|
*/
|
|
78
89
|
Id: string | undefined;
|
|
@@ -83,11 +94,13 @@ export interface ExternalId {
|
|
|
83
94
|
*/
|
|
84
95
|
export interface UniqueAttribute {
|
|
85
96
|
/**
|
|
97
|
+
* @public
|
|
86
98
|
* <p>A string representation of the path to a given attribute or sub-attribute. Supports
|
|
87
99
|
* JMESPath.</p>
|
|
88
100
|
*/
|
|
89
101
|
AttributePath: string | undefined;
|
|
90
102
|
/**
|
|
103
|
+
* @public
|
|
91
104
|
* <p>The value of the attribute. This is a <code>Document</code> type.
|
|
92
105
|
* This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.</p>
|
|
93
106
|
*/
|
|
@@ -104,6 +117,7 @@ export type AlternateIdentifier = AlternateIdentifier.ExternalIdMember | Alterna
|
|
|
104
117
|
*/
|
|
105
118
|
export declare namespace AlternateIdentifier {
|
|
106
119
|
/**
|
|
120
|
+
* @public
|
|
107
121
|
* <p>The identifier issued to this resource by an external identity provider.</p>
|
|
108
122
|
*/
|
|
109
123
|
interface ExternalIdMember {
|
|
@@ -112,6 +126,7 @@ export declare namespace AlternateIdentifier {
|
|
|
112
126
|
$unknown?: never;
|
|
113
127
|
}
|
|
114
128
|
/**
|
|
129
|
+
* @public
|
|
115
130
|
* <p>An entity attribute that's unique to a specific entity.</p>
|
|
116
131
|
*/
|
|
117
132
|
interface UniqueAttributeMember {
|
|
@@ -119,6 +134,9 @@ export declare namespace AlternateIdentifier {
|
|
|
119
134
|
UniqueAttribute: UniqueAttribute;
|
|
120
135
|
$unknown?: never;
|
|
121
136
|
}
|
|
137
|
+
/**
|
|
138
|
+
* @public
|
|
139
|
+
*/
|
|
122
140
|
interface $UnknownMember {
|
|
123
141
|
ExternalId?: never;
|
|
124
142
|
UniqueAttribute?: never;
|
|
@@ -137,11 +155,13 @@ export declare namespace AlternateIdentifier {
|
|
|
137
155
|
*/
|
|
138
156
|
export interface AttributeOperation {
|
|
139
157
|
/**
|
|
158
|
+
* @public
|
|
140
159
|
* <p>A string representation of the path to a given attribute or sub-attribute. Supports
|
|
141
160
|
* JMESPath.</p>
|
|
142
161
|
*/
|
|
143
162
|
AttributePath: string | undefined;
|
|
144
163
|
/**
|
|
164
|
+
* @public
|
|
145
165
|
* <p>The value of the attribute. This is a <code>Document</code> type.
|
|
146
166
|
* This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.</p>
|
|
147
167
|
*/
|
|
@@ -152,10 +172,12 @@ export interface AttributeOperation {
|
|
|
152
172
|
*/
|
|
153
173
|
export interface GetGroupIdRequest {
|
|
154
174
|
/**
|
|
175
|
+
* @public
|
|
155
176
|
* <p>The globally unique identifier for the identity store.</p>
|
|
156
177
|
*/
|
|
157
178
|
IdentityStoreId: string | undefined;
|
|
158
179
|
/**
|
|
180
|
+
* @public
|
|
159
181
|
* <p>A unique identifier for a user or group that is not the primary identifier. This value can be
|
|
160
182
|
* 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>
|
|
161
183
|
*/
|
|
@@ -166,10 +188,12 @@ export interface GetGroupIdRequest {
|
|
|
166
188
|
*/
|
|
167
189
|
export interface GetGroupIdResponse {
|
|
168
190
|
/**
|
|
191
|
+
* @public
|
|
169
192
|
* <p>The identifier for a group in the identity store.</p>
|
|
170
193
|
*/
|
|
171
194
|
GroupId: string | undefined;
|
|
172
195
|
/**
|
|
196
|
+
* @public
|
|
173
197
|
* <p>The globally unique identifier for the identity store.</p>
|
|
174
198
|
*/
|
|
175
199
|
IdentityStoreId: string | undefined;
|
|
@@ -184,12 +208,14 @@ export declare class InternalServerException extends __BaseException {
|
|
|
184
208
|
$retryable: {};
|
|
185
209
|
Message?: string;
|
|
186
210
|
/**
|
|
211
|
+
* @public
|
|
187
212
|
* <p>The identifier for each request. This value is a globally unique ID that is generated by
|
|
188
213
|
* the identity store service for each sent request, and is then returned inside the exception
|
|
189
214
|
* if the request fails.</p>
|
|
190
215
|
*/
|
|
191
216
|
RequestId?: string;
|
|
192
217
|
/**
|
|
218
|
+
* @public
|
|
193
219
|
* <p>The number of seconds to wait before retrying the next request.</p>
|
|
194
220
|
*/
|
|
195
221
|
RetryAfterSeconds?: number;
|
|
@@ -220,15 +246,18 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
220
246
|
readonly name: "ResourceNotFoundException";
|
|
221
247
|
readonly $fault: "client";
|
|
222
248
|
/**
|
|
249
|
+
* @public
|
|
223
250
|
* <p>An enum object indicating the type of resource in the identity store service. Valid values include USER, GROUP, and IDENTITY_STORE.</p>
|
|
224
251
|
*/
|
|
225
252
|
ResourceType?: ResourceType | string;
|
|
226
253
|
/**
|
|
254
|
+
* @public
|
|
227
255
|
* <p>The identifier for a resource in the identity store that can be used as <code>UserId</code> or <code>GroupId</code>. The format for <code>ResourceId</code> is either <code>UUID</code> or <code>1234567890-UUID</code>, where <code>UUID</code> is a randomly generated value for each resource when it is created and <code>1234567890</code> represents the <code>IdentityStoreId</code> string value. In the case that the identity store is migrated from a legacy SSO identity store, the <code>ResourceId</code> for that identity store will be in the format of <code>UUID</code>. Otherwise, it will be in the <code>1234567890-UUID</code> format.</p>
|
|
228
256
|
*/
|
|
229
257
|
ResourceId?: string;
|
|
230
258
|
Message?: string;
|
|
231
259
|
/**
|
|
260
|
+
* @public
|
|
232
261
|
* <p>The identifier for each request. This value is a globally unique ID that is generated by
|
|
233
262
|
* the identity store service for each sent request, and is then returned inside the exception
|
|
234
263
|
* if the request fails.</p>
|
|
@@ -251,12 +280,14 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
251
280
|
};
|
|
252
281
|
Message?: string;
|
|
253
282
|
/**
|
|
283
|
+
* @public
|
|
254
284
|
* <p>The identifier for each request. This value is a globally unique ID that is generated by
|
|
255
285
|
* the identity store service for each sent request, and is then returned inside the exception
|
|
256
286
|
* if the request fails.</p>
|
|
257
287
|
*/
|
|
258
288
|
RequestId?: string;
|
|
259
289
|
/**
|
|
290
|
+
* @public
|
|
260
291
|
* <p>The number of seconds to wait before retrying the next request.</p>
|
|
261
292
|
*/
|
|
262
293
|
RetryAfterSeconds?: number;
|
|
@@ -274,6 +305,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
274
305
|
readonly $fault: "client";
|
|
275
306
|
Message?: string;
|
|
276
307
|
/**
|
|
308
|
+
* @public
|
|
277
309
|
* <p>The identifier for each request. This value is a globally unique ID that is generated by
|
|
278
310
|
* the identity store service for each sent request, and is then returned inside the exception
|
|
279
311
|
* if the request fails.</p>
|
|
@@ -294,12 +326,16 @@ export type MemberId = MemberId.UserIdMember | MemberId.$UnknownMember;
|
|
|
294
326
|
*/
|
|
295
327
|
export declare namespace MemberId {
|
|
296
328
|
/**
|
|
329
|
+
* @public
|
|
297
330
|
* <p>An object containing the identifiers of resources that can be members.</p>
|
|
298
331
|
*/
|
|
299
332
|
interface UserIdMember {
|
|
300
333
|
UserId: string;
|
|
301
334
|
$unknown?: never;
|
|
302
335
|
}
|
|
336
|
+
/**
|
|
337
|
+
* @public
|
|
338
|
+
*/
|
|
303
339
|
interface $UnknownMember {
|
|
304
340
|
UserId?: never;
|
|
305
341
|
$unknown: [string, any];
|
|
@@ -315,14 +351,17 @@ export declare namespace MemberId {
|
|
|
315
351
|
*/
|
|
316
352
|
export interface GetGroupMembershipIdRequest {
|
|
317
353
|
/**
|
|
354
|
+
* @public
|
|
318
355
|
* <p>The globally unique identifier for the identity store.</p>
|
|
319
356
|
*/
|
|
320
357
|
IdentityStoreId: string | undefined;
|
|
321
358
|
/**
|
|
359
|
+
* @public
|
|
322
360
|
* <p>The identifier for a group in the identity store.</p>
|
|
323
361
|
*/
|
|
324
362
|
GroupId: string | undefined;
|
|
325
363
|
/**
|
|
364
|
+
* @public
|
|
326
365
|
* <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>
|
|
327
366
|
*/
|
|
328
367
|
MemberId: MemberId | undefined;
|
|
@@ -332,10 +371,12 @@ export interface GetGroupMembershipIdRequest {
|
|
|
332
371
|
*/
|
|
333
372
|
export interface GetGroupMembershipIdResponse {
|
|
334
373
|
/**
|
|
374
|
+
* @public
|
|
335
375
|
* <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
|
|
336
376
|
*/
|
|
337
377
|
MembershipId: string | undefined;
|
|
338
378
|
/**
|
|
379
|
+
* @public
|
|
339
380
|
* <p>The globally unique identifier for the identity store.</p>
|
|
340
381
|
*/
|
|
341
382
|
IdentityStoreId: string | undefined;
|
|
@@ -345,10 +386,12 @@ export interface GetGroupMembershipIdResponse {
|
|
|
345
386
|
*/
|
|
346
387
|
export interface GetUserIdRequest {
|
|
347
388
|
/**
|
|
389
|
+
* @public
|
|
348
390
|
* <p>The globally unique identifier for the identity store.</p>
|
|
349
391
|
*/
|
|
350
392
|
IdentityStoreId: string | undefined;
|
|
351
393
|
/**
|
|
394
|
+
* @public
|
|
352
395
|
* <p>A unique identifier for a user or group that is not the primary identifier. This value can be
|
|
353
396
|
* 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>
|
|
354
397
|
*/
|
|
@@ -359,10 +402,12 @@ export interface GetUserIdRequest {
|
|
|
359
402
|
*/
|
|
360
403
|
export interface GetUserIdResponse {
|
|
361
404
|
/**
|
|
405
|
+
* @public
|
|
362
406
|
* <p>The identifier for a user in the identity store.</p>
|
|
363
407
|
*/
|
|
364
408
|
UserId: string | undefined;
|
|
365
409
|
/**
|
|
410
|
+
* @public
|
|
366
411
|
* <p>The globally unique identifier for the identity store.</p>
|
|
367
412
|
*/
|
|
368
413
|
IdentityStoreId: string | undefined;
|
|
@@ -396,10 +441,12 @@ export declare class ConflictException extends __BaseException {
|
|
|
396
441
|
readonly $fault: "client";
|
|
397
442
|
Message?: string;
|
|
398
443
|
/**
|
|
444
|
+
* @public
|
|
399
445
|
* <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
|
|
400
446
|
*/
|
|
401
447
|
RequestId?: string;
|
|
402
448
|
/**
|
|
449
|
+
* @public
|
|
403
450
|
* <p>This request cannot be completed for one of the following reasons:</p>
|
|
404
451
|
* <ul>
|
|
405
452
|
* <li>
|
|
@@ -421,14 +468,17 @@ export declare class ConflictException extends __BaseException {
|
|
|
421
468
|
*/
|
|
422
469
|
export interface CreateGroupMembershipRequest {
|
|
423
470
|
/**
|
|
471
|
+
* @public
|
|
424
472
|
* <p>The globally unique identifier for the identity store.</p>
|
|
425
473
|
*/
|
|
426
474
|
IdentityStoreId: string | undefined;
|
|
427
475
|
/**
|
|
476
|
+
* @public
|
|
428
477
|
* <p>The identifier for a group in the identity store.</p>
|
|
429
478
|
*/
|
|
430
479
|
GroupId: string | undefined;
|
|
431
480
|
/**
|
|
481
|
+
* @public
|
|
432
482
|
* <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>
|
|
433
483
|
*/
|
|
434
484
|
MemberId: MemberId | undefined;
|
|
@@ -438,11 +488,13 @@ export interface CreateGroupMembershipRequest {
|
|
|
438
488
|
*/
|
|
439
489
|
export interface CreateGroupMembershipResponse {
|
|
440
490
|
/**
|
|
491
|
+
* @public
|
|
441
492
|
* <p>The identifier for a newly created <code>GroupMembership</code> in an identity
|
|
442
493
|
* store.</p>
|
|
443
494
|
*/
|
|
444
495
|
MembershipId: string | undefined;
|
|
445
496
|
/**
|
|
497
|
+
* @public
|
|
446
498
|
* <p>The globally unique identifier for the identity store.</p>
|
|
447
499
|
*/
|
|
448
500
|
IdentityStoreId: string | undefined;
|
|
@@ -456,6 +508,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
456
508
|
readonly $fault: "client";
|
|
457
509
|
Message?: string;
|
|
458
510
|
/**
|
|
511
|
+
* @public
|
|
459
512
|
* <p>The identifier for each request. This value is a globally unique ID that is generated by the identity store service for each sent request, and is then returned inside the exception if the request fails.</p>
|
|
460
513
|
*/
|
|
461
514
|
RequestId?: string;
|
|
@@ -469,10 +522,12 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
469
522
|
*/
|
|
470
523
|
export interface DeleteGroupMembershipRequest {
|
|
471
524
|
/**
|
|
525
|
+
* @public
|
|
472
526
|
* <p>The globally unique identifier for the identity store.</p>
|
|
473
527
|
*/
|
|
474
528
|
IdentityStoreId: string | undefined;
|
|
475
529
|
/**
|
|
530
|
+
* @public
|
|
476
531
|
* <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
|
|
477
532
|
*/
|
|
478
533
|
MembershipId: string | undefined;
|
|
@@ -487,10 +542,12 @@ export interface DeleteGroupMembershipResponse {
|
|
|
487
542
|
*/
|
|
488
543
|
export interface DescribeGroupMembershipRequest {
|
|
489
544
|
/**
|
|
545
|
+
* @public
|
|
490
546
|
* <p>The globally unique identifier for the identity store.</p>
|
|
491
547
|
*/
|
|
492
548
|
IdentityStoreId: string | undefined;
|
|
493
549
|
/**
|
|
550
|
+
* @public
|
|
494
551
|
* <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
|
|
495
552
|
*/
|
|
496
553
|
MembershipId: string | undefined;
|
|
@@ -500,18 +557,22 @@ export interface DescribeGroupMembershipRequest {
|
|
|
500
557
|
*/
|
|
501
558
|
export interface DescribeGroupMembershipResponse {
|
|
502
559
|
/**
|
|
560
|
+
* @public
|
|
503
561
|
* <p>The globally unique identifier for the identity store.</p>
|
|
504
562
|
*/
|
|
505
563
|
IdentityStoreId: string | undefined;
|
|
506
564
|
/**
|
|
565
|
+
* @public
|
|
507
566
|
* <p>The identifier for a <code>GroupMembership</code> in an identity store.</p>
|
|
508
567
|
*/
|
|
509
568
|
MembershipId: string | undefined;
|
|
510
569
|
/**
|
|
570
|
+
* @public
|
|
511
571
|
* <p>The identifier for a group in the identity store.</p>
|
|
512
572
|
*/
|
|
513
573
|
GroupId: string | undefined;
|
|
514
574
|
/**
|
|
575
|
+
* @public
|
|
515
576
|
* <p>An object containing the identifier of a group member.</p>
|
|
516
577
|
*/
|
|
517
578
|
MemberId: MemberId | undefined;
|
|
@@ -521,19 +582,23 @@ export interface DescribeGroupMembershipResponse {
|
|
|
521
582
|
*/
|
|
522
583
|
export interface ListGroupMembershipsRequest {
|
|
523
584
|
/**
|
|
585
|
+
* @public
|
|
524
586
|
* <p>The globally unique identifier for the identity store.</p>
|
|
525
587
|
*/
|
|
526
588
|
IdentityStoreId: string | undefined;
|
|
527
589
|
/**
|
|
590
|
+
* @public
|
|
528
591
|
* <p>The identifier for a group in the identity store.</p>
|
|
529
592
|
*/
|
|
530
593
|
GroupId: string | undefined;
|
|
531
594
|
/**
|
|
595
|
+
* @public
|
|
532
596
|
* <p>The maximum number of results to be returned per request. This parameter is used in all
|
|
533
597
|
* <code>List</code> requests to specify how many results to return in one page.</p>
|
|
534
598
|
*/
|
|
535
599
|
MaxResults?: number;
|
|
536
600
|
/**
|
|
601
|
+
* @public
|
|
537
602
|
* <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 search for the next page.</p>
|
|
538
603
|
*/
|
|
539
604
|
NextToken?: string;
|
|
@@ -545,18 +610,22 @@ export interface ListGroupMembershipsRequest {
|
|
|
545
610
|
*/
|
|
546
611
|
export interface GroupMembership {
|
|
547
612
|
/**
|
|
613
|
+
* @public
|
|
548
614
|
* <p>The globally unique identifier for the identity store.</p>
|
|
549
615
|
*/
|
|
550
616
|
IdentityStoreId: string | undefined;
|
|
551
617
|
/**
|
|
618
|
+
* @public
|
|
552
619
|
* <p>The identifier for a <code>GroupMembership</code> object in an identity store.</p>
|
|
553
620
|
*/
|
|
554
621
|
MembershipId?: string;
|
|
555
622
|
/**
|
|
623
|
+
* @public
|
|
556
624
|
* <p>The identifier for a group in the identity store.</p>
|
|
557
625
|
*/
|
|
558
626
|
GroupId?: string;
|
|
559
627
|
/**
|
|
628
|
+
* @public
|
|
560
629
|
* <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>
|
|
561
630
|
*/
|
|
562
631
|
MemberId?: MemberId;
|
|
@@ -566,10 +635,12 @@ export interface GroupMembership {
|
|
|
566
635
|
*/
|
|
567
636
|
export interface ListGroupMembershipsResponse {
|
|
568
637
|
/**
|
|
638
|
+
* @public
|
|
569
639
|
* <p>A list of <code>GroupMembership</code> objects in the group.</p>
|
|
570
640
|
*/
|
|
571
641
|
GroupMemberships: GroupMembership[] | undefined;
|
|
572
642
|
/**
|
|
643
|
+
* @public
|
|
573
644
|
* <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 search for the next page.</p>
|
|
574
645
|
*/
|
|
575
646
|
NextToken?: string;
|
|
@@ -579,16 +650,19 @@ export interface ListGroupMembershipsResponse {
|
|
|
579
650
|
*/
|
|
580
651
|
export interface CreateGroupRequest {
|
|
581
652
|
/**
|
|
653
|
+
* @public
|
|
582
654
|
* <p>The globally unique identifier for the identity store.</p>
|
|
583
655
|
*/
|
|
584
656
|
IdentityStoreId: string | undefined;
|
|
585
657
|
/**
|
|
658
|
+
* @public
|
|
586
659
|
* <p>A string containing the name of the group. This value is commonly displayed when the
|
|
587
660
|
* group is referenced. "Administrator" and "AWSAdministrators" are reserved names and can't be used for users
|
|
588
661
|
* or groups.</p>
|
|
589
662
|
*/
|
|
590
663
|
DisplayName?: string;
|
|
591
664
|
/**
|
|
665
|
+
* @public
|
|
592
666
|
* <p>A string containing the description of the group.</p>
|
|
593
667
|
*/
|
|
594
668
|
Description?: string;
|
|
@@ -598,12 +672,14 @@ export interface CreateGroupRequest {
|
|
|
598
672
|
*/
|
|
599
673
|
export interface CreateGroupResponse {
|
|
600
674
|
/**
|
|
675
|
+
* @public
|
|
601
676
|
* <p>The
|
|
602
677
|
* identifier
|
|
603
678
|
* of the newly created group in the identity store.</p>
|
|
604
679
|
*/
|
|
605
680
|
GroupId: string | undefined;
|
|
606
681
|
/**
|
|
682
|
+
* @public
|
|
607
683
|
* <p>The globally unique identifier for the identity store.</p>
|
|
608
684
|
*/
|
|
609
685
|
IdentityStoreId: string | undefined;
|
|
@@ -613,10 +689,12 @@ export interface CreateGroupResponse {
|
|
|
613
689
|
*/
|
|
614
690
|
export interface DeleteGroupRequest {
|
|
615
691
|
/**
|
|
692
|
+
* @public
|
|
616
693
|
* <p>The globally unique identifier for the identity store.</p>
|
|
617
694
|
*/
|
|
618
695
|
IdentityStoreId: string | undefined;
|
|
619
696
|
/**
|
|
697
|
+
* @public
|
|
620
698
|
* <p>The identifier for a group in the identity store.</p>
|
|
621
699
|
*/
|
|
622
700
|
GroupId: string | undefined;
|
|
@@ -631,6 +709,7 @@ export interface DeleteGroupResponse {
|
|
|
631
709
|
*/
|
|
632
710
|
export interface DescribeGroupRequest {
|
|
633
711
|
/**
|
|
712
|
+
* @public
|
|
634
713
|
* <p>The globally unique identifier for the identity store, such as
|
|
635
714
|
* <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
|
|
636
715
|
* <code>1234567890</code> is a randomly generated string that contains numbers and lower
|
|
@@ -639,6 +718,7 @@ export interface DescribeGroupRequest {
|
|
|
639
718
|
*/
|
|
640
719
|
IdentityStoreId: string | undefined;
|
|
641
720
|
/**
|
|
721
|
+
* @public
|
|
642
722
|
* <p>The identifier for a group in the identity store.</p>
|
|
643
723
|
*/
|
|
644
724
|
GroupId: string | undefined;
|
|
@@ -648,10 +728,12 @@ export interface DescribeGroupRequest {
|
|
|
648
728
|
*/
|
|
649
729
|
export interface DescribeGroupResponse {
|
|
650
730
|
/**
|
|
731
|
+
* @public
|
|
651
732
|
* <p>The identifier for a group in the identity store.</p>
|
|
652
733
|
*/
|
|
653
734
|
GroupId: string | undefined;
|
|
654
735
|
/**
|
|
736
|
+
* @public
|
|
655
737
|
* <p>The group’s display name value. The length limit is 1,024 characters. This
|
|
656
738
|
* value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new
|
|
657
739
|
* line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the
|
|
@@ -660,15 +742,18 @@ export interface DescribeGroupResponse {
|
|
|
660
742
|
*/
|
|
661
743
|
DisplayName?: string;
|
|
662
744
|
/**
|
|
745
|
+
* @public
|
|
663
746
|
* <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
|
|
664
747
|
* resource by an external identity provider.</p>
|
|
665
748
|
*/
|
|
666
749
|
ExternalIds?: ExternalId[];
|
|
667
750
|
/**
|
|
751
|
+
* @public
|
|
668
752
|
* <p>A string containing a description of the group.</p>
|
|
669
753
|
*/
|
|
670
754
|
Description?: string;
|
|
671
755
|
/**
|
|
756
|
+
* @public
|
|
672
757
|
* <p>The globally unique identifier for the identity store.</p>
|
|
673
758
|
*/
|
|
674
759
|
IdentityStoreId: string | undefined;
|
|
@@ -680,6 +765,7 @@ export interface DescribeGroupResponse {
|
|
|
680
765
|
*/
|
|
681
766
|
export interface Filter {
|
|
682
767
|
/**
|
|
768
|
+
* @public
|
|
683
769
|
* <p>The attribute path that is used to specify which attribute name to search. Length limit
|
|
684
770
|
* is 255 characters. For example, <code>UserName</code> is a valid attribute path for the
|
|
685
771
|
* <code>ListUsers</code> API, and <code>DisplayName</code> is a valid attribute path for
|
|
@@ -687,6 +773,7 @@ export interface Filter {
|
|
|
687
773
|
*/
|
|
688
774
|
AttributePath: string | undefined;
|
|
689
775
|
/**
|
|
776
|
+
* @public
|
|
690
777
|
* <p>Represents the data for an attribute. Each attribute value is described as a name-value
|
|
691
778
|
* pair. </p>
|
|
692
779
|
*/
|
|
@@ -697,6 +784,7 @@ export interface Filter {
|
|
|
697
784
|
*/
|
|
698
785
|
export interface ListGroupsRequest {
|
|
699
786
|
/**
|
|
787
|
+
* @public
|
|
700
788
|
* <p>The globally unique identifier for the identity store, such as
|
|
701
789
|
* <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
|
|
702
790
|
* <code>1234567890</code> is a randomly generated string that contains numbers and lower
|
|
@@ -705,12 +793,14 @@ export interface ListGroupsRequest {
|
|
|
705
793
|
*/
|
|
706
794
|
IdentityStoreId: string | undefined;
|
|
707
795
|
/**
|
|
796
|
+
* @public
|
|
708
797
|
* <p>The maximum number of results to be returned per request. This parameter is used in the
|
|
709
798
|
* <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results
|
|
710
799
|
* to return in one page. The length limit is 50 characters.</p>
|
|
711
800
|
*/
|
|
712
801
|
MaxResults?: number;
|
|
713
802
|
/**
|
|
803
|
+
* @public
|
|
714
804
|
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
|
|
715
805
|
* operations. This value is generated by the identity store service. It is returned in the
|
|
716
806
|
* API response if the total results are more than the size of one page. This token is also
|
|
@@ -718,6 +808,7 @@ export interface ListGroupsRequest {
|
|
|
718
808
|
*/
|
|
719
809
|
NextToken?: string;
|
|
720
810
|
/**
|
|
811
|
+
* @public
|
|
721
812
|
* @deprecated
|
|
722
813
|
*
|
|
723
814
|
* <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
|
|
@@ -731,10 +822,12 @@ export interface ListGroupsRequest {
|
|
|
731
822
|
*/
|
|
732
823
|
export interface Group {
|
|
733
824
|
/**
|
|
825
|
+
* @public
|
|
734
826
|
* <p>The identifier for a group in the identity store.</p>
|
|
735
827
|
*/
|
|
736
828
|
GroupId: string | undefined;
|
|
737
829
|
/**
|
|
830
|
+
* @public
|
|
738
831
|
* <p>The display name value for the group. The length limit is 1,024 characters. This value
|
|
739
832
|
* can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line,
|
|
740
833
|
* carriage return, space, and nonbreaking space in this attribute. This value is specified at
|
|
@@ -743,15 +836,18 @@ export interface Group {
|
|
|
743
836
|
*/
|
|
744
837
|
DisplayName?: string;
|
|
745
838
|
/**
|
|
839
|
+
* @public
|
|
746
840
|
* <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
|
|
747
841
|
* resource by an external identity provider.</p>
|
|
748
842
|
*/
|
|
749
843
|
ExternalIds?: ExternalId[];
|
|
750
844
|
/**
|
|
845
|
+
* @public
|
|
751
846
|
* <p>A string containing a description of the specified group.</p>
|
|
752
847
|
*/
|
|
753
848
|
Description?: string;
|
|
754
849
|
/**
|
|
850
|
+
* @public
|
|
755
851
|
* <p>The globally unique identifier for the identity store.</p>
|
|
756
852
|
*/
|
|
757
853
|
IdentityStoreId: string | undefined;
|
|
@@ -761,10 +857,12 @@ export interface Group {
|
|
|
761
857
|
*/
|
|
762
858
|
export interface ListGroupsResponse {
|
|
763
859
|
/**
|
|
860
|
+
* @public
|
|
764
861
|
* <p>A list of <code>Group</code> objects in the identity store.</p>
|
|
765
862
|
*/
|
|
766
863
|
Groups: Group[] | undefined;
|
|
767
864
|
/**
|
|
865
|
+
* @public
|
|
768
866
|
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
|
|
769
867
|
* operations. This value is generated by the identity store service. It is returned in the
|
|
770
868
|
* API response if the total results are more than the size of one page. This token is also
|
|
@@ -777,14 +875,17 @@ export interface ListGroupsResponse {
|
|
|
777
875
|
*/
|
|
778
876
|
export interface UpdateGroupRequest {
|
|
779
877
|
/**
|
|
878
|
+
* @public
|
|
780
879
|
* <p>The globally unique identifier for the identity store.</p>
|
|
781
880
|
*/
|
|
782
881
|
IdentityStoreId: string | undefined;
|
|
783
882
|
/**
|
|
883
|
+
* @public
|
|
784
884
|
* <p>The identifier for a group in the identity store.</p>
|
|
785
885
|
*/
|
|
786
886
|
GroupId: string | undefined;
|
|
787
887
|
/**
|
|
888
|
+
* @public
|
|
788
889
|
* <p>A list of <code>AttributeOperation</code> objects to apply to the requested group. These
|
|
789
890
|
* operations might add, replace, or remove an attribute.</p>
|
|
790
891
|
*/
|
|
@@ -800,14 +901,17 @@ export interface UpdateGroupResponse {
|
|
|
800
901
|
*/
|
|
801
902
|
export interface IsMemberInGroupsRequest {
|
|
802
903
|
/**
|
|
904
|
+
* @public
|
|
803
905
|
* <p>The globally unique identifier for the identity store.</p>
|
|
804
906
|
*/
|
|
805
907
|
IdentityStoreId: string | undefined;
|
|
806
908
|
/**
|
|
909
|
+
* @public
|
|
807
910
|
* <p>An object containing the identifier of a group member.</p>
|
|
808
911
|
*/
|
|
809
912
|
MemberId: MemberId | undefined;
|
|
810
913
|
/**
|
|
914
|
+
* @public
|
|
811
915
|
* <p>A list of identifiers for groups in the identity store.</p>
|
|
812
916
|
*/
|
|
813
917
|
GroupIds: string[] | undefined;
|
|
@@ -818,14 +922,17 @@ export interface IsMemberInGroupsRequest {
|
|
|
818
922
|
*/
|
|
819
923
|
export interface GroupMembershipExistenceResult {
|
|
820
924
|
/**
|
|
925
|
+
* @public
|
|
821
926
|
* <p>The identifier for a group in the identity store.</p>
|
|
822
927
|
*/
|
|
823
928
|
GroupId?: string;
|
|
824
929
|
/**
|
|
930
|
+
* @public
|
|
825
931
|
* <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>
|
|
826
932
|
*/
|
|
827
933
|
MemberId?: MemberId;
|
|
828
934
|
/**
|
|
935
|
+
* @public
|
|
829
936
|
* <p>Indicates whether a membership relation exists or not.</p>
|
|
830
937
|
*/
|
|
831
938
|
MembershipExists?: boolean;
|
|
@@ -835,6 +942,7 @@ export interface GroupMembershipExistenceResult {
|
|
|
835
942
|
*/
|
|
836
943
|
export interface IsMemberInGroupsResponse {
|
|
837
944
|
/**
|
|
945
|
+
* @public
|
|
838
946
|
* <p>A list containing the results of membership existence checks.</p>
|
|
839
947
|
*/
|
|
840
948
|
Results: GroupMembershipExistenceResult[] | undefined;
|
|
@@ -844,18 +952,22 @@ export interface IsMemberInGroupsResponse {
|
|
|
844
952
|
*/
|
|
845
953
|
export interface ListGroupMembershipsForMemberRequest {
|
|
846
954
|
/**
|
|
955
|
+
* @public
|
|
847
956
|
* <p>The globally unique identifier for the identity store.</p>
|
|
848
957
|
*/
|
|
849
958
|
IdentityStoreId: string | undefined;
|
|
850
959
|
/**
|
|
960
|
+
* @public
|
|
851
961
|
* <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>
|
|
852
962
|
*/
|
|
853
963
|
MemberId: MemberId | undefined;
|
|
854
964
|
/**
|
|
965
|
+
* @public
|
|
855
966
|
* <p>The maximum number of results to be returned per request. This parameter is used in the <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results to return in one page. The length limit is 50 characters.</p>
|
|
856
967
|
*/
|
|
857
968
|
MaxResults?: number;
|
|
858
969
|
/**
|
|
970
|
+
* @public
|
|
859
971
|
* <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 search for the next page.</p>
|
|
860
972
|
*/
|
|
861
973
|
NextToken?: string;
|
|
@@ -865,10 +977,12 @@ export interface ListGroupMembershipsForMemberRequest {
|
|
|
865
977
|
*/
|
|
866
978
|
export interface ListGroupMembershipsForMemberResponse {
|
|
867
979
|
/**
|
|
980
|
+
* @public
|
|
868
981
|
* <p>A list of <code>GroupMembership</code> objects in the group for a specified member.</p>
|
|
869
982
|
*/
|
|
870
983
|
GroupMemberships: GroupMembership[] | undefined;
|
|
871
984
|
/**
|
|
985
|
+
* @public
|
|
872
986
|
* <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 search for the next page.
|
|
873
987
|
* </p>
|
|
874
988
|
*/
|
|
@@ -880,14 +994,17 @@ export interface ListGroupMembershipsForMemberResponse {
|
|
|
880
994
|
*/
|
|
881
995
|
export interface Email {
|
|
882
996
|
/**
|
|
997
|
+
* @public
|
|
883
998
|
* <p>A string containing an email address. For example, "johndoe@amazon.com."</p>
|
|
884
999
|
*/
|
|
885
1000
|
Value?: string;
|
|
886
1001
|
/**
|
|
1002
|
+
* @public
|
|
887
1003
|
* <p>A string representing the type of address. For example, "Work."</p>
|
|
888
1004
|
*/
|
|
889
1005
|
Type?: string;
|
|
890
1006
|
/**
|
|
1007
|
+
* @public
|
|
891
1008
|
* <p>A Boolean value representing whether this is the primary email address for the
|
|
892
1009
|
* associated resource.</p>
|
|
893
1010
|
*/
|
|
@@ -901,26 +1018,32 @@ export interface Email {
|
|
|
901
1018
|
*/
|
|
902
1019
|
export interface Name {
|
|
903
1020
|
/**
|
|
1021
|
+
* @public
|
|
904
1022
|
* <p>A string containing a formatted version of the name for display.</p>
|
|
905
1023
|
*/
|
|
906
1024
|
Formatted?: string;
|
|
907
1025
|
/**
|
|
1026
|
+
* @public
|
|
908
1027
|
* <p>The family name of the user.</p>
|
|
909
1028
|
*/
|
|
910
1029
|
FamilyName?: string;
|
|
911
1030
|
/**
|
|
1031
|
+
* @public
|
|
912
1032
|
* <p>The given name of the user.</p>
|
|
913
1033
|
*/
|
|
914
1034
|
GivenName?: string;
|
|
915
1035
|
/**
|
|
1036
|
+
* @public
|
|
916
1037
|
* <p>The middle name of the user.</p>
|
|
917
1038
|
*/
|
|
918
1039
|
MiddleName?: string;
|
|
919
1040
|
/**
|
|
1041
|
+
* @public
|
|
920
1042
|
* <p>The honorific prefix of the user. For example, "Dr."</p>
|
|
921
1043
|
*/
|
|
922
1044
|
HonorificPrefix?: string;
|
|
923
1045
|
/**
|
|
1046
|
+
* @public
|
|
924
1047
|
* <p>The honorific suffix of the user. For example, "M.D."</p>
|
|
925
1048
|
*/
|
|
926
1049
|
HonorificSuffix?: string;
|
|
@@ -931,16 +1054,19 @@ export interface Name {
|
|
|
931
1054
|
*/
|
|
932
1055
|
export interface PhoneNumber {
|
|
933
1056
|
/**
|
|
1057
|
+
* @public
|
|
934
1058
|
* <p>A string containing a phone number. For example,
|
|
935
1059
|
* "8675309"
|
|
936
1060
|
* or "+1 (800) 123-4567".</p>
|
|
937
1061
|
*/
|
|
938
1062
|
Value?: string;
|
|
939
1063
|
/**
|
|
1064
|
+
* @public
|
|
940
1065
|
* <p>A string representing the type of a phone number. For example, "Mobile."</p>
|
|
941
1066
|
*/
|
|
942
1067
|
Type?: string;
|
|
943
1068
|
/**
|
|
1069
|
+
* @public
|
|
944
1070
|
* <p>A Boolean value representing whether this is the primary phone number for the associated
|
|
945
1071
|
* resource.</p>
|
|
946
1072
|
*/
|
|
@@ -951,10 +1077,12 @@ export interface PhoneNumber {
|
|
|
951
1077
|
*/
|
|
952
1078
|
export interface CreateUserRequest {
|
|
953
1079
|
/**
|
|
1080
|
+
* @public
|
|
954
1081
|
* <p>The globally unique identifier for the identity store.</p>
|
|
955
1082
|
*/
|
|
956
1083
|
IdentityStoreId: string | undefined;
|
|
957
1084
|
/**
|
|
1085
|
+
* @public
|
|
958
1086
|
* <p>A unique string used to identify the user. The length limit is 128 characters. This
|
|
959
1087
|
* value can consist of letters, accented characters, symbols, numbers, and punctuation. This
|
|
960
1088
|
* value is specified at the time the user is created and stored as an attribute of the user
|
|
@@ -963,54 +1091,66 @@ export interface CreateUserRequest {
|
|
|
963
1091
|
*/
|
|
964
1092
|
UserName?: string;
|
|
965
1093
|
/**
|
|
1094
|
+
* @public
|
|
966
1095
|
* <p>An object containing the name of the user.</p>
|
|
967
1096
|
*/
|
|
968
1097
|
Name?: Name;
|
|
969
1098
|
/**
|
|
1099
|
+
* @public
|
|
970
1100
|
* <p>A string containing the name of the user. This value is typically formatted for display
|
|
971
1101
|
* when the user is referenced. For example, "John Doe." </p>
|
|
972
1102
|
*/
|
|
973
1103
|
DisplayName?: string;
|
|
974
1104
|
/**
|
|
1105
|
+
* @public
|
|
975
1106
|
* <p>A string containing an alternate name for the user.</p>
|
|
976
1107
|
*/
|
|
977
1108
|
NickName?: string;
|
|
978
1109
|
/**
|
|
1110
|
+
* @public
|
|
979
1111
|
* <p>A string containing a URL that might be associated with the user.</p>
|
|
980
1112
|
*/
|
|
981
1113
|
ProfileUrl?: string;
|
|
982
1114
|
/**
|
|
1115
|
+
* @public
|
|
983
1116
|
* <p>A list of <code>Email</code> objects containing email addresses associated with the user.</p>
|
|
984
1117
|
*/
|
|
985
1118
|
Emails?: Email[];
|
|
986
1119
|
/**
|
|
1120
|
+
* @public
|
|
987
1121
|
* <p>A list of <code>Address</code> objects containing addresses associated with the user.</p>
|
|
988
1122
|
*/
|
|
989
1123
|
Addresses?: Address[];
|
|
990
1124
|
/**
|
|
1125
|
+
* @public
|
|
991
1126
|
* <p>A list of <code>PhoneNumber</code> objects containing phone numbers associated with the user.</p>
|
|
992
1127
|
*/
|
|
993
1128
|
PhoneNumbers?: PhoneNumber[];
|
|
994
1129
|
/**
|
|
1130
|
+
* @public
|
|
995
1131
|
* <p>A string indicating the type of user. Possible values are left unspecified. The value
|
|
996
1132
|
* can vary based on your specific use case.</p>
|
|
997
1133
|
*/
|
|
998
1134
|
UserType?: string;
|
|
999
1135
|
/**
|
|
1136
|
+
* @public
|
|
1000
1137
|
* <p>A string containing the title of the user. Possible values are left unspecified. The
|
|
1001
1138
|
* value can vary based on your specific use case.</p>
|
|
1002
1139
|
*/
|
|
1003
1140
|
Title?: string;
|
|
1004
1141
|
/**
|
|
1142
|
+
* @public
|
|
1005
1143
|
* <p>A string containing the preferred language of the user. For example, "American English"
|
|
1006
1144
|
* or "en-us."</p>
|
|
1007
1145
|
*/
|
|
1008
1146
|
PreferredLanguage?: string;
|
|
1009
1147
|
/**
|
|
1148
|
+
* @public
|
|
1010
1149
|
* <p>A string containing the geographical region or location of the user.</p>
|
|
1011
1150
|
*/
|
|
1012
1151
|
Locale?: string;
|
|
1013
1152
|
/**
|
|
1153
|
+
* @public
|
|
1014
1154
|
* <p>A string containing the time zone of the user.</p>
|
|
1015
1155
|
*/
|
|
1016
1156
|
Timezone?: string;
|
|
@@ -1020,10 +1160,12 @@ export interface CreateUserRequest {
|
|
|
1020
1160
|
*/
|
|
1021
1161
|
export interface CreateUserResponse {
|
|
1022
1162
|
/**
|
|
1163
|
+
* @public
|
|
1023
1164
|
* <p>The identifier of the newly created user in the identity store.</p>
|
|
1024
1165
|
*/
|
|
1025
1166
|
UserId: string | undefined;
|
|
1026
1167
|
/**
|
|
1168
|
+
* @public
|
|
1027
1169
|
* <p>The globally unique identifier for the identity store.</p>
|
|
1028
1170
|
*/
|
|
1029
1171
|
IdentityStoreId: string | undefined;
|
|
@@ -1033,10 +1175,12 @@ export interface CreateUserResponse {
|
|
|
1033
1175
|
*/
|
|
1034
1176
|
export interface DeleteUserRequest {
|
|
1035
1177
|
/**
|
|
1178
|
+
* @public
|
|
1036
1179
|
* <p>The globally unique identifier for the identity store.</p>
|
|
1037
1180
|
*/
|
|
1038
1181
|
IdentityStoreId: string | undefined;
|
|
1039
1182
|
/**
|
|
1183
|
+
* @public
|
|
1040
1184
|
* <p>The identifier for a user in the identity store.</p>
|
|
1041
1185
|
*/
|
|
1042
1186
|
UserId: string | undefined;
|
|
@@ -1051,6 +1195,7 @@ export interface DeleteUserResponse {
|
|
|
1051
1195
|
*/
|
|
1052
1196
|
export interface DescribeUserRequest {
|
|
1053
1197
|
/**
|
|
1198
|
+
* @public
|
|
1054
1199
|
* <p>The globally unique identifier for the identity store, such as
|
|
1055
1200
|
* <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
|
|
1056
1201
|
* <code>1234567890</code> is a randomly generated string that contains numbers and lower
|
|
@@ -1059,6 +1204,7 @@ export interface DescribeUserRequest {
|
|
|
1059
1204
|
*/
|
|
1060
1205
|
IdentityStoreId: string | undefined;
|
|
1061
1206
|
/**
|
|
1207
|
+
* @public
|
|
1062
1208
|
* <p>The identifier for a user in the identity store.</p>
|
|
1063
1209
|
*/
|
|
1064
1210
|
UserId: string | undefined;
|
|
@@ -1068,69 +1214,85 @@ export interface DescribeUserRequest {
|
|
|
1068
1214
|
*/
|
|
1069
1215
|
export interface DescribeUserResponse {
|
|
1070
1216
|
/**
|
|
1217
|
+
* @public
|
|
1071
1218
|
* <p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of
|
|
1072
1219
|
* letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is
|
|
1073
1220
|
* created and stored as an attribute of the user object in the identity store.</p>
|
|
1074
1221
|
*/
|
|
1075
1222
|
UserName?: string;
|
|
1076
1223
|
/**
|
|
1224
|
+
* @public
|
|
1077
1225
|
* <p>The identifier for a user in the identity store.</p>
|
|
1078
1226
|
*/
|
|
1079
1227
|
UserId: string | undefined;
|
|
1080
1228
|
/**
|
|
1229
|
+
* @public
|
|
1081
1230
|
* <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
|
|
1082
1231
|
* resource by an external identity provider.</p>
|
|
1083
1232
|
*/
|
|
1084
1233
|
ExternalIds?: ExternalId[];
|
|
1085
1234
|
/**
|
|
1235
|
+
* @public
|
|
1086
1236
|
* <p>The name of the user.</p>
|
|
1087
1237
|
*/
|
|
1088
1238
|
Name?: Name;
|
|
1089
1239
|
/**
|
|
1240
|
+
* @public
|
|
1090
1241
|
* <p>The display name of the user.</p>
|
|
1091
1242
|
*/
|
|
1092
1243
|
DisplayName?: string;
|
|
1093
1244
|
/**
|
|
1245
|
+
* @public
|
|
1094
1246
|
* <p>An alternative descriptive name for the user.</p>
|
|
1095
1247
|
*/
|
|
1096
1248
|
NickName?: string;
|
|
1097
1249
|
/**
|
|
1250
|
+
* @public
|
|
1098
1251
|
* <p>A URL link for the user's profile.</p>
|
|
1099
1252
|
*/
|
|
1100
1253
|
ProfileUrl?: string;
|
|
1101
1254
|
/**
|
|
1255
|
+
* @public
|
|
1102
1256
|
* <p>The email address of the user.</p>
|
|
1103
1257
|
*/
|
|
1104
1258
|
Emails?: Email[];
|
|
1105
1259
|
/**
|
|
1260
|
+
* @public
|
|
1106
1261
|
* <p>The physical address of the user.</p>
|
|
1107
1262
|
*/
|
|
1108
1263
|
Addresses?: Address[];
|
|
1109
1264
|
/**
|
|
1265
|
+
* @public
|
|
1110
1266
|
* <p>A list of <code>PhoneNumber</code> objects associated with a user.</p>
|
|
1111
1267
|
*/
|
|
1112
1268
|
PhoneNumbers?: PhoneNumber[];
|
|
1113
1269
|
/**
|
|
1270
|
+
* @public
|
|
1114
1271
|
* <p>A string indicating the type of user.</p>
|
|
1115
1272
|
*/
|
|
1116
1273
|
UserType?: string;
|
|
1117
1274
|
/**
|
|
1275
|
+
* @public
|
|
1118
1276
|
* <p>A string containing the title of the user.</p>
|
|
1119
1277
|
*/
|
|
1120
1278
|
Title?: string;
|
|
1121
1279
|
/**
|
|
1280
|
+
* @public
|
|
1122
1281
|
* <p>The preferred language of the user.</p>
|
|
1123
1282
|
*/
|
|
1124
1283
|
PreferredLanguage?: string;
|
|
1125
1284
|
/**
|
|
1285
|
+
* @public
|
|
1126
1286
|
* <p>A string containing the geographical region or location of the user.</p>
|
|
1127
1287
|
*/
|
|
1128
1288
|
Locale?: string;
|
|
1129
1289
|
/**
|
|
1290
|
+
* @public
|
|
1130
1291
|
* <p>The time zone for a user.</p>
|
|
1131
1292
|
*/
|
|
1132
1293
|
Timezone?: string;
|
|
1133
1294
|
/**
|
|
1295
|
+
* @public
|
|
1134
1296
|
* <p>The globally unique identifier for the identity store.</p>
|
|
1135
1297
|
*/
|
|
1136
1298
|
IdentityStoreId: string | undefined;
|
|
@@ -1140,6 +1302,7 @@ export interface DescribeUserResponse {
|
|
|
1140
1302
|
*/
|
|
1141
1303
|
export interface ListUsersRequest {
|
|
1142
1304
|
/**
|
|
1305
|
+
* @public
|
|
1143
1306
|
* <p>The globally unique identifier for the identity store, such as
|
|
1144
1307
|
* <code>d-1234567890</code>. In this example, <code>d-</code> is a fixed prefix, and
|
|
1145
1308
|
* <code>1234567890</code> is a randomly generated string that contains numbers and lower
|
|
@@ -1148,12 +1311,14 @@ export interface ListUsersRequest {
|
|
|
1148
1311
|
*/
|
|
1149
1312
|
IdentityStoreId: string | undefined;
|
|
1150
1313
|
/**
|
|
1314
|
+
* @public
|
|
1151
1315
|
* <p>The maximum number of results to be returned per request. This parameter is used in the
|
|
1152
1316
|
* <code>ListUsers</code> and <code>ListGroups</code> requests to specify how many results
|
|
1153
1317
|
* to return in one page. The length limit is 50 characters.</p>
|
|
1154
1318
|
*/
|
|
1155
1319
|
MaxResults?: number;
|
|
1156
1320
|
/**
|
|
1321
|
+
* @public
|
|
1157
1322
|
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
|
|
1158
1323
|
* operations. This value is generated by the identity store service. It is returned in the
|
|
1159
1324
|
* API response if the total results are more than the size of one page. This token is also
|
|
@@ -1161,6 +1326,7 @@ export interface ListUsersRequest {
|
|
|
1161
1326
|
*/
|
|
1162
1327
|
NextToken?: string;
|
|
1163
1328
|
/**
|
|
1329
|
+
* @public
|
|
1164
1330
|
* @deprecated
|
|
1165
1331
|
*
|
|
1166
1332
|
* <p>A list of <code>Filter</code> objects, which is used in the <code>ListUsers</code> and
|
|
@@ -1174,73 +1340,89 @@ export interface ListUsersRequest {
|
|
|
1174
1340
|
*/
|
|
1175
1341
|
export interface User {
|
|
1176
1342
|
/**
|
|
1343
|
+
* @public
|
|
1177
1344
|
* <p>A unique string used to identify the user. The length limit is 128 characters. This value can
|
|
1178
1345
|
* consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is
|
|
1179
1346
|
* created and stored as an attribute of the user object in the identity store.</p>
|
|
1180
1347
|
*/
|
|
1181
1348
|
UserName?: string;
|
|
1182
1349
|
/**
|
|
1350
|
+
* @public
|
|
1183
1351
|
* <p>The identifier for a user in the identity store.</p>
|
|
1184
1352
|
*/
|
|
1185
1353
|
UserId: string | undefined;
|
|
1186
1354
|
/**
|
|
1355
|
+
* @public
|
|
1187
1356
|
* <p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this
|
|
1188
1357
|
* resource by an external identity provider.</p>
|
|
1189
1358
|
*/
|
|
1190
1359
|
ExternalIds?: ExternalId[];
|
|
1191
1360
|
/**
|
|
1361
|
+
* @public
|
|
1192
1362
|
* <p>An object containing the name of the user.</p>
|
|
1193
1363
|
*/
|
|
1194
1364
|
Name?: Name;
|
|
1195
1365
|
/**
|
|
1366
|
+
* @public
|
|
1196
1367
|
* <p>A string containing the name of the user that is formatted for display when the user is
|
|
1197
1368
|
* referenced. For example, "John Doe."</p>
|
|
1198
1369
|
*/
|
|
1199
1370
|
DisplayName?: string;
|
|
1200
1371
|
/**
|
|
1372
|
+
* @public
|
|
1201
1373
|
* <p>A string containing an alternate name for the user.</p>
|
|
1202
1374
|
*/
|
|
1203
1375
|
NickName?: string;
|
|
1204
1376
|
/**
|
|
1377
|
+
* @public
|
|
1205
1378
|
* <p>A string containing a URL that might be associated with the user.</p>
|
|
1206
1379
|
*/
|
|
1207
1380
|
ProfileUrl?: string;
|
|
1208
1381
|
/**
|
|
1382
|
+
* @public
|
|
1209
1383
|
* <p>A list of <code>Email</code> objects containing email addresses associated with the user.</p>
|
|
1210
1384
|
*/
|
|
1211
1385
|
Emails?: Email[];
|
|
1212
1386
|
/**
|
|
1387
|
+
* @public
|
|
1213
1388
|
* <p>A list of <code>Address</code> objects containing addresses associated with the user.</p>
|
|
1214
1389
|
*/
|
|
1215
1390
|
Addresses?: Address[];
|
|
1216
1391
|
/**
|
|
1392
|
+
* @public
|
|
1217
1393
|
* <p>A list of <code>PhoneNumber</code> objects containing phone numbers associated with the user.</p>
|
|
1218
1394
|
*/
|
|
1219
1395
|
PhoneNumbers?: PhoneNumber[];
|
|
1220
1396
|
/**
|
|
1397
|
+
* @public
|
|
1221
1398
|
* <p>A string indicating the type of user. Possible values are left unspecified. The value
|
|
1222
1399
|
* can vary based on your specific use case.</p>
|
|
1223
1400
|
*/
|
|
1224
1401
|
UserType?: string;
|
|
1225
1402
|
/**
|
|
1403
|
+
* @public
|
|
1226
1404
|
* <p>A string containing the title of the user. Possible values are left unspecified. The
|
|
1227
1405
|
* value can vary based on your specific use case.</p>
|
|
1228
1406
|
*/
|
|
1229
1407
|
Title?: string;
|
|
1230
1408
|
/**
|
|
1409
|
+
* @public
|
|
1231
1410
|
* <p>A string containing the preferred language of the user. For example, "American English"
|
|
1232
1411
|
* or "en-us."</p>
|
|
1233
1412
|
*/
|
|
1234
1413
|
PreferredLanguage?: string;
|
|
1235
1414
|
/**
|
|
1415
|
+
* @public
|
|
1236
1416
|
* <p>A string containing the geographical region or location of the user.</p>
|
|
1237
1417
|
*/
|
|
1238
1418
|
Locale?: string;
|
|
1239
1419
|
/**
|
|
1420
|
+
* @public
|
|
1240
1421
|
* <p>A string containing the time zone of the user.</p>
|
|
1241
1422
|
*/
|
|
1242
1423
|
Timezone?: string;
|
|
1243
1424
|
/**
|
|
1425
|
+
* @public
|
|
1244
1426
|
* <p>The globally unique identifier for the identity store.</p>
|
|
1245
1427
|
*/
|
|
1246
1428
|
IdentityStoreId: string | undefined;
|
|
@@ -1250,10 +1432,12 @@ export interface User {
|
|
|
1250
1432
|
*/
|
|
1251
1433
|
export interface ListUsersResponse {
|
|
1252
1434
|
/**
|
|
1435
|
+
* @public
|
|
1253
1436
|
* <p>A list of <code>User</code> objects in the identity store.</p>
|
|
1254
1437
|
*/
|
|
1255
1438
|
Users: User[] | undefined;
|
|
1256
1439
|
/**
|
|
1440
|
+
* @public
|
|
1257
1441
|
* <p>The pagination token used for the <code>ListUsers</code> and <code>ListGroups</code> API
|
|
1258
1442
|
* operations. This value is generated by the identity store service. It is returned in the
|
|
1259
1443
|
* API response if the total results are more than the size of one page. This token is also
|
|
@@ -1266,14 +1450,17 @@ export interface ListUsersResponse {
|
|
|
1266
1450
|
*/
|
|
1267
1451
|
export interface UpdateUserRequest {
|
|
1268
1452
|
/**
|
|
1453
|
+
* @public
|
|
1269
1454
|
* <p>The globally unique identifier for the identity store.</p>
|
|
1270
1455
|
*/
|
|
1271
1456
|
IdentityStoreId: string | undefined;
|
|
1272
1457
|
/**
|
|
1458
|
+
* @public
|
|
1273
1459
|
* <p>The identifier for a user in the identity store.</p>
|
|
1274
1460
|
*/
|
|
1275
1461
|
UserId: string | undefined;
|
|
1276
1462
|
/**
|
|
1463
|
+
* @public
|
|
1277
1464
|
* <p>A list of <code>AttributeOperation</code> objects to apply to the requested user. These
|
|
1278
1465
|
* operations might add, replace, or remove an attribute.</p>
|
|
1279
1466
|
*/
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-identitystore",
|
|
3
3
|
"description": "AWS SDK for JavaScript Identitystore Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.385.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,15 +21,15 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.385.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.385.0",
|
|
26
26
|
"@aws-sdk/middleware-host-header": "3.379.1",
|
|
27
27
|
"@aws-sdk/middleware-logger": "3.378.0",
|
|
28
28
|
"@aws-sdk/middleware-recursion-detection": "3.378.0",
|
|
29
29
|
"@aws-sdk/middleware-signing": "3.379.1",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.382.0",
|
|
31
31
|
"@aws-sdk/types": "3.378.0",
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.382.0",
|
|
33
33
|
"@aws-sdk/util-user-agent-browser": "3.378.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-node": "3.378.0",
|
|
35
35
|
"@smithy/config-resolver": "^2.0.1",
|