@alicloud/cloudsso20210515 1.0.2 → 1.2.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/client.d.ts CHANGED
@@ -436,6 +436,54 @@ export declare class CreateUserResponse extends $tea.Model {
436
436
  [key: string]: any;
437
437
  });
438
438
  }
439
+ export declare class CreateUserProvisioningRequest extends $tea.Model {
440
+ deletionStrategy?: string;
441
+ description?: string;
442
+ directoryId?: string;
443
+ duplicationStrategy?: string;
444
+ principalId?: string;
445
+ principalType?: string;
446
+ targetId?: string;
447
+ targetType?: string;
448
+ static names(): {
449
+ [key: string]: string;
450
+ };
451
+ static types(): {
452
+ [key: string]: any;
453
+ };
454
+ constructor(map?: {
455
+ [key: string]: any;
456
+ });
457
+ }
458
+ export declare class CreateUserProvisioningResponseBody extends $tea.Model {
459
+ requestId?: string;
460
+ userProvisioning?: CreateUserProvisioningResponseBodyUserProvisioning;
461
+ static names(): {
462
+ [key: string]: string;
463
+ };
464
+ static types(): {
465
+ [key: string]: any;
466
+ };
467
+ constructor(map?: {
468
+ [key: string]: any;
469
+ });
470
+ }
471
+ export declare class CreateUserProvisioningResponse extends $tea.Model {
472
+ headers: {
473
+ [key: string]: string;
474
+ };
475
+ statusCode: number;
476
+ body: CreateUserProvisioningResponseBody;
477
+ static names(): {
478
+ [key: string]: string;
479
+ };
480
+ static types(): {
481
+ [key: string]: any;
482
+ };
483
+ constructor(map?: {
484
+ [key: string]: any;
485
+ });
486
+ }
439
487
  export declare class DeleteAccessAssignmentRequest extends $tea.Model {
440
488
  accessConfigurationId?: string;
441
489
  deprovisionStrategy?: string;
@@ -730,6 +778,48 @@ export declare class DeleteUserResponse extends $tea.Model {
730
778
  [key: string]: any;
731
779
  });
732
780
  }
781
+ export declare class DeleteUserProvisioningRequest extends $tea.Model {
782
+ deletionStrategy?: string;
783
+ directoryId?: string;
784
+ userProvisioningId?: string;
785
+ static names(): {
786
+ [key: string]: string;
787
+ };
788
+ static types(): {
789
+ [key: string]: any;
790
+ };
791
+ constructor(map?: {
792
+ [key: string]: any;
793
+ });
794
+ }
795
+ export declare class DeleteUserProvisioningResponseBody extends $tea.Model {
796
+ requestId?: string;
797
+ static names(): {
798
+ [key: string]: string;
799
+ };
800
+ static types(): {
801
+ [key: string]: any;
802
+ };
803
+ constructor(map?: {
804
+ [key: string]: any;
805
+ });
806
+ }
807
+ export declare class DeleteUserProvisioningResponse extends $tea.Model {
808
+ headers: {
809
+ [key: string]: string;
810
+ };
811
+ statusCode: number;
812
+ body: DeleteUserProvisioningResponseBody;
813
+ static names(): {
814
+ [key: string]: string;
815
+ };
816
+ static types(): {
817
+ [key: string]: any;
818
+ };
819
+ constructor(map?: {
820
+ [key: string]: any;
821
+ });
822
+ }
733
823
  export declare class DeprovisionAccessConfigurationRequest extends $tea.Model {
734
824
  accessConfigurationId?: string;
735
825
  directoryId?: string;
@@ -1078,6 +1168,47 @@ export declare class GetGroupResponse extends $tea.Model {
1078
1168
  [key: string]: any;
1079
1169
  });
1080
1170
  }
1171
+ export declare class GetMFAAuthenticationSettingInfoRequest extends $tea.Model {
1172
+ directoryId?: string;
1173
+ static names(): {
1174
+ [key: string]: string;
1175
+ };
1176
+ static types(): {
1177
+ [key: string]: any;
1178
+ };
1179
+ constructor(map?: {
1180
+ [key: string]: any;
1181
+ });
1182
+ }
1183
+ export declare class GetMFAAuthenticationSettingInfoResponseBody extends $tea.Model {
1184
+ MFAAuthenticationSettingInfo?: GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo;
1185
+ requestId?: string;
1186
+ static names(): {
1187
+ [key: string]: string;
1188
+ };
1189
+ static types(): {
1190
+ [key: string]: any;
1191
+ };
1192
+ constructor(map?: {
1193
+ [key: string]: any;
1194
+ });
1195
+ }
1196
+ export declare class GetMFAAuthenticationSettingInfoResponse extends $tea.Model {
1197
+ headers: {
1198
+ [key: string]: string;
1199
+ };
1200
+ statusCode: number;
1201
+ body: GetMFAAuthenticationSettingInfoResponseBody;
1202
+ static names(): {
1203
+ [key: string]: string;
1204
+ };
1205
+ static types(): {
1206
+ [key: string]: any;
1207
+ };
1208
+ constructor(map?: {
1209
+ [key: string]: any;
1210
+ });
1211
+ }
1081
1212
  export declare class GetMFAAuthenticationSettingsRequest extends $tea.Model {
1082
1213
  directoryId?: string;
1083
1214
  static names(): {
@@ -1398,6 +1529,48 @@ export declare class GetUserMFAAuthenticationSettingsResponse extends $tea.Model
1398
1529
  [key: string]: any;
1399
1530
  });
1400
1531
  }
1532
+ export declare class GetUserProvisioningRequest extends $tea.Model {
1533
+ directoryId?: string;
1534
+ userProvisioningId?: string;
1535
+ static names(): {
1536
+ [key: string]: string;
1537
+ };
1538
+ static types(): {
1539
+ [key: string]: any;
1540
+ };
1541
+ constructor(map?: {
1542
+ [key: string]: any;
1543
+ });
1544
+ }
1545
+ export declare class GetUserProvisioningResponseBody extends $tea.Model {
1546
+ requestId?: string;
1547
+ userProvisioning?: GetUserProvisioningResponseBodyUserProvisioning;
1548
+ static names(): {
1549
+ [key: string]: string;
1550
+ };
1551
+ static types(): {
1552
+ [key: string]: any;
1553
+ };
1554
+ constructor(map?: {
1555
+ [key: string]: any;
1556
+ });
1557
+ }
1558
+ export declare class GetUserProvisioningResponse extends $tea.Model {
1559
+ headers: {
1560
+ [key: string]: string;
1561
+ };
1562
+ statusCode: number;
1563
+ body: GetUserProvisioningResponseBody;
1564
+ static names(): {
1565
+ [key: string]: string;
1566
+ };
1567
+ static types(): {
1568
+ [key: string]: any;
1569
+ };
1570
+ constructor(map?: {
1571
+ [key: string]: any;
1572
+ });
1573
+ }
1401
1574
  export declare class ListAccessAssignmentsRequest extends $tea.Model {
1402
1575
  accessConfigurationId?: string;
1403
1576
  directoryId?: string;
@@ -1951,6 +2124,57 @@ export declare class ListTasksResponse extends $tea.Model {
1951
2124
  [key: string]: any;
1952
2125
  });
1953
2126
  }
2127
+ export declare class ListUserProvisioningsRequest extends $tea.Model {
2128
+ directoryId?: string;
2129
+ maxResults?: number;
2130
+ nextToken?: string;
2131
+ principalId?: string;
2132
+ principalType?: string;
2133
+ targetId?: string;
2134
+ targetType?: string;
2135
+ static names(): {
2136
+ [key: string]: string;
2137
+ };
2138
+ static types(): {
2139
+ [key: string]: any;
2140
+ };
2141
+ constructor(map?: {
2142
+ [key: string]: any;
2143
+ });
2144
+ }
2145
+ export declare class ListUserProvisioningsResponseBody extends $tea.Model {
2146
+ isTruncated?: boolean;
2147
+ maxResults?: number;
2148
+ nextToken?: string;
2149
+ requestId?: string;
2150
+ totalCounts?: number;
2151
+ userProvisionings?: ListUserProvisioningsResponseBodyUserProvisionings[];
2152
+ static names(): {
2153
+ [key: string]: string;
2154
+ };
2155
+ static types(): {
2156
+ [key: string]: any;
2157
+ };
2158
+ constructor(map?: {
2159
+ [key: string]: any;
2160
+ });
2161
+ }
2162
+ export declare class ListUserProvisioningsResponse extends $tea.Model {
2163
+ headers: {
2164
+ [key: string]: string;
2165
+ };
2166
+ statusCode: number;
2167
+ body: ListUserProvisioningsResponseBody;
2168
+ static names(): {
2169
+ [key: string]: string;
2170
+ };
2171
+ static types(): {
2172
+ [key: string]: any;
2173
+ };
2174
+ constructor(map?: {
2175
+ [key: string]: any;
2176
+ });
2177
+ }
1954
2178
  export declare class ListUsersRequest extends $tea.Model {
1955
2179
  directoryId?: string;
1956
2180
  filter?: string;
@@ -2693,6 +2917,51 @@ export declare class UpdateUserMFAAuthenticationSettingsResponse extends $tea.Mo
2693
2917
  [key: string]: any;
2694
2918
  });
