-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Expand file tree
/
Copy pathindex.ts
More file actions
2290 lines (2190 loc) · 57.3 KB
/
index.ts
File metadata and controls
2290 lines (2190 loc) · 57.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright (c) Microsoft Corporation. All rights reserved.
* Licensed under the MIT License. See License.txt in the project root for
* license information.
*
* Code generated by Microsoft (R) AutoRest Code Generator.
* Changes may cause incorrect behavior and will be lost if the code is
* regenerated.
*/
import { BaseResource, CloudError, AzureServiceClientOptions } from "ms-rest-azure-js";
import * as msRest from "ms-rest-js";
export { BaseResource, CloudError };
/**
* @interface
* An interface representing GraphError.
* Active Directory error information.
*
*/
export interface GraphError {
/**
* @member {string} [code] Error code.
*/
code?: string;
/**
* @member {string} [message] Error message value.
*/
message?: string;
}
/**
* Contains the possible cases for DirectoryObject.
*/
export type DirectoryObjectUnion = DirectoryObject | Application | ADGroup | ServicePrincipal | User;
/**
* @interface
* An interface representing DirectoryObject.
* Represents an Azure Active Directory object.
*
*/
export interface DirectoryObject {
/**
* @member {string} objectType Polymorphic Discriminator
*/
objectType: "DirectoryObject";
/**
* @member {string} [objectId] The object ID.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly objectId?: string;
/**
* @member {Date} [deletionTimestamp] The time at which the directory object
* was deleted.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly deletionTimestamp?: Date;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing KeyCredential.
* Active Directory Key Credential information.
*
*/
export interface KeyCredential {
/**
* @member {Date} [startDate] Start date.
*/
startDate?: Date;
/**
* @member {Date} [endDate] End date.
*/
endDate?: Date;
/**
* @member {string} [value] Key value.
*/
value?: string;
/**
* @member {string} [keyId] Key ID.
*/
keyId?: string;
/**
* @member {string} [usage] Usage. Acceptable values are 'Verify' and 'Sign'.
*/
usage?: string;
/**
* @member {string} [type] Type. Acceptable values are 'AsymmetricX509Cert'
* and 'Symmetric'.
*/
type?: string;
/**
* @member {string} [customKeyIdentifier] Custom Key Identifier
*/
customKeyIdentifier?: string;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing PasswordCredential.
* Active Directory Password Credential information.
*
*/
export interface PasswordCredential {
/**
* @member {Date} [startDate] Start date.
*/
startDate?: Date;
/**
* @member {Date} [endDate] End date.
*/
endDate?: Date;
/**
* @member {string} [keyId] Key ID.
*/
keyId?: string;
/**
* @member {string} [value] Key value.
*/
value?: string;
/**
* @member {Uint8Array} [customKeyIdentifier] Custom Key Identifier
*/
customKeyIdentifier?: Uint8Array;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing ResourceAccess.
* Specifies an OAuth 2.0 permission scope or an app role that an application
* requires. The resourceAccess property of the RequiredResourceAccess type is
* a collection of ResourceAccess.
*
*/
export interface ResourceAccess {
/**
* @member {string} id The unique identifier for one of the OAuth2Permission
* or AppRole instances that the resource application exposes.
*/
id: string;
/**
* @member {string} [type] Specifies whether the id property references an
* OAuth2Permission or an AppRole. Possible values are "scope" or "role".
*/
type?: string;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing RequiredResourceAccess.
* Specifies the set of OAuth 2.0 permission scopes and app roles under the
* specified resource that an application requires access to. The specified
* OAuth 2.0 permission scopes may be requested by client applications (through
* the requiredResourceAccess collection) when calling a resource application.
* The requiredResourceAccess property of the Application entity is a
* collection of RequiredResourceAccess.
*
*/
export interface RequiredResourceAccess {
/**
* @member {ResourceAccess[]} resourceAccess The list of OAuth2.0 permission
* scopes and app roles that the application requires from the specified
* resource.
*/
resourceAccess: ResourceAccess[];
/**
* @member {string} [resourceAppId] The unique identifier for the resource
* that the application requires access to. This should be equal to the appId
* declared on the target resource application.
*/
resourceAppId?: string;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing AppRole.
*/
export interface AppRole {
/**
* @member {string} [id] Unique role identifier inside the appRoles
* collection.
*/
id?: string;
/**
* @member {string[]} [allowedMemberTypes] Specifies whether this app role
* definition can be assigned to users and groups by setting to 'User', or to
* other applications (that are accessing this application in daemon service
* scenarios) by setting to 'Application', or to both.
*/
allowedMemberTypes?: string[];
/**
* @member {string} [description] Permission help text that appears in the
* admin app assignment and consent experiences.
*/
description?: string;
/**
* @member {string} [displayName] Display name for the permission that
* appears in the admin consent and app assignment experiences.
*/
displayName?: string;
/**
* @member {boolean} [isEnabled] When creating or updating a role definition,
* this must be set to true (which is the default). To delete a role, this
* must first be set to false. At that point, in a subsequent call, this role
* may be removed.
*/
isEnabled?: boolean;
/**
* @member {string} [value] Specifies the value of the roles claim that the
* application should expect in the authentication and access tokens.
*/
value?: string;
}
/**
* @interface
* An interface representing ApplicationCreateParameters.
* Request parameters for creating a new application.
*
*/
export interface ApplicationCreateParameters {
/**
* @member {AppRole[]} [appRoles] The collection of application roles that an
* application may declare. These roles can be assigned to users, groups or
* service principals.
*/
appRoles?: AppRole[];
/**
* @member {boolean} availableToOtherTenants Whether the application is
* available to other tenants.
*/
availableToOtherTenants: boolean;
/**
* @member {string} displayName The display name of the application.
*/
displayName: string;
/**
* @member {string} [homepage] The home page of the application.
*/
homepage?: string;
/**
* @member {string[]} identifierUris A collection of URIs for the
* application.
*/
identifierUris: string[];
/**
* @member {string[]} [replyUrls] A collection of reply URLs for the
* application.
*/
replyUrls?: string[];
/**
* @member {KeyCredential[]} [keyCredentials] The list of KeyCredential
* objects.
*/
keyCredentials?: KeyCredential[];
/**
* @member {PasswordCredential[]} [passwordCredentials] The list of
* PasswordCredential objects.
*/
passwordCredentials?: PasswordCredential[];
/**
* @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit
* grant flow for OAuth2
*/
oauth2AllowImplicitFlow?: boolean;
/**
* @member {RequiredResourceAccess[]} [requiredResourceAccess] Specifies
* resources that this application requires access to and the set of OAuth
* permission scopes and application roles that it needs under each of those
* resources. This pre-configuration of required resource access drives the
* consent experience.
*/
requiredResourceAccess?: RequiredResourceAccess[];
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing ApplicationUpdateParameters.
* Request parameters for updating an existing application.
*
*/
export interface ApplicationUpdateParameters {
/**
* @member {AppRole[]} [appRoles] The collection of application roles that an
* application may declare. These roles can be assigned to users, groups or
* service principals.
*/
appRoles?: AppRole[];
/**
* @member {boolean} [availableToOtherTenants] Whether the application is
* available to other tenants
*/
availableToOtherTenants?: boolean;
/**
* @member {string} [displayName] The display name of the application.
*/
displayName?: string;
/**
* @member {string} [homepage] The home page of the application.
*/
homepage?: string;
/**
* @member {string[]} [identifierUris] A collection of URIs for the
* application.
*/
identifierUris?: string[];
/**
* @member {string[]} [replyUrls] A collection of reply URLs for the
* application.
*/
replyUrls?: string[];
/**
* @member {KeyCredential[]} [keyCredentials] The list of KeyCredential
* objects.
*/
keyCredentials?: KeyCredential[];
/**
* @member {PasswordCredential[]} [passwordCredentials] The list of
* PasswordCredential objects.
*/
passwordCredentials?: PasswordCredential[];
/**
* @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit
* grant flow for OAuth2
*/
oauth2AllowImplicitFlow?: boolean;
/**
* @member {RequiredResourceAccess[]} [requiredResourceAccess] Specifies
* resources that this application requires access to and the set of OAuth
* permission scopes and application roles that it needs under each of those
* resources. This pre-configuration of required resource access drives the
* consent experience.
*/
requiredResourceAccess?: RequiredResourceAccess[];
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing Application.
* Active Directory application information.
*
*/
export interface Application {
/**
* @member {string} objectType Polymorphic Discriminator
*/
objectType: "Application";
/**
* @member {string} [objectId] The object ID.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly objectId?: string;
/**
* @member {Date} [deletionTimestamp] The time at which the directory object
* was deleted.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly deletionTimestamp?: Date;
/**
* @member {string} [appId] The application ID.
*/
appId?: string;
/**
* @member {AppRole[]} [appRoles] The collection of application roles that an
* application may declare. These roles can be assigned to users, groups or
* service principals.
*/
appRoles?: AppRole[];
/**
* @member {string[]} [appPermissions] The application permissions.
*/
appPermissions?: string[];
/**
* @member {boolean} [availableToOtherTenants] Whether the application is be
* available to other tenants.
*/
availableToOtherTenants?: boolean;
/**
* @member {string} [displayName] The display name of the application.
*/
displayName?: string;
/**
* @member {string[]} [identifierUris] A collection of URIs for the
* application.
*/
identifierUris?: string[];
/**
* @member {string[]} [replyUrls] A collection of reply URLs for the
* application.
*/
replyUrls?: string[];
/**
* @member {string} [homepage] The home page of the application.
*/
homepage?: string;
/**
* @member {boolean} [oauth2AllowImplicitFlow] Whether to allow implicit
* grant flow for OAuth2
*/
oauth2AllowImplicitFlow?: boolean;
/**
* @member {RequiredResourceAccess[]} [requiredResourceAccess] Specifies
* resources that this application requires access to and the set of OAuth
* permission scopes and application roles that it needs under each of those
* resources. This pre-configuration of required resource access drives the
* consent experience.
*/
requiredResourceAccess?: RequiredResourceAccess[];
/**
* @member {KeyCredential[]} [keyCredentials] A collection of KeyCredential
* objects.
*/
keyCredentials?: KeyCredential[];
/**
* @member {PasswordCredential[]} [passwordCredentials] A collection of
* PasswordCredential objects
*/
passwordCredentials?: PasswordCredential[];
}
/**
* @interface
* An interface representing AddOwnerParameters.
* Request parameters for adding a owner to an application.
*
*/
export interface AddOwnerParameters {
/**
* @member {string} url A owner object URL, such as
* "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd",
* where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and
* "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the owner (user,
* application, servicePrincipal, group) to be added.
*/
url: string;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing KeyCredentialsUpdateParameters.
* Request parameters for a KeyCredentials update operation
*
*/
export interface KeyCredentialsUpdateParameters {
/**
* @member {KeyCredential[]} value A collection of KeyCredentials.
*/
value: KeyCredential[];
}
/**
* @interface
* An interface representing PasswordCredentialsUpdateParameters.
* Request parameters for a PasswordCredentials update operation.
*
*/
export interface PasswordCredentialsUpdateParameters {
/**
* @member {PasswordCredential[]} value A collection of PasswordCredentials.
*/
value: PasswordCredential[];
}
/**
* @interface
* An interface representing GroupAddMemberParameters.
* Request parameters for adding a member to a group.
*
*/
export interface GroupAddMemberParameters {
/**
* @member {string} url A member object URL, such as
* "https://graph.windows.net/0b1f9851-1bf0-433f-aec3-cb9272f093dc/directoryObjects/f260bbc4-c254-447b-94cf-293b5ec434dd",
* where "0b1f9851-1bf0-433f-aec3-cb9272f093dc" is the tenantId and
* "f260bbc4-c254-447b-94cf-293b5ec434dd" is the objectId of the member
* (user, application, servicePrincipal, group) to be added.
*/
url: string;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing GroupCreateParameters.
* Request parameters for creating a new group.
*
*/
export interface GroupCreateParameters {
/**
* @member {string} displayName Group display name
*/
displayName: string;
/**
* @member {string} mailNickname Mail nickname
*/
mailNickname: string;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing ADGroup.
* Active Directory group information.
*
*/
export interface ADGroup {
/**
* @member {string} objectType Polymorphic Discriminator
*/
objectType: "Group";
/**
* @member {string} [objectId] The object ID.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly objectId?: string;
/**
* @member {Date} [deletionTimestamp] The time at which the directory object
* was deleted.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly deletionTimestamp?: Date;
/**
* @member {string} [displayName] The display name of the group.
*/
displayName?: string;
/**
* @member {boolean} [mailEnabled] Whether the group is mail-enabled. Must be
* false. This is because only pure security groups can be created using the
* Graph API.
*/
mailEnabled?: boolean;
/**
* @member {string} [mailNickname] The mail alias for the group.
*/
mailNickname?: string;
/**
* @member {boolean} [securityEnabled] Whether the group is security-enable.
*/
securityEnabled?: boolean;
/**
* @member {string} [mail] The primary email address of the group.
*/
mail?: string;
}
/**
* @interface
* An interface representing GroupGetMemberGroupsParameters.
* Request parameters for GetMemberGroups API call.
*
*/
export interface GroupGetMemberGroupsParameters {
/**
* @member {boolean} securityEnabledOnly If true, only membership in
* security-enabled groups should be checked. Otherwise, membership in all
* groups should be checked.
*/
securityEnabledOnly: boolean;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing CheckGroupMembershipParameters.
* Request parameters for IsMemberOf API call.
*
*/
export interface CheckGroupMembershipParameters {
/**
* @member {string} groupId The object ID of the group to check.
*/
groupId: string;
/**
* @member {string} memberId The object ID of the contact, group, user, or
* service principal to check for membership in the specified group.
*/
memberId: string;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing CheckGroupMembershipResult.
* Server response for IsMemberOf API call
*
*/
export interface CheckGroupMembershipResult {
/**
* @member {boolean} [value] True if the specified user, group, contact, or
* service principal has either direct or transitive membership in the
* specified group; otherwise, false.
*/
value?: boolean;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing ServicePrincipalCreateParameters.
* Request parameters for creating a new service principal.
*
*/
export interface ServicePrincipalCreateParameters {
/**
* @member {boolean} [accountEnabled] Whether the account is enabled
*/
accountEnabled?: boolean;
/**
* @member {string} appId application Id
*/
appId: string;
/**
* @member {boolean} [appRoleAssignmentRequired] Specifies whether an
* AppRoleAssignment to a user or group is required before Azure AD will
* issue a user or access token to the application.
*/
appRoleAssignmentRequired?: boolean;
/**
* @member {string} [displayName] The display name for the service principal.
*/
displayName?: string;
/**
* @member {string} [errorUrl]
*/
errorUrl?: string;
/**
* @member {string} [homepage] The URL to the homepage of the associated
* application.
*/
homepage?: string;
/**
* @member {KeyCredential[]} [keyCredentials] A collection of KeyCredential
* objects.
*/
keyCredentials?: KeyCredential[];
/**
* @member {PasswordCredential[]} [passwordCredentials] A collection of
* PasswordCredential objects
*/
passwordCredentials?: PasswordCredential[];
/**
* @member {string} [publisherName] The display name of the tenant in which
* the associated application is specified.
*/
publisherName?: string;
/**
* @member {string[]} [replyUrls] A collection of reply URLs for the service
* principal.
*/
replyUrls?: string[];
/**
* @member {string} [samlMetadataUrl]
*/
samlMetadataUrl?: string;
/**
* @member {string[]} [servicePrincipalNames] A collection of service
* principal names.
*/
servicePrincipalNames?: string[];
/**
* @member {string[]} [tags]
*/
tags?: string[];
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing ServicePrincipalUpdateParameters.
* Request parameters for creating a new service principal.
*
*/
export interface ServicePrincipalUpdateParameters {
/**
* @member {boolean} [accountEnabled] Whether the account is enabled
*/
accountEnabled?: boolean;
/**
* @member {string} [appId] application Id
*/
appId?: string;
/**
* @member {boolean} [appRoleAssignmentRequired] Specifies whether an
* AppRoleAssignment to a user or group is required before Azure AD will
* issue a user or access token to the application.
*/
appRoleAssignmentRequired?: boolean;
/**
* @member {string} [displayName] The display name for the service principal.
*/
displayName?: string;
/**
* @member {string} [errorUrl]
*/
errorUrl?: string;
/**
* @member {string} [homepage] The URL to the homepage of the associated
* application.
*/
homepage?: string;
/**
* @member {KeyCredential[]} [keyCredentials] A collection of KeyCredential
* objects.
*/
keyCredentials?: KeyCredential[];
/**
* @member {PasswordCredential[]} [passwordCredentials] A collection of
* PasswordCredential objects
*/
passwordCredentials?: PasswordCredential[];
/**
* @member {string} [publisherName] The display name of the tenant in which
* the associated application is specified.
*/
publisherName?: string;
/**
* @member {string[]} [replyUrls] A collection of reply URLs for the service
* principal.
*/
replyUrls?: string[];
/**
* @member {string} [samlMetadataUrl]
*/
samlMetadataUrl?: string;
/**
* @member {string[]} [servicePrincipalNames] A collection of service
* principal names.
*/
servicePrincipalNames?: string[];
/**
* @member {string[]} [tags]
*/
tags?: string[];
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing ServicePrincipal.
* Active Directory service principal information.
*
*/
export interface ServicePrincipal {
/**
* @member {string} objectType Polymorphic Discriminator
*/
objectType: "ServicePrincipal";
/**
* @member {string} [objectId] The object ID.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly objectId?: string;
/**
* @member {Date} [deletionTimestamp] The time at which the directory object
* was deleted.
* **NOTE: This property will not be serialized. It can only be populated by
* the server.**
*/
readonly deletionTimestamp?: Date;
/**
* @member {string} [displayName] The display name of the service principal.
*/
displayName?: string;
/**
* @member {string} [appId] The application ID.
*/
appId?: string;
/**
* @member {AppRole[]} [appRoles] The collection of application roles that an
* application may declare. These roles can be assigned to users, groups or
* service principals.
*/
appRoles?: AppRole[];
/**
* @member {string[]} [servicePrincipalNames] A collection of service
* principal names.
*/
servicePrincipalNames?: string[];
}
/**
* @interface
* An interface representing PasswordProfile.
* The password profile associated with a user.
*
*/
export interface PasswordProfile {
/**
* @member {string} password Password
*/
password: string;
/**
* @member {boolean} [forceChangePasswordNextLogin] Whether to force a
* password change on next login.
*/
forceChangePasswordNextLogin?: boolean;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing UserBase.
*/
export interface UserBase {
/**
* @member {string} [immutableId] This must be specified if you are using a
* federated domain for the user's userPrincipalName (UPN) property when
* creating a new user account. It is used to associate an on-premises Active
* Directory user account with their Azure AD user object.
*/
immutableId?: string;
/**
* @member {string} [usageLocation] A two letter country code (ISO standard
* 3166). Required for users that will be assigned licenses due to legal
* requirement to check for availability of services in countries. Examples
* include: "US", "JP", and "GB".
*/
usageLocation?: string;
/**
* @member {string} [givenName] The given name for the user.
*/
givenName?: string;
/**
* @member {string} [surname] The user's surname (family name or last name).
*/
surname?: string;
/**
* @member {UserType} [userType] A string value that can be used to classify
* user types in your directory, such as 'Member' and 'Guest'. Possible
* values include: 'Member', 'Guest'
*/
userType?: UserType;
/**
* @property Describes unknown properties. The value of an unknown property
* can be of "any" type.
*/
[property: string]: any;
}
/**
* @interface
* An interface representing UserCreateParameters.
* Request parameters for creating a new work or school account user.
*
* @extends UserBase
*/
export interface UserCreateParameters extends UserBase {
/**
* @member {boolean} accountEnabled Whether the account is enabled.
*/
accountEnabled: boolean;
/**
* @member {string} displayName The display name of the user.
*/
displayName: string;
/**
* @member {PasswordProfile} passwordProfile Password Profile
*/
passwordProfile: PasswordProfile;
/**
* @member {string} userPrincipalName The user principal name
* (someuser@contoso.com). It must contain one of the verified domains for
* the tenant.
*/
userPrincipalName: string;
/**
* @member {string} mailNickname The mail alias for the user.
*/
mailNickname: string;
/**
* @member {string} [mail] The primary email address of the user.
*/
mail?: string;
}
/**
* @interface
* An interface representing UserUpdateParameters.
* Request parameters for updating an existing work or school account user.
*
* @extends UserBase
*/
export interface UserUpdateParameters extends UserBase {
/**
* @member {boolean} [accountEnabled] Whether the account is enabled.
*/
accountEnabled?: boolean;
/**
* @member {string} [displayName] The display name of the user.
*/
displayName?: string;
/**
* @member {PasswordProfile} [passwordProfile] The password profile of the
* user.
*/
passwordProfile?: PasswordProfile;
/**
* @member {string} [userPrincipalName] The user principal name
* (someuser@contoso.com). It must contain one of the verified domains for
* the tenant.
*/
userPrincipalName?: string;
/**
* @member {string} [mailNickname] The mail alias for the user.
*/
mailNickname?: string;
}
/**
* @interface
* An interface representing SignInName.
* Contains information about a sign-in name of a local account user in an
* Azure Active Directory B2C tenant.
*
*/
export interface SignInName {
/**
* @member {string} [type] A string value that can be used to classify user