2695
2919
  }
2920
+ export declare class UpdateUserProvisioningRequest extends $tea.Model {
2921
+ directoryId?: string;
2922
+ newDeletionStrategy?: string;
2923
+ newDescription?: string;
2924
+ newDuplicationStrategy?: string;
2925
+ userProvisioningId?: string;
2926
+ static names(): {
2927
+ [key: string]: string;
2928
+ };
2929
+ static types(): {
2930
+ [key: string]: any;
2931
+ };
2932
+ constructor(map?: {
2933
+ [key: string]: any;
2934
+ });
2935
+ }
2936
+ export declare class UpdateUserProvisioningResponseBody extends $tea.Model {
2937
+ requestId?: string;
2938
+ userProvisioning?: UpdateUserProvisioningResponseBodyUserProvisioning;
2939
+ static names(): {
2940
+ [key: string]: string;
2941
+ };
2942
+ static types(): {
2943
+ [key: string]: any;
2944
+ };
2945
+ constructor(map?: {
2946
+ [key: string]: any;
2947
+ });
2948
+ }
2949
+ export declare class UpdateUserProvisioningResponse extends $tea.Model {
2950
+ headers: {
2951
+ [key: string]: string;
2952
+ };
2953
+ statusCode: number;
2954
+ body: UpdateUserProvisioningResponseBody;
2955
+ static names(): {
2956
+ [key: string]: string;
2957
+ };
2958
+ static types(): {
2959
+ [key: string]: any;
2960
+ };
2961
+ constructor(map?: {
2962
+ [key: string]: any;
2963
+ });
2964
+ }
2696
2965
  export declare class UpdateUserStatusRequest extends $tea.Model {
2697
2966
  directoryId?: string;
2698
2967
  newStatus?: string;
@@ -2851,6 +3120,33 @@ export declare class CreateUserResponseBodyUser extends $tea.Model {
2851
3120
  [key: string]: any;
2852
3121
  });
2853
3122
  }
3123
+ export declare class CreateUserProvisioningResponseBodyUserProvisioning extends $tea.Model {
3124
+ createTime?: string;
3125
+ deletionStrategy?: string;
3126
+ description?: string;
3127
+ directoryId?: string;
3128
+ duplicationStrategy?: string;
3129
+ ownerPk?: string;
3130
+ principalId?: string;
3131
+ principalName?: string;
3132
+ principalType?: string;
3133
+ status?: string;
3134
+ targetId?: string;
3135
+ targetName?: string;
3136
+ targetPath?: string;
3137
+ targetType?: string;
3138
+ updateTime?: string;
3139
+ userProvisioningId?: string;
3140
+ static names(): {
3141
+ [key: string]: string;
3142
+ };
3143
+ static types(): {
3144
+ [key: string]: any;
3145
+ };
3146
+ constructor(map?: {
3147
+ [key: string]: any;
3148
+ });
3149
+ }
2854
3150
  export declare class DeleteAccessAssignmentResponseBodyTask extends $tea.Model {
2855
3151
  accessConfigurationId?: string;
2856
3152
  accessConfigurationName?: string;
@@ -2959,6 +3255,7 @@ export declare class GetDirectoryStatisticsResponseBodyDirectoryStatistics exten
2959
3255
  SCIMServerCredentialCount?: number;
2960
3256
  SCIMSyncEnabled?: boolean;
2961
3257
  SSOEnabled?: boolean;
3258
+ systemPolicyPerAccessConfigurationQuota?: number;
2962
3259
  userCount?: number;
2963
3260
  userQuota?: number;
2964
3261
  static names(): {
@@ -3008,6 +3305,19 @@ export declare class GetGroupResponseBodyGroup extends $tea.Model {
3008
3305
  [key: string]: any;
3009
3306
  });
3010
3307
  }
3308
+ export declare class GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo extends $tea.Model {
3309
+ mfaAuthenticationAdvanceSettings?: string;
3310
+ operationForRiskLogin?: string;
3311
+ static names(): {
3312
+ [key: string]: string;
3313
+ };
3314
+ static types(): {
3315
+ [key: string]: any;
3316
+ };
3317
+ constructor(map?: {
3318
+ [key: string]: any;
3319
+ });
3320
+ }
3011
3321
  export declare class GetServiceStatusResponseBodyServiceStatus extends $tea.Model {
3012
3322
  accountId?: string;
3013
3323
  prerequisiteCheckResult?: string;
@@ -3089,6 +3399,33 @@ export declare class GetUserResponseBodyUser extends $tea.Model {
3089
3399
  [key: string]: any;
3090
3400
  });
3091
3401
  }
3402
+ export declare class GetUserProvisioningResponseBodyUserProvisioning extends $tea.Model {
3403
+ createTime?: string;
3404
+ deletionStrategy?: string;
3405
+ description?: string;
3406
+ directoryId?: string;
3407
+ duplicationStrategy?: string;
3408
+ ownerPk?: string;
3409
+ principalId?: string;
3410
+ principalName?: string;
3411
+ principalType?: string;
3412
+ status?: string;
3413
+ targetId?: string;
3414
+ targetName?: string;
3415
+ targetPath?: string;
3416
+ targetType?: string;
3417
+ updateTime?: string;
3418
+ userProvisioningId?: string;
3419
+ static names(): {
3420
+ [key: string]: string;
3421
+ };
3422
+ static types(): {
3423
+ [key: string]: any;
3424
+ };
3425
+ constructor(map?: {
3426
+ [key: string]: any;
3427
+ });
3428
+ }
3092
3429
  export declare class ListAccessAssignmentsResponseBodyAccessAssignments extends $tea.Model {
3093
3430
  accessConfigurationId?: string;
3094
3431
  accessConfigurationName?: string;
@@ -3320,6 +3657,33 @@ export declare class ListTasksResponseBodyTasks extends $tea.Model {
3320
3657
  [key: string]: any;
3321
3658
  });
3322
3659
  }
3660
+ export declare class ListUserProvisioningsResponseBodyUserProvisionings extends $tea.Model {
3661
+ createTime?: string;
3662
+ deletionStrategy?: string;
3663
+ description?: string;
3664
+ directoryId?: string;
3665
+ duplicationStrategy?: string;
3666
+ ownerPk?: string;
3667
+ principalId?: string;
3668
+ principalName?: string;
3669
+ principalType?: string;
3670
+ status?: string;
3671
+ targetId?: string;
3672
+ targetName?: string;
3673
+ targetPath?: string;
3674
+ targetType?: string;
3675
+ updateTime?: string;
3676
+ userProvisioningId?: string;
3677
+ static names(): {
3678
+ [key: string]: string;
3679
+ };
3680
+ static types(): {
3681
+ [key: string]: any;
3682
+ };
3683
+ constructor(map?: {
3684
+ [key: string]: any;
3685
+ });
3686
+ }
3323
3687
  export declare class ListUsersResponseBodyUsers extends $tea.Model {
3324
3688
  createTime?: string;
3325
3689
  description?: string;
@@ -3474,137 +3838,1143 @@ export declare class UpdateUserResponseBodyUser extends $tea.Model {
3474
3838
  [key: string]: any;
3475
3839
  });
3476
3840
  }
3841
+ export declare class UpdateUserProvisioningResponseBodyUserProvisioning extends $tea.Model {
3842
+ createTime?: string;
3843
+ deletionStrategy?: string;
3844
+ description?: string;
3845
+ directoryId?: string;
3846
+ duplicationStrategy?: string;
3847
+ ownerPk?: string;
3848
+ principalId?: string;
3849
+ principalName?: string;
3850
+ principalType?: string;
3851
+ status?: string;
3852
+ targetId?: string;
3853
+ targetName?: string;
3854
+ targetPath?: string;
3855
+ targetType?: string;
3856
+ updateTime?: string;
3857
+ userProvisioningId?: string;
3858
+ static names(): {
3859
+ [key: string]: string;
3860
+ };
3861
+ static types(): {
3862
+ [key: string]: any;
3863
+ };
3864
+ constructor(map?: {
3865
+ [key: string]: any;
3866
+ });
3867
+ }
3477
3868
  export default class Client extends OpenApi {
3478
3869
  constructor(config: $OpenApi.Config);
3479
3870
  getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
3480
3871
  [key: string]: string;
3481
3872
  }, endpoint: string): string;
3873
+ /**
3874
+ * You can add up to two SAML signing certificates.
3875
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
3876
+ *
3877
+ * @param request AddExternalSAMLIdPCertificateRequest
3878
+ * @param runtime runtime options for this request RuntimeOptions
3879
+ * @return AddExternalSAMLIdPCertificateResponse
3880
+ */
3482
3881
  addExternalSAMLIdPCertificateWithOptions(request: AddExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<AddExternalSAMLIdPCertificateResponse>;
3882
+ /**
3883
+ * You can add up to two SAML signing certificates.
3884
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
3885
+ *
3886
+ * @param request AddExternalSAMLIdPCertificateRequest
3887
+ * @return AddExternalSAMLIdPCertificateResponse
3888
+ */
3483
3889
  addExternalSAMLIdPCertificate(request: AddExternalSAMLIdPCertificateRequest): Promise<AddExternalSAMLIdPCertificateResponse>;
3890
+ /**
3891
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
3892
+ *
3893
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
3894
+ * @param runtime runtime options for this request RuntimeOptions
3895
+ * @return AddPermissionPolicyToAccessConfigurationResponse
3896
+ */
3484
3897
  addPermissionPolicyToAccessConfigurationWithOptions(request: AddPermissionPolicyToAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<AddPermissionPolicyToAccessConfigurationResponse>;
3898
+ /**
3899
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
3900
+ *
3901
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
3902
+ * @return AddPermissionPolicyToAccessConfigurationResponse
3903
+ */
3485
3904
  addPermissionPolicyToAccessConfiguration(request: AddPermissionPolicyToAccessConfigurationRequest): Promise<AddPermissionPolicyToAccessConfigurationResponse>;
3905
+ /**
3906
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
3907
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
3908
+ *
3909
+ * @param request AddUserToGroupRequest
3910
+ * @param runtime runtime options for this request RuntimeOptions
3911
+ * @return AddUserToGroupResponse
3912
+ */
3486
3913
  addUserToGroupWithOptions(request: AddUserToGroupRequest, runtime: $Util.RuntimeOptions): Promise<AddUserToGroupResponse>;
3914
+ /**
3915
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
3916
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
3917
+ *
3918
+ * @param request AddUserToGroupRequest
3919
+ * @return AddUserToGroupResponse
3920
+ */
3487
3921
  addUserToGroup(request: AddUserToGroupRequest): Promise<AddUserToGroupResponse>;
3922
+ /**
3923
+ * If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
3924
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
3925
+ *
3926
+ * @param request ClearExternalSAMLIdentityProviderRequest
3927
+ * @param runtime runtime options for this request RuntimeOptions
3928
+ * @return ClearExternalSAMLIdentityProviderResponse
3929
+ */
3488
3930
  clearExternalSAMLIdentityProviderWithOptions(request: ClearExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<ClearExternalSAMLIdentityProviderResponse>;
3931
+ /**
3932
+ * If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
3933
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
3934
+ *
3935
+ * @param request ClearExternalSAMLIdentityProviderRequest
3936
+ * @return ClearExternalSAMLIdentityProviderResponse
3937
+ */
3489
3938
  clearExternalSAMLIdentityProvider(request: ClearExternalSAMLIdentityProviderRequest): Promise<ClearExternalSAMLIdentityProviderResponse>;
3939
+ /**
3940
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of task execution by using the value of the `TaskId` response parameter.
3941
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
3942
+ * This topic provides an example on how to assign access permissions on the account `114240524784****` in your resource directory to the CloudSSO user `u-00q8wbq42wiltcrk****` by using the access configuration `ac-00jhtfl8thteu6uj****`. After the call is successful, the CloudSSO user can access resources within the account in the resource directory.
3943
+ *
3944
+ * @param request CreateAccessAssignmentRequest
3945
+ * @param runtime runtime options for this request RuntimeOptions
3946
+ * @return CreateAccessAssignmentResponse
3947
+ */
3490
3948
  createAccessAssignmentWithOptions(request: CreateAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessAssignmentResponse>;
3949
+ /**
3950
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of task execution by using the value of the `TaskId` response parameter.
3951
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
3952
+ * This topic provides an example on how to assign access permissions on the account `114240524784****` in your resource directory to the CloudSSO user `u-00q8wbq42wiltcrk****` by using the access configuration `ac-00jhtfl8thteu6uj****`. After the call is successful, the CloudSSO user can access resources within the account in the resource directory.
3953
+ *
3954
+ * @param request CreateAccessAssignmentRequest
3955
+ * @return CreateAccessAssignmentResponse
3956
+ */
3491
3957
  createAccessAssignment(request: CreateAccessAssignmentRequest): Promise<CreateAccessAssignmentResponse>;
3958
+ /**
3959
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
3960
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
3961
+ *
3962
+ * @param request CreateAccessConfigurationRequest
3963
+ * @param runtime runtime options for this request RuntimeOptions
3964
+ * @return CreateAccessConfigurationResponse
3965
+ */
3492
3966
  createAccessConfigurationWithOptions(request: CreateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessConfigurationResponse>;
3967
+ /**
3968
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
3969
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
3970
+ *
3971
+ * @param request CreateAccessConfigurationRequest
3972
+ * @return CreateAccessConfigurationResponse
3973
+ */
3493
3974
  createAccessConfiguration(request: CreateAccessConfigurationRequest): Promise<CreateAccessConfigurationResponse>;
3975
+ /**
3976
+ * A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
3977
+ * To create a directory, you must select a region. Alibaba Cloud stores data in the directory only in the region that you select. However, you can deploy Alibaba Cloud resources including Elastic Compute Service (ECS) instances and ApsaraDB RDS instances in other regions. You can also use your cloud account for logons and access the Alibaba Cloud resources in other regions. You can select a region to create a directory based on your security compliance requirements and the geographic location of specific users. If you do not have strict security compliance requirements, we recommend that you select a region that is the closest to the geographical location of the specific users. This way, access to cloud resources is accelerated. You can create the CloudSSO directory in the China (Shanghai), China (Hong Kong), US (Silicon Valley), or Germany (Frankfurt) region.
3978
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
3979
+ * ## Limits
3980
+ * - You can create only one directory for a management account.
3981
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
3982
+ *
3983
+ * @param request CreateDirectoryRequest
3984
+ * @param runtime runtime options for this request RuntimeOptions
3985
+ * @return CreateDirectoryResponse
3986
+ */
3494
3987
  createDirectoryWithOptions(request: CreateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<CreateDirectoryResponse>;
3988
+ /**
3989
+ * A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
3990
+ * To create a directory, you must select a region. Alibaba Cloud stores data in the directory only in the region that you select. However, you can deploy Alibaba Cloud resources including Elastic Compute Service (ECS) instances and ApsaraDB RDS instances in other regions. You can also use your cloud account for logons and access the Alibaba Cloud resources in other regions. You can select a region to create a directory based on your security compliance requirements and the geographic location of specific users. If you do not have strict security compliance requirements, we recommend that you select a region that is the closest to the geographical location of the specific users. This way, access to cloud resources is accelerated. You can create the CloudSSO directory in the China (Shanghai), China (Hong Kong), US (Silicon Valley), or Germany (Frankfurt) region.
3991
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
3992
+ * ## Limits
3993
+ * - You can create only one directory for a management account.
3994
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
3995
+ *
3996
+ * @param request CreateDirectoryRequest
3997
+ * @return CreateDirectoryResponse
3998
+ */
3495
3999
  createDirectory(request: CreateDirectoryRequest): Promise<CreateDirectoryResponse>;
4000
+ /**
4001
+ * This topic provides an example on how to create a group named `TestGroup`.
4002
+ *
4003
+ * @param request CreateGroupRequest
4004
+ * @param runtime runtime options for this request RuntimeOptions
4005
+ * @return CreateGroupResponse
4006
+ */
3496
4007
  createGroupWithOptions(request: CreateGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateGroupResponse>;
4008
+ /**
4009
+ * This topic provides an example on how to create a group named `TestGroup`.
4010
+ *
4011
+ * @param request CreateGroupRequest
4012
+ * @return CreateGroupResponse
4013
+ */
3497
4014
  createGroup(request: CreateGroupRequest): Promise<CreateGroupResponse>;
4015
+ /**
4016
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
4017
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
4018
+ *
4019
+ * @param request CreateSCIMServerCredentialRequest
4020
+ * @param runtime runtime options for this request RuntimeOptions
4021
+ * @return CreateSCIMServerCredentialResponse
4022
+ */
3498
4023
  createSCIMServerCredentialWithOptions(request: CreateSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<CreateSCIMServerCredentialResponse>;
4024
+ /**
4025
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
4026
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
4027
+ *
4028
+ * @param request CreateSCIMServerCredentialRequest
4029
+ * @return CreateSCIMServerCredentialResponse
4030
+ */
3499
4031
  createSCIMServerCredential(request: CreateSCIMServerCredentialRequest): Promise<CreateSCIMServerCredentialResponse>;
4032
+ /**
4033
+ * This topic provides an example on how to create a user named `Alice`.
4034
+ *
4035
+ * @param request CreateUserRequest
4036
+ * @param runtime runtime options for this request RuntimeOptions
4037
+ * @return CreateUserResponse
4038
+ */
3500
4039
  createUserWithOptions(request: CreateUserRequest, runtime: $Util.RuntimeOptions): Promise<CreateUserResponse>;
4040
+ /**
4041
+ * This topic provides an example on how to create a user named `Alice`.
4042
+ *
4043
+ * @param request CreateUserRequest
4044
+ * @return CreateUserResponse
4045
+ */
3501
4046
  createUser(request: CreateUserRequest): Promise<CreateUserResponse>;
4047
+ createUserProvisioningWithOptions(request: CreateUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<CreateUserProvisioningResponse>;
4048
+ createUserProvisioning(request: CreateUserProvisioningRequest): Promise<CreateUserProvisioningResponse>;
4049
+ /**
4050
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
4051
+ * This topic provides an example on how to remove the access permissions on the account `114240524784****` in the resource directory from the CloudSSO user `u-00q8wbq42wiltcrk****`. The access permissions are assigned by using the access configuration `ac-00jhtfl8thteu6uj****`.
4052
+ *
4053
+ * @param request DeleteAccessAssignmentRequest
4054
+ * @param runtime runtime options for this request RuntimeOptions
4055
+ * @return DeleteAccessAssignmentResponse
4056
+ */
3502
4057
  deleteAccessAssignmentWithOptions(request: DeleteAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessAssignmentResponse>;
4058
+ /**
4059
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
4060
+ * This topic provides an example on how to remove the access permissions on the account `114240524784****` in the resource directory from the CloudSSO user `u-00q8wbq42wiltcrk****`. The access permissions are assigned by using the access configuration `ac-00jhtfl8thteu6uj****`.
4061
+ *
4062
+ * @param request DeleteAccessAssignmentRequest
4063
+ * @return DeleteAccessAssignmentResponse
4064
+ */
3503
4065
  deleteAccessAssignment(request: DeleteAccessAssignmentRequest): Promise<DeleteAccessAssignmentResponse>;
4066
+ /**
4067
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
4068
+ * ## Prerequisites
4069
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
4070
+ *
4071
+ * @param request DeleteAccessConfigurationRequest
4072
+ * @param runtime runtime options for this request RuntimeOptions
4073
+ * @return DeleteAccessConfigurationResponse
4074
+ */
3504
4075
  deleteAccessConfigurationWithOptions(request: DeleteAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessConfigurationResponse>;
4076
+ /**
4077
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
4078
+ * ## Prerequisites
4079
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
4080
+ *
4081
+ * @param request DeleteAccessConfigurationRequest
4082
+ * @return DeleteAccessConfigurationResponse
4083
+ */
3505
4084
  deleteAccessConfiguration(request: DeleteAccessConfigurationRequest): Promise<DeleteAccessConfigurationResponse>;
4085
+ /**
4086
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
4087
+ * ## Prerequisites
4088
+ * No resources are contained in the directory that you want to delete.
4089
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
4090
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
4091
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
4092
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
4093
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
4094
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
4095
+ *
4096
+ * @param request DeleteDirectoryRequest
4097
+ * @param runtime runtime options for this request RuntimeOptions
4098
+ * @return DeleteDirectoryResponse
4099
+ */
3506
4100
  deleteDirectoryWithOptions(request: DeleteDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDirectoryResponse>;
4101
+ /**
4102
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
4103
+ * ## Prerequisites
4104
+ * No resources are contained in the directory that you want to delete.
4105
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
4106
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
4107
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
4108
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
4109
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
4110
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
4111
+ *
4112
+ * @param request DeleteDirectoryRequest
4113
+ * @return DeleteDirectoryResponse
4114
+ */
3507
4115
  deleteDirectory(request: DeleteDirectoryRequest): Promise<DeleteDirectoryResponse>;
4116
+ /**
4117
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
4118
+ * ## Prerequisites
4119
+ * The group that you want to delete is not associated with the following resources. If the group is associated with the resources, the deletion fails.
4120
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
4121
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
4122
+ *
4123
+ * @param request DeleteGroupRequest
4124
+ * @param runtime runtime options for this request RuntimeOptions
4125
+ * @return DeleteGroupResponse
4126
+ */
3508
4127
  deleteGroupWithOptions(request: DeleteGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteGroupResponse>;
4128
+ /**
4129
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
4130
+ * ## Prerequisites
4131
+ * The group that you want to delete is not associated with the following resources. If the group is associated with the resources, the deletion fails.
4132
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
4133
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
4134
+ *
4135
+ * @param request DeleteGroupRequest
4136
+ * @return DeleteGroupResponse
4137
+ */
3509
4138
  deleteGroup(request: DeleteGroupRequest): Promise<DeleteGroupResponse>;
4139
+ /**
4140
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
4141
+ *
4142
+ * @param request DeleteMFADeviceForUserRequest
4143
+ * @param runtime runtime options for this request RuntimeOptions
4144
+ * @return DeleteMFADeviceForUserResponse
4145
+ */
3510
4146
  deleteMFADeviceForUserWithOptions(request: DeleteMFADeviceForUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteMFADeviceForUserResponse>;
4147
+ /**
4148
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
4149
+ *
4150
+ * @param request DeleteMFADeviceForUserRequest
4151
+ * @return DeleteMFADeviceForUserResponse
4152
+ */
3511
4153
  deleteMFADeviceForUser(request: DeleteMFADeviceForUserRequest): Promise<DeleteMFADeviceForUserResponse>;
4154
+ /**
4155
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
4156
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
4157
+ *
4158
+ * @param request DeleteSCIMServerCredentialRequest
4159
+ * @param runtime runtime options for this request RuntimeOptions
4160
+ * @return DeleteSCIMServerCredentialResponse
4161
+ */
3512
4162
  deleteSCIMServerCredentialWithOptions(request: DeleteSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<DeleteSCIMServerCredentialResponse>;
4163
+ /**
4164
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
4165
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
4166
+ *
4167
+ * @param request DeleteSCIMServerCredentialRequest
4168
+ * @return DeleteSCIMServerCredentialResponse
4169
+ */
3513
4170
  deleteSCIMServerCredential(request: DeleteSCIMServerCredentialRequest): Promise<DeleteSCIMServerCredentialResponse>;
4171
+ /**
4172
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
4173
+ * ## Prerequisites
4174
+ * The user that you want to delete is not associated with the following resources. If the user is associated with the resources, the deletion fails.
4175
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
4176
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
4177
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
4178
+ *
4179
+ * @param request DeleteUserRequest
4180
+ * @param runtime runtime options for this request RuntimeOptions
4181
+ * @return DeleteUserResponse
4182
+ */
3514
4183
  deleteUserWithOptions(request: DeleteUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserResponse>;
4184
+ /**
4185
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
4186
+ * ## Prerequisites
4187
+ * The user that you want to delete is not associated with the following resources. If the user is associated with the resources, the deletion fails.
4188
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
4189
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
4190
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
4191
+ *
4192
+ * @param request DeleteUserRequest
4193
+ * @return DeleteUserResponse
4194
+ */
3515
4195
  deleteUser(request: DeleteUserRequest): Promise<DeleteUserResponse>;
4196
+ deleteUserProvisioningWithOptions(request: DeleteUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserProvisioningResponse>;
4197
+ deleteUserProvisioning(request: DeleteUserProvisioningRequest): Promise<DeleteUserProvisioningResponse>;
4198
+ /**
4199
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
4200
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
4201
+ *
4202
+ * @param request DeprovisionAccessConfigurationRequest
4203
+ * @param runtime runtime options for this request RuntimeOptions
4204
+ * @return DeprovisionAccessConfigurationResponse
4205
+ */
3516
4206
  deprovisionAccessConfigurationWithOptions(request: DeprovisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeprovisionAccessConfigurationResponse>;
4207
+ /**
4208
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
4209
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
4210
+ *
4211
+ * @param request DeprovisionAccessConfigurationRequest
4212
+ * @return DeprovisionAccessConfigurationResponse
4213
+ */
3517
4214
  deprovisionAccessConfiguration(request: DeprovisionAccessConfigurationRequest): Promise<DeprovisionAccessConfigurationResponse>;
4215
+ /**
4216
+ * If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
4217
+ *
4218
+ * @param request DisableServiceRequest
4219
+ * @param runtime runtime options for this request RuntimeOptions
4220
+ * @return DisableServiceResponse
4221
+ */
3518
4222
  disableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<DisableServiceResponse>;
4223
+ /**
4224
+ * If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
4225
+ *
4226
+ * @return DisableServiceResponse
4227
+ */
3519
4228
  disableService(): Promise<DisableServiceResponse>;
4229
+ /**
4230
+ * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](~~262819~~).
4231
+ * If you call this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
4232
+ *
4233
+ * @param request EnableServiceRequest
4234
+ * @param runtime runtime options for this request RuntimeOptions
4235
+ * @return EnableServiceResponse
4236
+ */
3520
4237
  enableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<EnableServiceResponse>;
4238
+ /**
4239
+ * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](~~262819~~).
4240
+ * If you call this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
4241
+ *
4242
+ * @return EnableServiceResponse
4243
+ */
3521
4244
  enableService(): Promise<EnableServiceResponse>;
4245
+ /**
4246
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
4247
+ *
4248
+ * @param request GetAccessConfigurationRequest
4249
+ * @param runtime runtime options for this request RuntimeOptions
4250
+ * @return GetAccessConfigurationResponse
4251
+ */
3522
4252
  getAccessConfigurationWithOptions(request: GetAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<GetAccessConfigurationResponse>;
4253
+ /**
4254
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
4255
+ *
4256
+ * @param request GetAccessConfigurationRequest
4257
+ * @return GetAccessConfigurationResponse
4258
+ */
3523
4259
  getAccessConfiguration(request: GetAccessConfigurationRequest): Promise<GetAccessConfigurationResponse>;
4260
+ /**
4261
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
4262
+ *
4263
+ * @param request GetDirectoryRequest
4264
+ * @param runtime runtime options for this request RuntimeOptions
4265
+ * @return GetDirectoryResponse
4266
+ */
3524
4267
  getDirectoryWithOptions(request: GetDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryResponse>;
4268
+ /**
4269
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
4270
+ *
4271
+ * @param request GetDirectoryRequest
4272
+ * @return GetDirectoryResponse
4273
+ */
3525
4274
  getDirectory(request: GetDirectoryRequest): Promise<GetDirectoryResponse>;
4275
+ /**
4276
+ * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
4277
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
4278
+ *
4279
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
4280
+ * @param runtime runtime options for this request RuntimeOptions
4281
+ * @return GetDirectorySAMLServiceProviderInfoResponse
4282
+ */
3526
4283
  getDirectorySAMLServiceProviderInfoWithOptions(request: GetDirectorySAMLServiceProviderInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectorySAMLServiceProviderInfoResponse>;
4284
+ /**
4285
+ * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
4286
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
4287
+ *
4288
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
4289
+ * @return GetDirectorySAMLServiceProviderInfoResponse
4290
+ */
3527
4291
  getDirectorySAMLServiceProviderInfo(request: GetDirectorySAMLServiceProviderInfoRequest): Promise<GetDirectorySAMLServiceProviderInfoResponse>;
4292
+ /**
4293
+ * ### [](#)
4294
+ * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
4295
+ * ### [](#qps)Limit
4296
+ * You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.
4297
+ *
4298
+ * @param request GetDirectoryStatisticsRequest
4299
+ * @param runtime runtime options for this request RuntimeOptions
4300
+ * @return GetDirectoryStatisticsResponse
4301
+ */
3528
4302
  getDirectoryStatisticsWithOptions(request: GetDirectoryStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryStatisticsResponse>;
4303
+ /**
4304
+ * ### [](#)
4305
+ * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
4306
+ * ### [](#qps)Limit
4307
+ * You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.
4308
+ *
4309
+ * @param request GetDirectoryStatisticsRequest
4310
+ * @return GetDirectoryStatisticsResponse
4311
+ */
3529
4312
  getDirectoryStatistics(request: GetDirectoryStatisticsRequest): Promise<GetDirectoryStatisticsResponse>;
4313
+ /**
4314
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
4315
+ *
4316
+ * @param request GetExternalSAMLIdentityProviderRequest
4317
+ * @param runtime runtime options for this request RuntimeOptions
4318
+ * @return GetExternalSAMLIdentityProviderResponse
4319
+ */
3530
4320
  getExternalSAMLIdentityProviderWithOptions(request: GetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<GetExternalSAMLIdentityProviderResponse>;
4321
+ /**
4322
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
4323
+ *
4324
+ * @param request GetExternalSAMLIdentityProviderRequest
4325
+ * @return GetExternalSAMLIdentityProviderResponse
4326
+ */
3531
4327
  getExternalSAMLIdentityProvider(request: GetExternalSAMLIdentityProviderRequest): Promise<GetExternalSAMLIdentityProviderResponse>;
4328
+ /**
4329
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
4330
+ *
4331
+ * @param request GetGroupRequest
4332
+ * @param runtime runtime options for this request RuntimeOptions
4333
+ * @return GetGroupResponse
4334
+ */
3532
4335
  getGroupWithOptions(request: GetGroupRequest, runtime: $Util.RuntimeOptions): Promise<GetGroupResponse>;
4336
+ /**
4337
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
4338
+ *
4339
+ * @param request GetGroupRequest
4340
+ * @return GetGroupResponse
4341
+ */
3533
4342
  getGroup(request: GetGroupRequest): Promise<GetGroupResponse>;
4343
+ /**
4344
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
4345
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
4346
+ *
4347
+ * @param request GetMFAAuthenticationSettingInfoRequest
4348
+ * @param runtime runtime options for this request RuntimeOptions
4349
+ * @return GetMFAAuthenticationSettingInfoResponse
4350
+ */
4351
+ getMFAAuthenticationSettingInfoWithOptions(request: GetMFAAuthenticationSettingInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingInfoResponse>;
4352
+ /**
4353
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
4354
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
4355
+ *
4356
+ * @param request GetMFAAuthenticationSettingInfoRequest
4357
+ * @return GetMFAAuthenticationSettingInfoResponse
4358
+ */
4359
+ getMFAAuthenticationSettingInfo(request: GetMFAAuthenticationSettingInfoRequest): Promise<GetMFAAuthenticationSettingInfoResponse>;
4360
+ /**
4361
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
4362
+ * This topic provides an example on how to query the MFA setting of the users that belong to the directory named `d-00fc2p61****`. The returned result shows that MFA is enabled for all the users.
4363
+ *
4364
+ * @param request GetMFAAuthenticationSettingsRequest
4365
+ * @param runtime runtime options for this request RuntimeOptions
4366
+ * @return GetMFAAuthenticationSettingsResponse
4367
+ */
3534
4368
  getMFAAuthenticationSettingsWithOptions(request: GetMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingsResponse>;
4369
+ /**
4370
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
4371
+ * This topic provides an example on how to query the MFA setting of the users that belong to the directory named `d-00fc2p61****`. The returned result shows that MFA is enabled for all the users.
4372
+ *
4373
+ * @param request GetMFAAuthenticationSettingsRequest
4374
+ * @return GetMFAAuthenticationSettingsResponse
4375
+ */
3535
4376
  getMFAAuthenticationSettings(request: GetMFAAuthenticationSettingsRequest): Promise<GetMFAAuthenticationSettingsResponse>;
4377
+ /**
4378
+ * This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
4379
+ *
4380
+ * @param request GetMFAAuthenticationStatusRequest
4381
+ * @param runtime runtime options for this request RuntimeOptions
4382
+ * @return GetMFAAuthenticationStatusResponse
4383
+ */
3536
4384
  getMFAAuthenticationStatusWithOptions(request: GetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationStatusResponse>;
4385
+ /**
4386
+ * This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
4387
+ *
4388
+ * @param request GetMFAAuthenticationStatusRequest
4389
+ * @return GetMFAAuthenticationStatusResponse
4390
+ */
3537
4391
  getMFAAuthenticationStatus(request: GetMFAAuthenticationStatusRequest): Promise<GetMFAAuthenticationStatusResponse>;
4392
+ /**
4393
+ * This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
4394
+ *
4395
+ * @param request GetSCIMSynchronizationStatusRequest
4396
+ * @param runtime runtime options for this request RuntimeOptions
4397
+ * @return GetSCIMSynchronizationStatusResponse
4398
+ */
3538
4399
  getSCIMSynchronizationStatusWithOptions(request: GetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetSCIMSynchronizationStatusResponse>;
4400
+ /**
4401
+ * This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
4402
+ *
4403
+ * @param request GetSCIMSynchronizationStatusRequest
4404
+ * @return GetSCIMSynchronizationStatusResponse
4405
+ */
3539
4406
  getSCIMSynchronizationStatus(request: GetSCIMSynchronizationStatusRequest): Promise<GetSCIMSynchronizationStatusResponse>;
3540
4407
  getServiceStatusWithOptions(runtime: $Util.RuntimeOptions): Promise<GetServiceStatusResponse>;
3541
4408
  getServiceStatus(): Promise<GetServiceStatusResponse>;
4409
+ /**
4410
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
4411
+ *
4412
+ * @param request GetTaskRequest
4413
+ * @param runtime runtime options for this request RuntimeOptions
4414
+ * @return GetTaskResponse
4415
+ */
3542
4416
  getTaskWithOptions(request: GetTaskRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskResponse>;
4417
+ /**
4418
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
4419
+ *
4420
+ * @param request GetTaskRequest
4421
+ * @return GetTaskResponse
4422
+ */
3543
4423
  getTask(request: GetTaskRequest): Promise<GetTaskResponse>;
4424
+ /**
4425
+ * You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, you can call the [GetTask](~~340670~~) operation.
4426
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
4427
+ *
4428
+ * @param request GetTaskStatusRequest
4429
+ * @param runtime runtime options for this request RuntimeOptions
4430
+ * @return GetTaskStatusResponse
4431
+ */
3544
4432
  getTaskStatusWithOptions(request: GetTaskStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskStatusResponse>;
4433
+ /**
4434
+ * You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, you can call the [GetTask](~~340670~~) operation.
4435
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
4436
+ *
4437
+ * @param request GetTaskStatusRequest
4438
+ * @return GetTaskStatusResponse
4439
+ */
3545
4440
  getTaskStatus(request: GetTaskStatusRequest): Promise<GetTaskStatusResponse>;
4441
+ /**
4442
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
4443
+ *
4444
+ * @param request GetUserRequest
4445
+ * @param runtime runtime options for this request RuntimeOptions
4446
+ * @return GetUserResponse
4447
+ */
3546
4448
  getUserWithOptions(request: GetUserRequest, runtime: $Util.RuntimeOptions): Promise<GetUserResponse>;
4449
+ /**
4450
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
4451
+ *
4452
+ * @param request GetUserRequest
4453
+ * @return GetUserResponse
4454
+ */
3547
4455
  getUser(request: GetUserRequest): Promise<GetUserResponse>;
4456
+ /**
4457
+ * This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
4458
+ *
4459
+ * @param request GetUserMFAAuthenticationSettingsRequest
4460
+ * @param runtime runtime options for this request RuntimeOptions
4461
+ * @return GetUserMFAAuthenticationSettingsResponse
4462
+ */
3548
4463
  getUserMFAAuthenticationSettingsWithOptions(request: GetUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetUserMFAAuthenticationSettingsResponse>;
4464
+ /**
4465
+ * This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
4466
+ *
4467
+ * @param request GetUserMFAAuthenticationSettingsRequest
4468
+ * @return GetUserMFAAuthenticationSettingsResponse
4469
+ */
3549
4470
  getUserMFAAuthenticationSettings(request: GetUserMFAAuthenticationSettingsRequest): Promise<GetUserMFAAuthenticationSettingsResponse>;
4471
+ getUserProvisioningWithOptions(request: GetUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningResponse>;
4472
+ getUserProvisioning(request: GetUserProvisioningRequest): Promise<GetUserProvisioningResponse>;
4473
+ /**
4474
+ * This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
4475
+ *
4476
+ * @param request ListAccessAssignmentsRequest
4477
+ * @param runtime runtime options for this request RuntimeOptions
4478
+ * @return ListAccessAssignmentsResponse
4479
+ */
3550
4480
  listAccessAssignmentsWithOptions(request: ListAccessAssignmentsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessAssignmentsResponse>;
4481
+ /**
4482
+ * This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
4483
+ *
4484
+ * @param request ListAccessAssignmentsRequest
4485
+ * @return ListAccessAssignmentsResponse
4486
+ */
3551
4487
  listAccessAssignments(request: ListAccessAssignmentsRequest): Promise<ListAccessAssignmentsResponse>;
4488
+ /**
4489
+ * This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
4490
+ *
4491
+ * @param request ListAccessConfigurationProvisioningsRequest
4492
+ * @param runtime runtime options for this request RuntimeOptions
4493
+ * @return ListAccessConfigurationProvisioningsResponse
4494
+ */
3552
4495
  listAccessConfigurationProvisioningsWithOptions(request: ListAccessConfigurationProvisioningsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationProvisioningsResponse>;
4496
+ /**
4497
+ * This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
4498
+ *
4499
+ * @param request ListAccessConfigurationProvisioningsRequest
4500
+ * @return ListAccessConfigurationProvisioningsResponse
4501
+ */
3553
4502
  listAccessConfigurationProvisionings(request: ListAccessConfigurationProvisioningsRequest): Promise<ListAccessConfigurationProvisioningsResponse>;
4503
+ /**
4504
+ * This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
4505
+ *
4506
+ * @param request ListAccessConfigurationsRequest
4507
+ * @param runtime runtime options for this request RuntimeOptions
4508
+ * @return ListAccessConfigurationsResponse
4509
+ */
3554
4510
  listAccessConfigurationsWithOptions(request: ListAccessConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationsResponse>;
4511
+ /**
4512
+ * This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
4513
+ *
4514
+ * @param request ListAccessConfigurationsRequest
4515
+ * @return ListAccessConfigurationsResponse
4516
+ */
3555
4517
  listAccessConfigurations(request: ListAccessConfigurationsRequest): Promise<ListAccessConfigurationsResponse>;
4518
+ /**
4519
+ * This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
4520
+ *
4521
+ * @param request ListDirectoriesRequest
4522
+ * @param runtime runtime options for this request RuntimeOptions
4523
+ * @return ListDirectoriesResponse
4524
+ */
3556
4525
  listDirectoriesWithOptions(runtime: $Util.RuntimeOptions): Promise<ListDirectoriesResponse>;
4526
+ /**
4527
+ * This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
4528
+ *
4529
+ * @return ListDirectoriesResponse
4530
+ */
3557
4531
  listDirectories(): Promise<ListDirectoriesResponse>;
4532
+ /**
4533
+ * This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
4534
+ *
4535
+ * @param request ListExternalSAMLIdPCertificatesRequest
4536
+ * @param runtime runtime options for this request RuntimeOptions
4537
+ * @return ListExternalSAMLIdPCertificatesResponse
4538
+ */
3558
4539
  listExternalSAMLIdPCertificatesWithOptions(request: ListExternalSAMLIdPCertificatesRequest, runtime: $Util.RuntimeOptions): Promise<ListExternalSAMLIdPCertificatesResponse>;
4540
+ /**
4541
+ * This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
4542
+ *
4543
+ * @param request ListExternalSAMLIdPCertificatesRequest
4544
+ * @return ListExternalSAMLIdPCertificatesResponse
4545
+ */
3559
4546
  listExternalSAMLIdPCertificates(request: ListExternalSAMLIdPCertificatesRequest): Promise<ListExternalSAMLIdPCertificatesResponse>;
4547
+ /**
4548
+ * This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
4549
+ *
4550
+ * @param request ListGroupMembersRequest
4551
+ * @param runtime runtime options for this request RuntimeOptions
4552
+ * @return ListGroupMembersResponse
4553
+ */
3560
4554
  listGroupMembersWithOptions(request: ListGroupMembersRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupMembersResponse>;
4555
+ /**
4556
+ * This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
4557
+ *
4558
+ * @param request ListGroupMembersRequest
4559
+ * @return ListGroupMembersResponse
4560
+ */
3561
4561
  listGroupMembers(request: ListGroupMembersRequest): Promise<ListGroupMembersResponse>;
4562
+ /**
4563
+ * This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
4564
+ *
4565
+ * @param request ListGroupsRequest
4566
+ * @param runtime runtime options for this request RuntimeOptions
4567
+ * @return ListGroupsResponse
4568
+ */
3562
4569
  listGroupsWithOptions(request: ListGroupsRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupsResponse>;
4570
+ /**
4571
+ * This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
4572
+ *
4573
+ * @param request ListGroupsRequest
4574
+ * @return ListGroupsResponse
4575
+ */
3563
4576
  listGroups(request: ListGroupsRequest): Promise<ListGroupsResponse>;
4577
+ /**
4578
+ * This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
4579
+ *
4580
+ * @param request ListJoinedGroupsForUserRequest
4581
+ * @param runtime runtime options for this request RuntimeOptions
4582
+ * @return ListJoinedGroupsForUserResponse
4583
+ */
3564
4584
  listJoinedGroupsForUserWithOptions(request: ListJoinedGroupsForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListJoinedGroupsForUserResponse>;
4585
+ /**
4586
+ * This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
4587
+ *
4588
+ * @param request ListJoinedGroupsForUserRequest
4589
+ * @return ListJoinedGroupsForUserResponse
4590
+ */
3565
4591
  listJoinedGroupsForUser(request: ListJoinedGroupsForUserRequest): Promise<ListJoinedGroupsForUserResponse>;
4592
+ /**
4593
+ * This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
4594
+ *
4595
+ * @param request ListMFADevicesForUserRequest
4596
+ * @param runtime runtime options for this request RuntimeOptions
4597
+ * @return ListMFADevicesForUserResponse
4598
+ */
3566
4599
  listMFADevicesForUserWithOptions(request: ListMFADevicesForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListMFADevicesForUserResponse>;
4600
+ /**
4601
+ * This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
4602
+ *
4603
+ * @param request ListMFADevicesForUserRequest
4604
+ * @return ListMFADevicesForUserResponse
4605
+ */
3567
4606
  listMFADevicesForUser(request: ListMFADevicesForUserRequest): Promise<ListMFADevicesForUserResponse>;
4607
+ /**
4608
+ * This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
4609
+ *
4610
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
4611
+ * @param runtime runtime options for this request RuntimeOptions
4612
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
4613
+ */
3568
4614
  listPermissionPoliciesInAccessConfigurationWithOptions(request: ListPermissionPoliciesInAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ListPermissionPoliciesInAccessConfigurationResponse>;
4615
+ /**
4616
+ * This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
4617
+ *
4618
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
4619
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
4620
+ */
3569
4621
  listPermissionPoliciesInAccessConfiguration(request: ListPermissionPoliciesInAccessConfigurationRequest): Promise<ListPermissionPoliciesInAccessConfigurationResponse>;
4622
+ /**
4623
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
4624
+ *
4625
+ * @param request ListSCIMServerCredentialsRequest
4626
+ * @param runtime runtime options for this request RuntimeOptions
4627
+ * @return ListSCIMServerCredentialsResponse
4628
+ */
3570
4629
  listSCIMServerCredentialsWithOptions(request: ListSCIMServerCredentialsRequest, runtime: $Util.RuntimeOptions): Promise<ListSCIMServerCredentialsResponse>;
4630
+ /**
4631
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
4632
+ *
4633
+ * @param request ListSCIMServerCredentialsRequest
4634
+ * @return ListSCIMServerCredentialsResponse
4635
+ */
3571
4636
  listSCIMServerCredentials(request: ListSCIMServerCredentialsRequest): Promise<ListSCIMServerCredentialsResponse>;
4637
+ /**
4638
+ * By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
4639
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
4640
+ *
4641
+ * @param request ListTasksRequest
4642
+ * @param runtime runtime options for this request RuntimeOptions
4643
+ * @return ListTasksResponse
4644
+ */
3572
4645
  listTasksWithOptions(request: ListTasksRequest, runtime: $Util.RuntimeOptions): Promise<ListTasksResponse>;
4646
+ /**
4647
+ * By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
4648
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
4649
+ *
4650
+ * @param request ListTasksRequest
4651
+ * @return ListTasksResponse
4652
+ */
3573
4653
  listTasks(request: ListTasksRequest): Promise<ListTasksResponse>;
4654
+ listUserProvisioningsWithOptions(request: ListUserProvisioningsRequest, runtime: $Util.RuntimeOptions): Promise<ListUserProvisioningsResponse>;
4655
+ listUserProvisionings(request: ListUserProvisioningsRequest): Promise<ListUserProvisioningsResponse>;
4656
+ /**
4657
+ * This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
4658
+ *
4659
+ * @param request ListUsersRequest
4660
+ * @param runtime runtime options for this request RuntimeOptions
4661
+ * @return ListUsersResponse
4662
+ */
3574
4663
  listUsersWithOptions(request: ListUsersRequest, runtime: $Util.RuntimeOptions): Promise<ListUsersResponse>;
4664
+ /**
4665
+ * This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
4666
+ *
4667
+ * @param request ListUsersRequest
4668
+ * @return ListUsersResponse
4669
+ */
3575
4670
  listUsers(request: ListUsersRequest): Promise<ListUsersResponse>;
4671
+ /**
4672
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
4673
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
4674
+ *
4675
+ * @param request ProvisionAccessConfigurationRequest
4676
+ * @param runtime runtime options for this request RuntimeOptions
4677
+ * @return ProvisionAccessConfigurationResponse
4678
+ */
3576
4679
  provisionAccessConfigurationWithOptions(request: ProvisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ProvisionAccessConfigurationResponse>;
4680
+ /**
4681
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
4682
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
4683
+ *
4684
+ * @param request ProvisionAccessConfigurationRequest
4685
+ * @return ProvisionAccessConfigurationResponse
4686
+ */
3577
4687
  provisionAccessConfiguration(request: ProvisionAccessConfigurationRequest): Promise<ProvisionAccessConfigurationResponse>;
4688
+ /**
4689
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
4690
+ *
4691
+ * @param request RemoveExternalSAMLIdPCertificateRequest
4692
+ * @param runtime runtime options for this request RuntimeOptions
4693
+ * @return RemoveExternalSAMLIdPCertificateResponse
4694
+ */
3578
4695
  removeExternalSAMLIdPCertificateWithOptions(request: RemoveExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<RemoveExternalSAMLIdPCertificateResponse>;
4696
+ /**
4697
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
4698
+ *
4699
+ * @param request RemoveExternalSAMLIdPCertificateRequest
4700
+ * @return RemoveExternalSAMLIdPCertificateResponse
4701
+ */
3579
4702
  removeExternalSAMLIdPCertificate(request: RemoveExternalSAMLIdPCertificateRequest): Promise<RemoveExternalSAMLIdPCertificateResponse>;
4703
+ /**
4704
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
4705
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
4706
+ *
4707
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
4708
+ * @param runtime runtime options for this request RuntimeOptions
4709
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
4710
+ */
3580
4711
  removePermissionPolicyFromAccessConfigurationWithOptions(request: RemovePermissionPolicyFromAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<RemovePermissionPolicyFromAccessConfigurationResponse>;
4712
+ /**
4713
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
4714
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
4715
+ *
4716
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
4717
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
4718
+ */
3581
4719
  removePermissionPolicyFromAccessConfiguration(request: RemovePermissionPolicyFromAccessConfigurationRequest): Promise<RemovePermissionPolicyFromAccessConfigurationResponse>;
4720
+ /**
4721
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
4722
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
4723
+ *
4724
+ * @param request RemoveUserFromGroupRequest
4725
+ * @param runtime runtime options for this request RuntimeOptions
4726
+ * @return RemoveUserFromGroupResponse
4727
+ */
3582
4728
  removeUserFromGroupWithOptions(request: RemoveUserFromGroupRequest, runtime: $Util.RuntimeOptions): Promise<RemoveUserFromGroupResponse>;
4729
+ /**
4730
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
4731
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
4732
+ *
4733
+ * @param request RemoveUserFromGroupRequest
4734
+ * @return RemoveUserFromGroupResponse
4735
+ */
3583
4736
  removeUserFromGroup(request: RemoveUserFromGroupRequest): Promise<RemoveUserFromGroupResponse>;
4737
+ /**
4738
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
4739
+ * > After you enable SSO logon, your password cannot be reset.
4740
+ * This topic provides an example on how to reset the password of the user `u-00q8wbq42wiltcrk****`. The new password is automatically generated by the system.
4741
+ *
4742
+ * @param request ResetUserPasswordRequest
4743
+ * @param runtime runtime options for this request RuntimeOptions
4744
+ * @return ResetUserPasswordResponse
4745
+ */
3584
4746
  resetUserPasswordWithOptions(request: ResetUserPasswordRequest, runtime: $Util.RuntimeOptions): Promise<ResetUserPasswordResponse>;
4747
+ /**
4748
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
4749
+ * > After you enable SSO logon, your password cannot be reset.
4750
+ * This topic provides an example on how to reset the password of the user `u-00q8wbq42wiltcrk****`. The new password is automatically generated by the system.
4751
+ *
4752
+ * @param request ResetUserPasswordRequest
4753
+ * @return ResetUserPasswordResponse
4754
+ */
3585
4755
  resetUserPassword(request: ResetUserPasswordRequest): Promise<ResetUserPasswordResponse>;
4756
+ /**
4757
+ * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
4758
+ * You can use one of the following methods to configure a SAML IdP. You can obtain the required metadata file or parameter values from your IdP.
4759
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
4760
+ * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
4761
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
4762
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
4763
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
4764
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
4765
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
4766
+ *
4767
+ * @param request SetExternalSAMLIdentityProviderRequest
4768
+ * @param runtime runtime options for this request RuntimeOptions
4769
+ * @return SetExternalSAMLIdentityProviderResponse
4770
+ */
3586
4771
  setExternalSAMLIdentityProviderWithOptions(request: SetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<SetExternalSAMLIdentityProviderResponse>;
4772
+ /**
4773
+ * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
4774
+ * You can use one of the following methods to configure a SAML IdP. You can obtain the required metadata file or parameter values from your IdP.
4775
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
4776
+ * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
4777
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
4778
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
4779
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
4780
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
4781
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
4782
+ *
4783
+ * @param request SetExternalSAMLIdentityProviderRequest
4784
+ * @return SetExternalSAMLIdentityProviderResponse
4785
+ */
3587
4786
  setExternalSAMLIdentityProvider(request: SetExternalSAMLIdentityProviderRequest): Promise<SetExternalSAMLIdentityProviderResponse>;
4787
+ /**
4788
+ * If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
4789
+ * This topic provides an example on how to enable MFA for users.
4790
+ *
4791
+ * @param request SetMFAAuthenticationStatusRequest
4792
+ * @param runtime runtime options for this request RuntimeOptions
4793
+ * @return SetMFAAuthenticationStatusResponse
4794
+ */
3588
4795
  setMFAAuthenticationStatusWithOptions(request: SetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetMFAAuthenticationStatusResponse>;
4796
+ /**
4797
+ * If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
4798
+ * This topic provides an example on how to enable MFA for users.
4799
+ *
4800
+ * @param request SetMFAAuthenticationStatusRequest
4801
+ * @return SetMFAAuthenticationStatusResponse
4802
+ */
3589
4803
  setMFAAuthenticationStatus(request: SetMFAAuthenticationStatusRequest): Promise<SetMFAAuthenticationStatusResponse>;
4804
+ /**
4805
+ * You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
4806
+ * * After you enable SCIM synchronization, you cannot modify or delete the users or groups that are synchronized to CloudSSO by using SCIM. In addition, you cannot add users to or remove users from the groups. However, you can change the passwords of the users and enable or disable the logon of the users.
4807
+ * * After you disable SCIM synchronization, you can modify and delete the users and groups that are synchronized to CloudSSO by using SCIM. You can also add users to or remove users from the groups.
4808
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
4809
+ *
4810
+ * @param request SetSCIMSynchronizationStatusRequest
4811
+ * @param runtime runtime options for this request RuntimeOptions
4812
+ * @return SetSCIMSynchronizationStatusResponse
4813
+ */
3590
4814
  setSCIMSynchronizationStatusWithOptions(request: SetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetSCIMSynchronizationStatusResponse>;
4815
+ /**
4816
+ * You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
4817
+ * * After you enable SCIM synchronization, you cannot modify or delete the users or groups that are synchronized to CloudSSO by using SCIM. In addition, you cannot add users to or remove users from the groups. However, you can change the passwords of the users and enable or disable the logon of the users.
4818
+ * * After you disable SCIM synchronization, you can modify and delete the users and groups that are synchronized to CloudSSO by using SCIM. You can also add users to or remove users from the groups.
4819
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
4820
+ *
4821
+ * @param request SetSCIMSynchronizationStatusRequest
4822
+ * @return SetSCIMSynchronizationStatusResponse
4823
+ */
3591
4824
  setSCIMSynchronizationStatus(request: SetSCIMSynchronizationStatusRequest): Promise<SetSCIMSynchronizationStatusResponse>;
4825
+ /**
4826
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
4827
+ * This topic provides an example on how to change the initial web page in the access configuration `ac-00jhtfl8thteu6uj****` to `https://cloudsso.console.aliyun.com`.
4828
+ *
4829
+ * @param request UpdateAccessConfigurationRequest
4830
+ * @param runtime runtime options for this request RuntimeOptions
4831
+ * @return UpdateAccessConfigurationResponse
4832
+ */
3592
4833
  updateAccessConfigurationWithOptions(request: UpdateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateAccessConfigurationResponse>;
4834
+ /**
4835
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
4836
+ * This topic provides an example on how to change the initial web page in the access configuration `ac-00jhtfl8thteu6uj****` to `https://cloudsso.console.aliyun.com`.
4837
+ *
4838
+ * @param request UpdateAccessConfigurationRequest
4839
+ * @return UpdateAccessConfigurationResponse
4840
+ */
3593
4841
  updateAccessConfiguration(request: UpdateAccessConfigurationRequest): Promise<UpdateAccessConfigurationResponse>;
4842
+ /**
4843
+ * After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
4844
+ * This topic provides an example on how to change the name of a directory to `new-example`.
4845
+ *
4846
+ * @param request UpdateDirectoryRequest
4847
+ * @param runtime runtime options for this request RuntimeOptions
4848
+ * @return UpdateDirectoryResponse
4849
+ */
3594
4850
  updateDirectoryWithOptions(request: UpdateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<UpdateDirectoryResponse>;
4851
+ /**
4852
+ * After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
4853
+ * This topic provides an example on how to change the name of a directory to `new-example`.
4854
+ *
4855
+ * @param request UpdateDirectoryRequest
4856
+ * @return UpdateDirectoryResponse
4857
+ */
3595
4858
  updateDirectory(request: UpdateDirectoryRequest): Promise<UpdateDirectoryResponse>;
4859
+ /**
4860
+ * You can modify `GroupName` and `Description` for a group.
4861
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a group that is synchronized by using SCIM.
4862
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
4863
+ *
4864
+ * @param request UpdateGroupRequest
4865
+ * @param runtime runtime options for this request RuntimeOptions
4866
+ * @return UpdateGroupResponse
4867
+ */
3596
4868
  updateGroupWithOptions(request: UpdateGroupRequest, runtime: $Util.RuntimeOptions): Promise<UpdateGroupResponse>;
4869
+ /**
4870
+ * You can modify `GroupName` and `Description` for a group.
4871
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a group that is synchronized by using SCIM.
4872
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
4873
+ *
4874
+ * @param request UpdateGroupRequest
4875
+ * @return UpdateGroupResponse
4876
+ */
3597
4877
  updateGroup(request: UpdateGroupRequest): Promise<UpdateGroupResponse>;
4878
+ /**
4879
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
4880
+ *
4881
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
4882
+ * @param runtime runtime options for this request RuntimeOptions
4883
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
4884
+ */
3598
4885
  updateInlinePolicyForAccessConfigurationWithOptions(request: UpdateInlinePolicyForAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateInlinePolicyForAccessConfigurationResponse>;
4886
+ /**
4887
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
4888
+ *
4889
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
4890
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
4891
+ */
3599
4892
  updateInlinePolicyForAccessConfiguration(request: UpdateInlinePolicyForAccessConfigurationRequest): Promise<UpdateInlinePolicyForAccessConfigurationResponse>;
4893
+ /**
4894
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
4895
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
4896
+ *
4897
+ * @param request UpdateMFAAuthenticationSettingsRequest
4898
+ * @param runtime runtime options for this request RuntimeOptions
4899
+ * @return UpdateMFAAuthenticationSettingsResponse
4900
+ */
3600
4901
  updateMFAAuthenticationSettingsWithOptions(request: UpdateMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateMFAAuthenticationSettingsResponse>;
4902
+ /**
4903
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
4904
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
4905
+ *
4906
+ * @param request UpdateMFAAuthenticationSettingsRequest
4907
+ * @return UpdateMFAAuthenticationSettingsResponse
4908
+ */
3601
4909
  updateMFAAuthenticationSettings(request: UpdateMFAAuthenticationSettingsRequest): Promise<UpdateMFAAuthenticationSettingsResponse>;
4910
+ /**
4911
+ * This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
4912
+ *
4913
+ * @param request UpdateSCIMServerCredentialStatusRequest
4914
+ * @param runtime runtime options for this request RuntimeOptions
4915
+ * @return UpdateSCIMServerCredentialStatusResponse
4916
+ */
3602
4917
  updateSCIMServerCredentialStatusWithOptions(request: UpdateSCIMServerCredentialStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateSCIMServerCredentialStatusResponse>;
4918
+ /**
4919
+ * This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
4920
+ *
4921
+ * @param request UpdateSCIMServerCredentialStatusRequest
4922
+ * @return UpdateSCIMServerCredentialStatusResponse
4923
+ */
3603
4924
  updateSCIMServerCredentialStatus(request: UpdateSCIMServerCredentialStatusRequest): Promise<UpdateSCIMServerCredentialStatusResponse>;
4925
+ /**
4926
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
4927
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a user that is synchronized by using SCIM.
4928
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
4929
+ *
4930
+ * @param request UpdateUserRequest
4931
+ * @param runtime runtime options for this request RuntimeOptions
4932
+ * @return UpdateUserResponse
4933
+ */
3604
4934
  updateUserWithOptions(request: UpdateUserRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserResponse>;
4935
+ /**
4936
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
4937
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a user that is synchronized by using SCIM.
4938
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
4939
+ *
4940
+ * @param request UpdateUserRequest
4941
+ * @return UpdateUserResponse
4942
+ */
3605
4943
  updateUser(request: UpdateUserRequest): Promise<UpdateUserResponse>;
4944
+ /**
4945
+ * If you call the [UpdateMFAAuthenticationSettings](~~450134~~) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
4946
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
4947
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
4948
+ *
4949
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
4950
+ * @param runtime runtime options for this request RuntimeOptions
4951
+ * @return UpdateUserMFAAuthenticationSettingsResponse
4952
+ */
3606
4953
  updateUserMFAAuthenticationSettingsWithOptions(request: UpdateUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserMFAAuthenticationSettingsResponse>;
4954
+ /**
4955
+ * If you call the [UpdateMFAAuthenticationSettings](~~450134~~) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
4956
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
4957
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
4958
+ *
4959
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
4960
+ * @return UpdateUserMFAAuthenticationSettingsResponse
4961
+ */
3607
4962
  updateUserMFAAuthenticationSettings(request: UpdateUserMFAAuthenticationSettingsRequest): Promise<UpdateUserMFAAuthenticationSettingsResponse>;
4963
+ updateUserProvisioningWithOptions(request: UpdateUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserProvisioningResponse>;
4964
+ updateUserProvisioning(request: UpdateUserProvisioningRequest): Promise<UpdateUserProvisioningResponse>;
4965
+ /**
4966
+ * This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
4967
+ *
4968
+ * @param request UpdateUserStatusRequest
4969
+ * @param runtime runtime options for this request RuntimeOptions
4970
+ * @return UpdateUserStatusResponse
4971
+ */
3608
4972
  updateUserStatusWithOptions(request: UpdateUserStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserStatusResponse>;
4973
+ /**
4974
+ * This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
4975
+ *
4976
+ * @param request UpdateUserStatusRequest
4977
+ * @return UpdateUserStatusResponse
4978
+ */
3609
4979
  updateUserStatus(request: UpdateUserStatusRequest): Promise<UpdateUserStatusResponse>;
3610
4980
  }