@alicloud/cloudsso20210515 1.0.2 → 1.1.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
@@ -1078,6 +1078,47 @@ export declare class GetGroupResponse extends $tea.Model {
1078
1078
  [key: string]: any;
1079
1079
  });
1080
1080
  }
1081
+ export declare class GetMFAAuthenticationSettingInfoRequest extends $tea.Model {
1082
+ directoryId?: string;
1083
+ static names(): {
1084
+ [key: string]: string;
1085
+ };
1086
+ static types(): {
1087
+ [key: string]: any;
1088
+ };
1089
+ constructor(map?: {
1090
+ [key: string]: any;
1091
+ });
1092
+ }
1093
+ export declare class GetMFAAuthenticationSettingInfoResponseBody extends $tea.Model {
1094
+ MFAAuthenticationSettingInfo?: GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo;
1095
+ requestId?: string;
1096
+ static names(): {
1097
+ [key: string]: string;
1098
+ };
1099
+ static types(): {
1100
+ [key: string]: any;
1101
+ };
1102
+ constructor(map?: {
1103
+ [key: string]: any;
1104
+ });
1105
+ }
1106
+ export declare class GetMFAAuthenticationSettingInfoResponse extends $tea.Model {
1107
+ headers: {
1108
+ [key: string]: string;
1109
+ };
1110
+ statusCode: number;
1111
+ body: GetMFAAuthenticationSettingInfoResponseBody;
1112
+ static names(): {
1113
+ [key: string]: string;
1114
+ };
1115
+ static types(): {
1116
+ [key: string]: any;
1117
+ };
1118
+ constructor(map?: {
1119
+ [key: string]: any;
1120
+ });
1121
+ }
1081
1122
  export declare class GetMFAAuthenticationSettingsRequest extends $tea.Model {
1082
1123
  directoryId?: string;
1083
1124
  static names(): {
@@ -2959,6 +3000,7 @@ export declare class GetDirectoryStatisticsResponseBodyDirectoryStatistics exten
2959
3000
  SCIMServerCredentialCount?: number;
2960
3001
  SCIMSyncEnabled?: boolean;
2961
3002
  SSOEnabled?: boolean;
3003
+ systemPolicyPerAccessConfigurationQuota?: number;
2962
3004
  userCount?: number;
2963
3005
  userQuota?: number;
2964
3006
  static names(): {
@@ -3008,6 +3050,19 @@ export declare class GetGroupResponseBodyGroup extends $tea.Model {
3008
3050
  [key: string]: any;
3009
3051
  });
3010
3052
  }
3053
+ export declare class GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo extends $tea.Model {
3054
+ mfaAuthenticationAdvanceSettings?: string;
3055
+ operationForRiskLogin?: string;
3056
+ static names(): {
3057
+ [key: string]: string;
3058
+ };
3059
+ static types(): {
3060
+ [key: string]: any;
3061
+ };
3062
+ constructor(map?: {
3063
+ [key: string]: any;
3064
+ });
3065
+ }
3011
3066
  export declare class GetServiceStatusResponseBodyServiceStatus extends $tea.Model {
3012
3067
  accountId?: string;
3013
3068
  prerequisiteCheckResult?: string;
@@ -3479,132 +3534,1337 @@ export default class Client extends OpenApi {
3479
3534
  getEndpoint(productId: string, regionId: string, endpointRule: string, network: string, suffix: string, endpointMap: {
3480
3535
  [key: string]: string;
3481
3536
  }, endpoint: string): string;
3537
+ /**
3538
+ * You can add up to two SAML signing certificates.
3539
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
3540
+ * ## Limits
3541
+ * 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.
3542
+ *
3543
+ * @param request AddExternalSAMLIdPCertificateRequest
3544
+ * @param runtime runtime options for this request RuntimeOptions
3545
+ * @return AddExternalSAMLIdPCertificateResponse
3546
+ */
3482
3547
  addExternalSAMLIdPCertificateWithOptions(request: AddExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<AddExternalSAMLIdPCertificateResponse>;
3548
+ /**
3549
+ * You can add up to two SAML signing certificates.
3550
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
3551
+ * ## Limits
3552
+ * 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.
3553
+ *
3554
+ * @param request AddExternalSAMLIdPCertificateRequest
3555
+ * @return AddExternalSAMLIdPCertificateResponse
3556
+ */
3483
3557
  addExternalSAMLIdPCertificate(request: AddExternalSAMLIdPCertificateRequest): Promise<AddExternalSAMLIdPCertificateResponse>;
3558
+ /**
3559
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
3560
+ * ## Limits
3561
+ * 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.
3562
+ *
3563
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
3564
+ * @param runtime runtime options for this request RuntimeOptions
3565
+ * @return AddPermissionPolicyToAccessConfigurationResponse
3566
+ */
3484
3567
  addPermissionPolicyToAccessConfigurationWithOptions(request: AddPermissionPolicyToAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<AddPermissionPolicyToAccessConfigurationResponse>;
3568
+ /**
3569
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
3570
+ * ## Limits
3571
+ * 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.
3572
+ *
3573
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
3574
+ * @return AddPermissionPolicyToAccessConfigurationResponse
3575
+ */
3485
3576
  addPermissionPolicyToAccessConfiguration(request: AddPermissionPolicyToAccessConfigurationRequest): Promise<AddPermissionPolicyToAccessConfigurationResponse>;
3577
+ /**
3578
+ * 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.
3579
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
3580
+ * ## Limits
3581
+ * 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.
3582
+ *
3583
+ * @param request AddUserToGroupRequest
3584
+ * @param runtime runtime options for this request RuntimeOptions
3585
+ * @return AddUserToGroupResponse
3586
+ */
3486
3587
  addUserToGroupWithOptions(request: AddUserToGroupRequest, runtime: $Util.RuntimeOptions): Promise<AddUserToGroupResponse>;
3588
+ /**
3589
+ * 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.
3590
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
3591
+ * ## Limits
3592
+ * 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.
3593
+ *
3594
+ * @param request AddUserToGroupRequest
3595
+ * @return AddUserToGroupResponse
3596
+ */
3487
3597
  addUserToGroup(request: AddUserToGroupRequest): Promise<AddUserToGroupResponse>;
3598
+ /**
3599
+ * 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.
3600
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
3601
+ * ## Limits
3602
+ * 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.
3603
+ *
3604
+ * @param request ClearExternalSAMLIdentityProviderRequest
3605
+ * @param runtime runtime options for this request RuntimeOptions
3606
+ * @return ClearExternalSAMLIdentityProviderResponse
3607
+ */
3488
3608
  clearExternalSAMLIdentityProviderWithOptions(request: ClearExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<ClearExternalSAMLIdentityProviderResponse>;
3609
+ /**
3610
+ * 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.
3611
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
3612
+ * ## Limits
3613
+ * 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.
3614
+ *
3615
+ * @param request ClearExternalSAMLIdentityProviderRequest
3616
+ * @return ClearExternalSAMLIdentityProviderResponse
3617
+ */
3489
3618
  clearExternalSAMLIdentityProvider(request: ClearExternalSAMLIdentityProviderRequest): Promise<ClearExternalSAMLIdentityProviderResponse>;
3619
+ /**
3620
+ * 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.
3621
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
3622
+ * 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.
3623
+ * ## Limits
3624
+ * You can call this operation up to 20 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.
3625
+ *
3626
+ * @param request CreateAccessAssignmentRequest
3627
+ * @param runtime runtime options for this request RuntimeOptions
3628
+ * @return CreateAccessAssignmentResponse
3629
+ */
3490
3630
  createAccessAssignmentWithOptions(request: CreateAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessAssignmentResponse>;
3631
+ /**
3632
+ * 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.
3633
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
3634
+ * 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.
3635
+ * ## Limits
3636
+ * You can call this operation up to 20 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.
3637
+ *
3638
+ * @param request CreateAccessAssignmentRequest
3639
+ * @return CreateAccessAssignmentResponse
3640
+ */
3491
3641
  createAccessAssignment(request: CreateAccessAssignmentRequest): Promise<CreateAccessAssignmentResponse>;
3642
+ /**
3643
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
3644
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
3645
+ * ## Limits
3646
+ * 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.
3647
+ *
3648
+ * @param request CreateAccessConfigurationRequest
3649
+ * @param runtime runtime options for this request RuntimeOptions
3650
+ * @return CreateAccessConfigurationResponse
3651
+ */
3492
3652
  createAccessConfigurationWithOptions(request: CreateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessConfigurationResponse>;
3653
+ /**
3654
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
3655
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
3656
+ * ## Limits
3657
+ * 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.
3658
+ *
3659
+ * @param request CreateAccessConfigurationRequest
3660
+ * @return CreateAccessConfigurationResponse
3661
+ */
3493
3662
  createAccessConfiguration(request: CreateAccessConfigurationRequest): Promise<CreateAccessConfigurationResponse>;
3663
+ /**
3664
+ * 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.
3665
+ * 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.
3666
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
3667
+ * ## Limits
3668
+ * - You can create only one directory for a management account.
3669
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
3670
+ * ## Limits
3671
+ * 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.
3672
+ *
3673
+ * @param request CreateDirectoryRequest
3674
+ * @param runtime runtime options for this request RuntimeOptions
3675
+ * @return CreateDirectoryResponse
3676
+ */
3494
3677
  createDirectoryWithOptions(request: CreateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<CreateDirectoryResponse>;
3678
+ /**
3679
+ * 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.
3680
+ * 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.
3681
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
3682
+ * ## Limits
3683
+ * - You can create only one directory for a management account.
3684
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
3685
+ * ## Limits
3686
+ * 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.
3687
+ *
3688
+ * @param request CreateDirectoryRequest
3689
+ * @return CreateDirectoryResponse
3690
+ */
3495
3691
  createDirectory(request: CreateDirectoryRequest): Promise<CreateDirectoryResponse>;
3692
+ /**
3693
+ * This topic provides an example on how to create a group named `TestGroup`.
3694
+ * ## Limits
3695
+ * 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.
3696
+ *
3697
+ * @param request CreateGroupRequest
3698
+ * @param runtime runtime options for this request RuntimeOptions
3699
+ * @return CreateGroupResponse
3700
+ */
3496
3701
  createGroupWithOptions(request: CreateGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateGroupResponse>;
3702
+ /**
3703
+ * This topic provides an example on how to create a group named `TestGroup`.
3704
+ * ## Limits
3705
+ * 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.
3706
+ *
3707
+ * @param request CreateGroupRequest
3708
+ * @return CreateGroupResponse
3709
+ */
3497
3710
  createGroup(request: CreateGroupRequest): Promise<CreateGroupResponse>;
3711
+ /**
3712
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
3713
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
3714
+ * ## Limits
3715
+ * 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.
3716
+ *
3717
+ * @param request CreateSCIMServerCredentialRequest
3718
+ * @param runtime runtime options for this request RuntimeOptions
3719
+ * @return CreateSCIMServerCredentialResponse
3720
+ */
3498
3721
  createSCIMServerCredentialWithOptions(request: CreateSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<CreateSCIMServerCredentialResponse>;
3722
+ /**
3723
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
3724
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
3725
+ * ## Limits
3726
+ * 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.
3727
+ *
3728
+ * @param request CreateSCIMServerCredentialRequest
3729
+ * @return CreateSCIMServerCredentialResponse
3730
+ */
3499
3731
  createSCIMServerCredential(request: CreateSCIMServerCredentialRequest): Promise<CreateSCIMServerCredentialResponse>;
3732
+ /**
3733
+ * This topic provides an example on how to create a user named `Alice`.
3734
+ * ## Limits
3735
+ * 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.
3736
+ *
3737
+ * @param request CreateUserRequest
3738
+ * @param runtime runtime options for this request RuntimeOptions
3739
+ * @return CreateUserResponse
3740
+ */
3500
3741
  createUserWithOptions(request: CreateUserRequest, runtime: $Util.RuntimeOptions): Promise<CreateUserResponse>;
3742
+ /**
3743
+ * This topic provides an example on how to create a user named `Alice`.
3744
+ * ## Limits
3745
+ * 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.
3746
+ *
3747
+ * @param request CreateUserRequest
3748
+ * @return CreateUserResponse
3749
+ */
3501
3750
  createUser(request: CreateUserRequest): Promise<CreateUserResponse>;
3751
+ /**
3752
+ * 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.
3753
+ * 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****`.
3754
+ * ## Limits
3755
+ * You can call this operation up to 20 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.
3756
+ *
3757
+ * @param request DeleteAccessAssignmentRequest
3758
+ * @param runtime runtime options for this request RuntimeOptions
3759
+ * @return DeleteAccessAssignmentResponse
3760
+ */
3502
3761
  deleteAccessAssignmentWithOptions(request: DeleteAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessAssignmentResponse>;
3762
+ /**
3763
+ * 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.
3764
+ * 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****`.
3765
+ * ## Limits
3766
+ * You can call this operation up to 20 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.
3767
+ *
3768
+ * @param request DeleteAccessAssignmentRequest
3769
+ * @return DeleteAccessAssignmentResponse
3770
+ */
3503
3771
  deleteAccessAssignment(request: DeleteAccessAssignmentRequest): Promise<DeleteAccessAssignmentResponse>;
3772
+ /**
3773
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
3774
+ * ## Prerequisites
3775
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
3776
+ * ## Limits
3777
+ * 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.
3778
+ *
3779
+ * @param request DeleteAccessConfigurationRequest
3780
+ * @param runtime runtime options for this request RuntimeOptions
3781
+ * @return DeleteAccessConfigurationResponse
3782
+ */
3504
3783
  deleteAccessConfigurationWithOptions(request: DeleteAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessConfigurationResponse>;
3784
+ /**
3785
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
3786
+ * ## Prerequisites
3787
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
3788
+ * ## Limits
3789
+ * 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.
3790
+ *
3791
+ * @param request DeleteAccessConfigurationRequest
3792
+ * @return DeleteAccessConfigurationResponse
3793
+ */
3505
3794
  deleteAccessConfiguration(request: DeleteAccessConfigurationRequest): Promise<DeleteAccessConfigurationResponse>;
3795
+ /**
3796
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
3797
+ * ## Prerequisites
3798
+ * No resources are contained in the directory that you want to delete.
3799
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
3800
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
3801
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
3802
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
3803
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
3804
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
3805
+ * ## Limits
3806
+ * 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.
3807
+ *
3808
+ * @param request DeleteDirectoryRequest
3809
+ * @param runtime runtime options for this request RuntimeOptions
3810
+ * @return DeleteDirectoryResponse
3811
+ */
3506
3812
  deleteDirectoryWithOptions(request: DeleteDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDirectoryResponse>;
3813
+ /**
3814
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
3815
+ * ## Prerequisites
3816
+ * No resources are contained in the directory that you want to delete.
3817
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
3818
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
3819
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
3820
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
3821
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
3822
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
3823
+ * ## Limits
3824
+ * 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.
3825
+ *
3826
+ * @param request DeleteDirectoryRequest
3827
+ * @return DeleteDirectoryResponse
3828
+ */
3507
3829
  deleteDirectory(request: DeleteDirectoryRequest): Promise<DeleteDirectoryResponse>;
3830
+ /**
3831
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
3832
+ * ## Prerequisites
3833
+ * 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.
3834
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
3835
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
3836
+ * ## Limits
3837
+ * 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.
3838
+ *
3839
+ * @param request DeleteGroupRequest
3840
+ * @param runtime runtime options for this request RuntimeOptions
3841
+ * @return DeleteGroupResponse
3842
+ */
3508
3843
  deleteGroupWithOptions(request: DeleteGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteGroupResponse>;
3844
+ /**
3845
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
3846
+ * ## Prerequisites
3847
+ * 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.
3848
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
3849
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
3850
+ * ## Limits
3851
+ * 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.
3852
+ *
3853
+ * @param request DeleteGroupRequest
3854
+ * @return DeleteGroupResponse
3855
+ */
3509
3856
  deleteGroup(request: DeleteGroupRequest): Promise<DeleteGroupResponse>;
3857
+ /**
3858
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
3859
+ * ## Limits
3860
+ * 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.
3861
+ *
3862
+ * @param request DeleteMFADeviceForUserRequest
3863
+ * @param runtime runtime options for this request RuntimeOptions
3864
+ * @return DeleteMFADeviceForUserResponse
3865
+ */
3510
3866
  deleteMFADeviceForUserWithOptions(request: DeleteMFADeviceForUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteMFADeviceForUserResponse>;
3867
+ /**
3868
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
3869
+ * ## Limits
3870
+ * 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.
3871
+ *
3872
+ * @param request DeleteMFADeviceForUserRequest
3873
+ * @return DeleteMFADeviceForUserResponse
3874
+ */
3511
3875
  deleteMFADeviceForUser(request: DeleteMFADeviceForUserRequest): Promise<DeleteMFADeviceForUserResponse>;
3876
+ /**
3877
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
3878
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
3879
+ * ## Limits
3880
+ * 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.
3881
+ *
3882
+ * @param request DeleteSCIMServerCredentialRequest
3883
+ * @param runtime runtime options for this request RuntimeOptions
3884
+ * @return DeleteSCIMServerCredentialResponse
3885
+ */
3512
3886
  deleteSCIMServerCredentialWithOptions(request: DeleteSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<DeleteSCIMServerCredentialResponse>;
3887
+ /**
3888
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
3889
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
3890
+ * ## Limits
3891
+ * 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.
3892
+ *
3893
+ * @param request DeleteSCIMServerCredentialRequest
3894
+ * @return DeleteSCIMServerCredentialResponse
3895
+ */
3513
3896
  deleteSCIMServerCredential(request: DeleteSCIMServerCredentialRequest): Promise<DeleteSCIMServerCredentialResponse>;
3897
+ /**
3898
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
3899
+ * ## Prerequisites
3900
+ * 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.
3901
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
3902
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
3903
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
3904
+ * ## Limits
3905
+ * 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.
3906
+ *
3907
+ * @param request DeleteUserRequest
3908
+ * @param runtime runtime options for this request RuntimeOptions
3909
+ * @return DeleteUserResponse
3910
+ */
3514
3911
  deleteUserWithOptions(request: DeleteUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserResponse>;
3912
+ /**
3913
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
3914
+ * ## Prerequisites
3915
+ * 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.
3916
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
3917
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
3918
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
3919
+ * ## Limits
3920
+ * 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.
3921
+ *
3922
+ * @param request DeleteUserRequest
3923
+ * @return DeleteUserResponse
3924
+ */
3515
3925
  deleteUser(request: DeleteUserRequest): Promise<DeleteUserResponse>;
3926
+ /**
3927
+ * 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.
3928
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
3929
+ * ## Limits
3930
+ * You can call this operation up to 20 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.
3931
+ *
3932
+ * @param request DeprovisionAccessConfigurationRequest
3933
+ * @param runtime runtime options for this request RuntimeOptions
3934
+ * @return DeprovisionAccessConfigurationResponse
3935
+ */
3516
3936
  deprovisionAccessConfigurationWithOptions(request: DeprovisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeprovisionAccessConfigurationResponse>;
3937
+ /**
3938
+ * 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.
3939
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
3940
+ * ## Limits
3941
+ * You can call this operation up to 20 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.
3942
+ *
3943
+ * @param request DeprovisionAccessConfigurationRequest
3944
+ * @return DeprovisionAccessConfigurationResponse
3945
+ */
3517
3946
  deprovisionAccessConfiguration(request: DeprovisionAccessConfigurationRequest): Promise<DeprovisionAccessConfigurationResponse>;
3947
+ /**
3948
+ * 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.
3949
+ * ## Limits
3950
+ * 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.
3951
+ *
3952
+ * @param request DisableServiceRequest
3953
+ * @param runtime runtime options for this request RuntimeOptions
3954
+ * @return DisableServiceResponse
3955
+ */
3518
3956
  disableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<DisableServiceResponse>;
3957
+ /**
3958
+ * 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.
3959
+ * ## Limits
3960
+ * 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.
3961
+ *
3962
+ * @return DisableServiceResponse
3963
+ */
3519
3964
  disableService(): Promise<DisableServiceResponse>;
3965
+ /**
3966
+ * 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~~).
3967
+ * 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).
3968
+ * ## Limits
3969
+ * 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.
3970
+ *
3971
+ * @param request EnableServiceRequest
3972
+ * @param runtime runtime options for this request RuntimeOptions
3973
+ * @return EnableServiceResponse
3974
+ */
3520
3975
  enableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<EnableServiceResponse>;
3976
+ /**
3977
+ * 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~~).
3978
+ * 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).
3979
+ * ## Limits
3980
+ * 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.
3981
+ *
3982
+ * @return EnableServiceResponse
3983
+ */
3521
3984
  enableService(): Promise<EnableServiceResponse>;
3985
+ /**
3986
+ * ## Usage notes
3987
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
3988
+ *
3989
+ * @param request GetAccessConfigurationRequest
3990
+ * @param runtime runtime options for this request RuntimeOptions
3991
+ * @return GetAccessConfigurationResponse
3992
+ */
3522
3993
  getAccessConfigurationWithOptions(request: GetAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<GetAccessConfigurationResponse>;
3994
+ /**
3995
+ * ## Usage notes
3996
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
3997
+ *
3998
+ * @param request GetAccessConfigurationRequest
3999
+ * @return GetAccessConfigurationResponse
4000
+ */
3523
4001
  getAccessConfiguration(request: GetAccessConfigurationRequest): Promise<GetAccessConfigurationResponse>;
4002
+ /**
4003
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
4004
+ * ## Limits
4005
+ * 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.
4006
+ *
4007
+ * @param request GetDirectoryRequest
4008
+ * @param runtime runtime options for this request RuntimeOptions
4009
+ * @return GetDirectoryResponse
4010
+ */
3524
4011
  getDirectoryWithOptions(request: GetDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryResponse>;
4012
+ /**
4013
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
4014
+ * ## Limits
4015
+ * 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.
4016
+ *
4017
+ * @param request GetDirectoryRequest
4018
+ * @return GetDirectoryResponse
4019
+ */
3525
4020
  getDirectory(request: GetDirectoryRequest): Promise<GetDirectoryResponse>;
4021
+ /**
4022
+ * 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).
4023
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
4024
+ * ## Limits
4025
+ * 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.
4026
+ *
4027
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
4028
+ * @param runtime runtime options for this request RuntimeOptions
4029
+ * @return GetDirectorySAMLServiceProviderInfoResponse
4030
+ */
3526
4031
  getDirectorySAMLServiceProviderInfoWithOptions(request: GetDirectorySAMLServiceProviderInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectorySAMLServiceProviderInfoResponse>;
4032
+ /**
4033
+ * 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).
4034
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
4035
+ * ## Limits
4036
+ * 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.
4037
+ *
4038
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
4039
+ * @return GetDirectorySAMLServiceProviderInfoResponse
4040
+ */
3527
4041
  getDirectorySAMLServiceProviderInfo(request: GetDirectorySAMLServiceProviderInfoRequest): Promise<GetDirectorySAMLServiceProviderInfoResponse>;
4042
+ /**
4043
+ * 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, 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) logon, and status of SCIM synchronization.
4044
+ * ## Limits
4045
+ * 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.
4046
+ *
4047
+ * @param request GetDirectoryStatisticsRequest
4048
+ * @param runtime runtime options for this request RuntimeOptions
4049
+ * @return GetDirectoryStatisticsResponse
4050
+ */
3528
4051
  getDirectoryStatisticsWithOptions(request: GetDirectoryStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryStatisticsResponse>;
4052
+ /**
4053
+ * 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, 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) logon, and status of SCIM synchronization.
4054
+ * ## Limits
4055
+ * 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.
4056
+ *
4057
+ * @param request GetDirectoryStatisticsRequest
4058
+ * @return GetDirectoryStatisticsResponse
4059
+ */
3529
4060
  getDirectoryStatistics(request: GetDirectoryStatisticsRequest): Promise<GetDirectoryStatisticsResponse>;
4061
+ /**
4062
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
4063
+ * ## Limits
4064
+ * 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.
4065
+ *
4066
+ * @param request GetExternalSAMLIdentityProviderRequest
4067
+ * @param runtime runtime options for this request RuntimeOptions
4068
+ * @return GetExternalSAMLIdentityProviderResponse
4069
+ */
3530
4070
  getExternalSAMLIdentityProviderWithOptions(request: GetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<GetExternalSAMLIdentityProviderResponse>;
4071
+ /**
4072
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
4073
+ * ## Limits
4074
+ * 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.
4075
+ *
4076
+ * @param request GetExternalSAMLIdentityProviderRequest
4077
+ * @return GetExternalSAMLIdentityProviderResponse
4078
+ */
3531
4079
  getExternalSAMLIdentityProvider(request: GetExternalSAMLIdentityProviderRequest): Promise<GetExternalSAMLIdentityProviderResponse>;
4080
+ /**
4081
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
4082
+ * ## Limits
4083
+ * 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.
4084
+ *
4085
+ * @param request GetGroupRequest
4086
+ * @param runtime runtime options for this request RuntimeOptions
4087
+ * @return GetGroupResponse
4088
+ */
3532
4089
  getGroupWithOptions(request: GetGroupRequest, runtime: $Util.RuntimeOptions): Promise<GetGroupResponse>;
4090
+ /**
4091
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
4092
+ * ## Limits
4093
+ * 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.
4094
+ *
4095
+ * @param request GetGroupRequest
4096
+ * @return GetGroupResponse
4097
+ */
3533
4098
  getGroup(request: GetGroupRequest): Promise<GetGroupResponse>;
4099
+ /**
4100
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
4101
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
4102
+ *
4103
+ * @param request GetMFAAuthenticationSettingInfoRequest
4104
+ * @param runtime runtime options for this request RuntimeOptions
4105
+ * @return GetMFAAuthenticationSettingInfoResponse
4106
+ */
4107
+ getMFAAuthenticationSettingInfoWithOptions(request: GetMFAAuthenticationSettingInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingInfoResponse>;
4108
+ /**
4109
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
4110
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
4111
+ *
4112
+ * @param request GetMFAAuthenticationSettingInfoRequest
4113
+ * @return GetMFAAuthenticationSettingInfoResponse
4114
+ */
4115
+ getMFAAuthenticationSettingInfo(request: GetMFAAuthenticationSettingInfoRequest): Promise<GetMFAAuthenticationSettingInfoResponse>;
4116
+ /**
4117
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
4118
+ * 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.
4119
+ *
4120
+ * @param request GetMFAAuthenticationSettingsRequest
4121
+ * @param runtime runtime options for this request RuntimeOptions
4122
+ * @return GetMFAAuthenticationSettingsResponse
4123
+ */
3534
4124
  getMFAAuthenticationSettingsWithOptions(request: GetMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingsResponse>;
4125
+ /**
4126
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
4127
+ * 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.
4128
+ *
4129
+ * @param request GetMFAAuthenticationSettingsRequest
4130
+ * @return GetMFAAuthenticationSettingsResponse
4131
+ */
3535
4132
  getMFAAuthenticationSettings(request: GetMFAAuthenticationSettingsRequest): Promise<GetMFAAuthenticationSettingsResponse>;
4133
+ /**
4134
+ * 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.
4135
+ * ## Limits
4136
+ * 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.
4137
+ *
4138
+ * @param request GetMFAAuthenticationStatusRequest
4139
+ * @param runtime runtime options for this request RuntimeOptions
4140
+ * @return GetMFAAuthenticationStatusResponse
4141
+ */
3536
4142
  getMFAAuthenticationStatusWithOptions(request: GetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationStatusResponse>;
4143
+ /**
4144
+ * 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.
4145
+ * ## Limits
4146
+ * 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.
4147
+ *
4148
+ * @param request GetMFAAuthenticationStatusRequest
4149
+ * @return GetMFAAuthenticationStatusResponse
4150
+ */
3537
4151
  getMFAAuthenticationStatus(request: GetMFAAuthenticationStatusRequest): Promise<GetMFAAuthenticationStatusResponse>;
4152
+ /**
4153
+ * 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.
4154
+ * ## Limits
4155
+ * 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.
4156
+ *
4157
+ * @param request GetSCIMSynchronizationStatusRequest
4158
+ * @param runtime runtime options for this request RuntimeOptions
4159
+ * @return GetSCIMSynchronizationStatusResponse
4160
+ */
3538
4161
  getSCIMSynchronizationStatusWithOptions(request: GetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetSCIMSynchronizationStatusResponse>;
4162
+ /**
4163
+ * 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.
4164
+ * ## Limits
4165
+ * 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.
4166
+ *
4167
+ * @param request GetSCIMSynchronizationStatusRequest
4168
+ * @return GetSCIMSynchronizationStatusResponse
4169
+ */
3539
4170
  getSCIMSynchronizationStatus(request: GetSCIMSynchronizationStatusRequest): Promise<GetSCIMSynchronizationStatusResponse>;
4171
+ /**
4172
+ * ## Limits
4173
+ * 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.
4174
+ *
4175
+ * @param request GetServiceStatusRequest
4176
+ * @param runtime runtime options for this request RuntimeOptions
4177
+ * @return GetServiceStatusResponse
4178
+ */
3540
4179
  getServiceStatusWithOptions(runtime: $Util.RuntimeOptions): Promise<GetServiceStatusResponse>;
4180
+ /**
4181
+ * ## Limits
4182
+ * 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.
4183
+ *
4184
+ * @return GetServiceStatusResponse
4185
+ */
3541
4186
  getServiceStatus(): Promise<GetServiceStatusResponse>;
4187
+ /**
4188
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
4189
+ * ## Limits
4190
+ * You can call this operation up to 20 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.
4191
+ *
4192
+ * @param request GetTaskRequest
4193
+ * @param runtime runtime options for this request RuntimeOptions
4194
+ * @return GetTaskResponse
4195
+ */
3542
4196
  getTaskWithOptions(request: GetTaskRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskResponse>;
4197
+ /**
4198
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
4199
+ * ## Limits
4200
+ * You can call this operation up to 20 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.
4201
+ *
4202
+ * @param request GetTaskRequest
4203
+ * @return GetTaskResponse
4204
+ */
3543
4205
  getTask(request: GetTaskRequest): Promise<GetTaskResponse>;
4206
+ /**
4207
+ * 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.
4208
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
4209
+ * ## Limits
4210
+ * 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.
4211
+ *
4212
+ * @param request GetTaskStatusRequest
4213
+ * @param runtime runtime options for this request RuntimeOptions
4214
+ * @return GetTaskStatusResponse
4215
+ */
3544
4216
  getTaskStatusWithOptions(request: GetTaskStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskStatusResponse>;
4217
+ /**
4218
+ * 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.
4219
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
4220
+ * ## Limits
4221
+ * 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.
4222
+ *
4223
+ * @param request GetTaskStatusRequest
4224
+ * @return GetTaskStatusResponse
4225
+ */
3545
4226
  getTaskStatus(request: GetTaskStatusRequest): Promise<GetTaskStatusResponse>;
4227
+ /**
4228
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
4229
+ * ## Limits
4230
+ * 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.
4231
+ *
4232
+ * @param request GetUserRequest
4233
+ * @param runtime runtime options for this request RuntimeOptions
4234
+ * @return GetUserResponse
4235
+ */
3546
4236
  getUserWithOptions(request: GetUserRequest, runtime: $Util.RuntimeOptions): Promise<GetUserResponse>;
4237
+ /**
4238
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
4239
+ * ## Limits
4240
+ * 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.
4241
+ *
4242
+ * @param request GetUserRequest
4243
+ * @return GetUserResponse
4244
+ */
3547
4245
  getUser(request: GetUserRequest): Promise<GetUserResponse>;
4246
+ /**
4247
+ * 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.
4248
+ *
4249
+ * @param request GetUserMFAAuthenticationSettingsRequest
4250
+ * @param runtime runtime options for this request RuntimeOptions
4251
+ * @return GetUserMFAAuthenticationSettingsResponse
4252
+ */
3548
4253
  getUserMFAAuthenticationSettingsWithOptions(request: GetUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetUserMFAAuthenticationSettingsResponse>;
4254
+ /**
4255
+ * 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.
4256
+ *
4257
+ * @param request GetUserMFAAuthenticationSettingsRequest
4258
+ * @return GetUserMFAAuthenticationSettingsResponse
4259
+ */
3549
4260
  getUserMFAAuthenticationSettings(request: GetUserMFAAuthenticationSettingsRequest): Promise<GetUserMFAAuthenticationSettingsResponse>;
4261
+ /**
4262
+ * 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.
4263
+ * ## Limits
4264
+ * You can call this operation up to 20 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.
4265
+ *
4266
+ * @param request ListAccessAssignmentsRequest
4267
+ * @param runtime runtime options for this request RuntimeOptions
4268
+ * @return ListAccessAssignmentsResponse
4269
+ */
3550
4270
  listAccessAssignmentsWithOptions(request: ListAccessAssignmentsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessAssignmentsResponse>;
4271
+ /**
4272
+ * 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.
4273
+ * ## Limits
4274
+ * You can call this operation up to 20 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.
4275
+ *
4276
+ * @param request ListAccessAssignmentsRequest
4277
+ * @return ListAccessAssignmentsResponse
4278
+ */
3551
4279
  listAccessAssignments(request: ListAccessAssignmentsRequest): Promise<ListAccessAssignmentsResponse>;
4280
+ /**
4281
+ * ## Usage notes
4282
+ * 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.
4283
+ *
4284
+ * @param request ListAccessConfigurationProvisioningsRequest
4285
+ * @param runtime runtime options for this request RuntimeOptions
4286
+ * @return ListAccessConfigurationProvisioningsResponse
4287
+ */
3552
4288
  listAccessConfigurationProvisioningsWithOptions(request: ListAccessConfigurationProvisioningsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationProvisioningsResponse>;
4289
+ /**
4290
+ * ## Usage notes
4291
+ * 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.
4292
+ *
4293
+ * @param request ListAccessConfigurationProvisioningsRequest
4294
+ * @return ListAccessConfigurationProvisioningsResponse
4295
+ */
3553
4296
  listAccessConfigurationProvisionings(request: ListAccessConfigurationProvisioningsRequest): Promise<ListAccessConfigurationProvisioningsResponse>;
4297
+ /**
4298
+ * ## Usage notes
4299
+ * 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.
4300
+ *
4301
+ * @param request ListAccessConfigurationsRequest
4302
+ * @param runtime runtime options for this request RuntimeOptions
4303
+ * @return ListAccessConfigurationsResponse
4304
+ */
3554
4305
  listAccessConfigurationsWithOptions(request: ListAccessConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationsResponse>;
4306
+ /**
4307
+ * ## Usage notes
4308
+ * 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.
4309
+ *
4310
+ * @param request ListAccessConfigurationsRequest
4311
+ * @return ListAccessConfigurationsResponse
4312
+ */
3555
4313
  listAccessConfigurations(request: ListAccessConfigurationsRequest): Promise<ListAccessConfigurationsResponse>;
4314
+ /**
4315
+ * 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.
4316
+ * ## Limits
4317
+ * 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.
4318
+ *
4319
+ * @param request ListDirectoriesRequest
4320
+ * @param runtime runtime options for this request RuntimeOptions
4321
+ * @return ListDirectoriesResponse
4322
+ */
3556
4323
  listDirectoriesWithOptions(runtime: $Util.RuntimeOptions): Promise<ListDirectoriesResponse>;
4324
+ /**
4325
+ * 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.
4326
+ * ## Limits
4327
+ * 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.
4328
+ *
4329
+ * @return ListDirectoriesResponse
4330
+ */
3557
4331
  listDirectories(): Promise<ListDirectoriesResponse>;
4332
+ /**
4333
+ * 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.
4334
+ * ## Limits
4335
+ * 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.
4336
+ *
4337
+ * @param request ListExternalSAMLIdPCertificatesRequest
4338
+ * @param runtime runtime options for this request RuntimeOptions
4339
+ * @return ListExternalSAMLIdPCertificatesResponse
4340
+ */
3558
4341
  listExternalSAMLIdPCertificatesWithOptions(request: ListExternalSAMLIdPCertificatesRequest, runtime: $Util.RuntimeOptions): Promise<ListExternalSAMLIdPCertificatesResponse>;
4342
+ /**
4343
+ * 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.
4344
+ * ## Limits
4345
+ * 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.
4346
+ *
4347
+ * @param request ListExternalSAMLIdPCertificatesRequest
4348
+ * @return ListExternalSAMLIdPCertificatesResponse
4349
+ */
3559
4350
  listExternalSAMLIdPCertificates(request: ListExternalSAMLIdPCertificatesRequest): Promise<ListExternalSAMLIdPCertificatesResponse>;
4351
+ /**
4352
+ * 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`.
4353
+ * ## Limits
4354
+ * 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.
4355
+ *
4356
+ * @param request ListGroupMembersRequest
4357
+ * @param runtime runtime options for this request RuntimeOptions
4358
+ * @return ListGroupMembersResponse
4359
+ */
3560
4360
  listGroupMembersWithOptions(request: ListGroupMembersRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupMembersResponse>;
4361
+ /**
4362
+ * 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`.
4363
+ * ## Limits
4364
+ * 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.
4365
+ *
4366
+ * @param request ListGroupMembersRequest
4367
+ * @return ListGroupMembersResponse
4368
+ */
3561
4369
  listGroupMembers(request: ListGroupMembersRequest): Promise<ListGroupMembersResponse>;
4370
+ /**
4371
+ * 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.
4372
+ * ## Limits
4373
+ * 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.
4374
+ *
4375
+ * @param request ListGroupsRequest
4376
+ * @param runtime runtime options for this request RuntimeOptions
4377
+ * @return ListGroupsResponse
4378
+ */
3562
4379
  listGroupsWithOptions(request: ListGroupsRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupsResponse>;
4380
+ /**
4381
+ * 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.
4382
+ * ## Limits
4383
+ * 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.
4384
+ *
4385
+ * @param request ListGroupsRequest
4386
+ * @return ListGroupsResponse
4387
+ */
3563
4388
  listGroups(request: ListGroupsRequest): Promise<ListGroupsResponse>;
4389
+ /**
4390
+ * 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.
4391
+ * ## Limits
4392
+ * 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.
4393
+ *
4394
+ * @param request ListJoinedGroupsForUserRequest
4395
+ * @param runtime runtime options for this request RuntimeOptions
4396
+ * @return ListJoinedGroupsForUserResponse
4397
+ */
3564
4398
  listJoinedGroupsForUserWithOptions(request: ListJoinedGroupsForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListJoinedGroupsForUserResponse>;
4399
+ /**
4400
+ * 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.
4401
+ * ## Limits
4402
+ * 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.
4403
+ *
4404
+ * @param request ListJoinedGroupsForUserRequest
4405
+ * @return ListJoinedGroupsForUserResponse
4406
+ */
3565
4407
  listJoinedGroupsForUser(request: ListJoinedGroupsForUserRequest): Promise<ListJoinedGroupsForUserResponse>;
4408
+ /**
4409
+ * 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.
4410
+ * ## Limits
4411
+ * 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.
4412
+ *
4413
+ * @param request ListMFADevicesForUserRequest
4414
+ * @param runtime runtime options for this request RuntimeOptions
4415
+ * @return ListMFADevicesForUserResponse
4416
+ */
3566
4417
  listMFADevicesForUserWithOptions(request: ListMFADevicesForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListMFADevicesForUserResponse>;
4418
+ /**
4419
+ * 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.
4420
+ * ## Limits
4421
+ * 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.
4422
+ *
4423
+ * @param request ListMFADevicesForUserRequest
4424
+ * @return ListMFADevicesForUserResponse
4425
+ */
3567
4426
  listMFADevicesForUser(request: ListMFADevicesForUserRequest): Promise<ListMFADevicesForUserResponse>;
4427
+ /**
4428
+ * 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.
4429
+ * ## Limits
4430
+ * 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.
4431
+ *
4432
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
4433
+ * @param runtime runtime options for this request RuntimeOptions
4434
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
4435
+ */
3568
4436
  listPermissionPoliciesInAccessConfigurationWithOptions(request: ListPermissionPoliciesInAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ListPermissionPoliciesInAccessConfigurationResponse>;
4437
+ /**
4438
+ * 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.
4439
+ * ## Limits
4440
+ * 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.
4441
+ *
4442
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
4443
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
4444
+ */
3569
4445
  listPermissionPoliciesInAccessConfiguration(request: ListPermissionPoliciesInAccessConfigurationRequest): Promise<ListPermissionPoliciesInAccessConfigurationResponse>;
4446
+ /**
4447
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
4448
+ * ## Limits
4449
+ * 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.
4450
+ *
4451
+ * @param request ListSCIMServerCredentialsRequest
4452
+ * @param runtime runtime options for this request RuntimeOptions
4453
+ * @return ListSCIMServerCredentialsResponse
4454
+ */
3570
4455
  listSCIMServerCredentialsWithOptions(request: ListSCIMServerCredentialsRequest, runtime: $Util.RuntimeOptions): Promise<ListSCIMServerCredentialsResponse>;
4456
+ /**
4457
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
4458
+ * ## Limits
4459
+ * 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.
4460
+ *
4461
+ * @param request ListSCIMServerCredentialsRequest
4462
+ * @return ListSCIMServerCredentialsResponse
4463
+ */
3571
4464
  listSCIMServerCredentials(request: ListSCIMServerCredentialsRequest): Promise<ListSCIMServerCredentialsResponse>;
4465
+ /**
4466
+ * 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`.
4467
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
4468
+ * ## Limits
4469
+ * You can call this operation up to 20 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.
4470
+ *
4471
+ * @param request ListTasksRequest
4472
+ * @param runtime runtime options for this request RuntimeOptions
4473
+ * @return ListTasksResponse
4474
+ */
3572
4475
  listTasksWithOptions(request: ListTasksRequest, runtime: $Util.RuntimeOptions): Promise<ListTasksResponse>;
4476
+ /**
4477
+ * 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`.
4478
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
4479
+ * ## Limits
4480
+ * You can call this operation up to 20 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.
4481
+ *
4482
+ * @param request ListTasksRequest
4483
+ * @return ListTasksResponse
4484
+ */
3573
4485
  listTasks(request: ListTasksRequest): Promise<ListTasksResponse>;
4486
+ /**
4487
+ * 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.
4488
+ * ## Limits
4489
+ * 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.
4490
+ *
4491
+ * @param request ListUsersRequest
4492
+ * @param runtime runtime options for this request RuntimeOptions
4493
+ * @return ListUsersResponse
4494
+ */
3574
4495
  listUsersWithOptions(request: ListUsersRequest, runtime: $Util.RuntimeOptions): Promise<ListUsersResponse>;
4496
+ /**
4497
+ * 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.
4498
+ * ## Limits
4499
+ * 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.
4500
+ *
4501
+ * @param request ListUsersRequest
4502
+ * @return ListUsersResponse
4503
+ */
3575
4504
  listUsers(request: ListUsersRequest): Promise<ListUsersResponse>;
4505
+ /**
4506
+ * 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.
4507
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
4508
+ * ## Limits
4509
+ * You can call this operation up to 20 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.
4510
+ *
4511
+ * @param request ProvisionAccessConfigurationRequest
4512
+ * @param runtime runtime options for this request RuntimeOptions
4513
+ * @return ProvisionAccessConfigurationResponse
4514
+ */
3576
4515
  provisionAccessConfigurationWithOptions(request: ProvisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ProvisionAccessConfigurationResponse>;
4516
+ /**
4517
+ * 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.
4518
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
4519
+ * ## Limits
4520
+ * You can call this operation up to 20 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.
4521
+ *
4522
+ * @param request ProvisionAccessConfigurationRequest
4523
+ * @return ProvisionAccessConfigurationResponse
4524
+ */
3577
4525
  provisionAccessConfiguration(request: ProvisionAccessConfigurationRequest): Promise<ProvisionAccessConfigurationResponse>;
4526
+ /**
4527
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
4528
+ * ## Limits
4529
+ * 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.
4530
+ *
4531
+ * @param request RemoveExternalSAMLIdPCertificateRequest
4532
+ * @param runtime runtime options for this request RuntimeOptions
4533
+ * @return RemoveExternalSAMLIdPCertificateResponse
4534
+ */
3578
4535
  removeExternalSAMLIdPCertificateWithOptions(request: RemoveExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<RemoveExternalSAMLIdPCertificateResponse>;
4536
+ /**
4537
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
4538
+ * ## Limits
4539
+ * 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.
4540
+ *
4541
+ * @param request RemoveExternalSAMLIdPCertificateRequest
4542
+ * @return RemoveExternalSAMLIdPCertificateResponse
4543
+ */
3579
4544
  removeExternalSAMLIdPCertificate(request: RemoveExternalSAMLIdPCertificateRequest): Promise<RemoveExternalSAMLIdPCertificateResponse>;
4545
+ /**
4546
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
4547
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
4548
+ * ## Limits
4549
+ * 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.
4550
+ *
4551
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
4552
+ * @param runtime runtime options for this request RuntimeOptions
4553
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
4554
+ */
3580
4555
  removePermissionPolicyFromAccessConfigurationWithOptions(request: RemovePermissionPolicyFromAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<RemovePermissionPolicyFromAccessConfigurationResponse>;
4556
+ /**
4557
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
4558
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
4559
+ * ## Limits
4560
+ * 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.
4561
+ *
4562
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
4563
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
4564
+ */
3581
4565
  removePermissionPolicyFromAccessConfiguration(request: RemovePermissionPolicyFromAccessConfigurationRequest): Promise<RemovePermissionPolicyFromAccessConfigurationResponse>;
4566
+ /**
4567
+ * 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.
4568
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
4569
+ * ## Limits
4570
+ * 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.
4571
+ *
4572
+ * @param request RemoveUserFromGroupRequest
4573
+ * @param runtime runtime options for this request RuntimeOptions
4574
+ * @return RemoveUserFromGroupResponse
4575
+ */
3582
4576
  removeUserFromGroupWithOptions(request: RemoveUserFromGroupRequest, runtime: $Util.RuntimeOptions): Promise<RemoveUserFromGroupResponse>;
4577
+ /**
4578
+ * 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.
4579
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
4580
+ * ## Limits
4581
+ * 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.
4582
+ *
4583
+ * @param request RemoveUserFromGroupRequest
4584
+ * @return RemoveUserFromGroupResponse
4585
+ */
3583
4586
  removeUserFromGroup(request: RemoveUserFromGroupRequest): Promise<RemoveUserFromGroupResponse>;
4587
+ /**
4588
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
4589
+ * > After you enable SSO logon, your password cannot be reset.
4590
+ * 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.
4591
+ * ## Limits
4592
+ * 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.
4593
+ *
4594
+ * @param request ResetUserPasswordRequest
4595
+ * @param runtime runtime options for this request RuntimeOptions
4596
+ * @return ResetUserPasswordResponse
4597
+ */
3584
4598
  resetUserPasswordWithOptions(request: ResetUserPasswordRequest, runtime: $Util.RuntimeOptions): Promise<ResetUserPasswordResponse>;
4599
+ /**
4600
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
4601
+ * > After you enable SSO logon, your password cannot be reset.
4602
+ * 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.
4603
+ * ## Limits
4604
+ * 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.
4605
+ *
4606
+ * @param request ResetUserPasswordRequest
4607
+ * @return ResetUserPasswordResponse
4608
+ */
3585
4609
  resetUserPassword(request: ResetUserPasswordRequest): Promise<ResetUserPasswordResponse>;
4610
+ /**
4611
+ * ## Usage notes
4612
+ * 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.
4613
+ * 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.
4614
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
4615
+ * * Manually configure the IdP. You can manually specifythe following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
4616
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
4617
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
4618
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
4619
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
4620
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
4621
+ *
4622
+ * @param request SetExternalSAMLIdentityProviderRequest
4623
+ * @param runtime runtime options for this request RuntimeOptions
4624
+ * @return SetExternalSAMLIdentityProviderResponse
4625
+ */
3586
4626
  setExternalSAMLIdentityProviderWithOptions(request: SetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<SetExternalSAMLIdentityProviderResponse>;
4627
+ /**
4628
+ * ## Usage notes
4629
+ * 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.
4630
+ * 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.
4631
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
4632
+ * * Manually configure the IdP. You can manually specifythe following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
4633
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
4634
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
4635
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
4636
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
4637
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
4638
+ *
4639
+ * @param request SetExternalSAMLIdentityProviderRequest
4640
+ * @return SetExternalSAMLIdentityProviderResponse
4641
+ */
3587
4642
  setExternalSAMLIdentityProvider(request: SetExternalSAMLIdentityProviderRequest): Promise<SetExternalSAMLIdentityProviderResponse>;
4643
+ /**
4644
+ * 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.
4645
+ * This topic provides an example on how to enable MFA for users.
4646
+ * ## Limits
4647
+ * 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.
4648
+ *
4649
+ * @param request SetMFAAuthenticationStatusRequest
4650
+ * @param runtime runtime options for this request RuntimeOptions
4651
+ * @return SetMFAAuthenticationStatusResponse
4652
+ */
3588
4653
  setMFAAuthenticationStatusWithOptions(request: SetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetMFAAuthenticationStatusResponse>;
4654
+ /**
4655
+ * 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.
4656
+ * This topic provides an example on how to enable MFA for users.
4657
+ * ## Limits
4658
+ * 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.
4659
+ *
4660
+ * @param request SetMFAAuthenticationStatusRequest
4661
+ * @return SetMFAAuthenticationStatusResponse
4662
+ */
3589
4663
  setMFAAuthenticationStatus(request: SetMFAAuthenticationStatusRequest): Promise<SetMFAAuthenticationStatusResponse>;
4664
+ /**
4665
+ * 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:
4666
+ * * 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.
4667
+ * * 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.
4668
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
4669
+ * ## Limits
4670
+ * 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.
4671
+ *
4672
+ * @param request SetSCIMSynchronizationStatusRequest
4673
+ * @param runtime runtime options for this request RuntimeOptions
4674
+ * @return SetSCIMSynchronizationStatusResponse
4675
+ */
3590
4676
  setSCIMSynchronizationStatusWithOptions(request: SetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetSCIMSynchronizationStatusResponse>;
4677
+ /**
4678
+ * 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:
4679
+ * * 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.
4680
+ * * 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.
4681
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
4682
+ * ## Limits
4683
+ * 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.
4684
+ *
4685
+ * @param request SetSCIMSynchronizationStatusRequest
4686
+ * @return SetSCIMSynchronizationStatusResponse
4687
+ */
3591
4688
  setSCIMSynchronizationStatus(request: SetSCIMSynchronizationStatusRequest): Promise<SetSCIMSynchronizationStatusResponse>;
4689
+ /**
4690
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
4691
+ * 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`.
4692
+ * ## Limits
4693
+ * 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.
4694
+ *
4695
+ * @param request UpdateAccessConfigurationRequest
4696
+ * @param runtime runtime options for this request RuntimeOptions
4697
+ * @return UpdateAccessConfigurationResponse
4698
+ */
3592
4699
  updateAccessConfigurationWithOptions(request: UpdateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateAccessConfigurationResponse>;
4700
+ /**
4701
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
4702
+ * 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`.
4703
+ * ## Limits
4704
+ * 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.
4705
+ *
4706
+ * @param request UpdateAccessConfigurationRequest
4707
+ * @return UpdateAccessConfigurationResponse
4708
+ */
3593
4709
  updateAccessConfiguration(request: UpdateAccessConfigurationRequest): Promise<UpdateAccessConfigurationResponse>;
4710
+ /**
4711
+ * 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.
4712
+ * This topic provides an example on how to change the name of a directory to `new-example`.
4713
+ * ## Limits
4714
+ * 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.
4715
+ *
4716
+ * @param request UpdateDirectoryRequest
4717
+ * @param runtime runtime options for this request RuntimeOptions
4718
+ * @return UpdateDirectoryResponse
4719
+ */
3594
4720
  updateDirectoryWithOptions(request: UpdateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<UpdateDirectoryResponse>;
4721
+ /**
4722
+ * 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.
4723
+ * This topic provides an example on how to change the name of a directory to `new-example`.
4724
+ * ## Limits
4725
+ * 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.
4726
+ *
4727
+ * @param request UpdateDirectoryRequest
4728
+ * @return UpdateDirectoryResponse
4729
+ */
3595
4730
  updateDirectory(request: UpdateDirectoryRequest): Promise<UpdateDirectoryResponse>;
4731
+ /**
4732
+ * You can modify `GroupName` and `Description` for a group.
4733
+ * > 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.
4734
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
4735
+ * ## Limits
4736
+ * 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.
4737
+ *
4738
+ * @param request UpdateGroupRequest
4739
+ * @param runtime runtime options for this request RuntimeOptions
4740
+ * @return UpdateGroupResponse
4741
+ */
3596
4742
  updateGroupWithOptions(request: UpdateGroupRequest, runtime: $Util.RuntimeOptions): Promise<UpdateGroupResponse>;
4743
+ /**
4744
+ * You can modify `GroupName` and `Description` for a group.
4745
+ * > 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.
4746
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
4747
+ * ## Limits
4748
+ * 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.
4749
+ *
4750
+ * @param request UpdateGroupRequest
4751
+ * @return UpdateGroupResponse
4752
+ */
3597
4753
  updateGroup(request: UpdateGroupRequest): Promise<UpdateGroupResponse>;
4754
+ /**
4755
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
4756
+ * ## Limits
4757
+ * 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.
4758
+ *
4759
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
4760
+ * @param runtime runtime options for this request RuntimeOptions
4761
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
4762
+ */
3598
4763
  updateInlinePolicyForAccessConfigurationWithOptions(request: UpdateInlinePolicyForAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateInlinePolicyForAccessConfigurationResponse>;
4764
+ /**
4765
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
4766
+ * ## Limits
4767
+ * 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.
4768
+ *
4769
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
4770
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
4771
+ */
3599
4772
  updateInlinePolicyForAccessConfiguration(request: UpdateInlinePolicyForAccessConfigurationRequest): Promise<UpdateInlinePolicyForAccessConfigurationResponse>;
4773
+ /**
4774
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
4775
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
4776
+ *
4777
+ * @param request UpdateMFAAuthenticationSettingsRequest
4778
+ * @param runtime runtime options for this request RuntimeOptions
4779
+ * @return UpdateMFAAuthenticationSettingsResponse
4780
+ */
3600
4781
  updateMFAAuthenticationSettingsWithOptions(request: UpdateMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateMFAAuthenticationSettingsResponse>;
4782
+ /**
4783
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
4784
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
4785
+ *
4786
+ * @param request UpdateMFAAuthenticationSettingsRequest
4787
+ * @return UpdateMFAAuthenticationSettingsResponse
4788
+ */
3601
4789
  updateMFAAuthenticationSettings(request: UpdateMFAAuthenticationSettingsRequest): Promise<UpdateMFAAuthenticationSettingsResponse>;
4790
+ /**
4791
+ * 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.
4792
+ * ## Limits
4793
+ * 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.
4794
+ *
4795
+ * @param request UpdateSCIMServerCredentialStatusRequest
4796
+ * @param runtime runtime options for this request RuntimeOptions
4797
+ * @return UpdateSCIMServerCredentialStatusResponse
4798
+ */
3602
4799
  updateSCIMServerCredentialStatusWithOptions(request: UpdateSCIMServerCredentialStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateSCIMServerCredentialStatusResponse>;
4800
+ /**
4801
+ * 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.
4802
+ * ## Limits
4803
+ * 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.
4804
+ *
4805
+ * @param request UpdateSCIMServerCredentialStatusRequest
4806
+ * @return UpdateSCIMServerCredentialStatusResponse
4807
+ */
3603
4808
  updateSCIMServerCredentialStatus(request: UpdateSCIMServerCredentialStatusRequest): Promise<UpdateSCIMServerCredentialStatusResponse>;
4809
+ /**
4810
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
4811
+ * > 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.
4812
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
4813
+ * ## Limits
4814
+ * 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.
4815
+ *
4816
+ * @param request UpdateUserRequest
4817
+ * @param runtime runtime options for this request RuntimeOptions
4818
+ * @return UpdateUserResponse
4819
+ */
3604
4820
  updateUserWithOptions(request: UpdateUserRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserResponse>;
4821
+ /**
4822
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
4823
+ * > 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.
4824
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
4825
+ * ## Limits
4826
+ * 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.
4827
+ *
4828
+ * @param request UpdateUserRequest
4829
+ * @return UpdateUserResponse
4830
+ */
3605
4831
  updateUser(request: UpdateUserRequest): Promise<UpdateUserResponse>;
4832
+ /**
4833
+ * 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.
4834
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
4835
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
4836
+ *
4837
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
4838
+ * @param runtime runtime options for this request RuntimeOptions
4839
+ * @return UpdateUserMFAAuthenticationSettingsResponse
4840
+ */
3606
4841
  updateUserMFAAuthenticationSettingsWithOptions(request: UpdateUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserMFAAuthenticationSettingsResponse>;
4842
+ /**
4843
+ * 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.
4844
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
4845
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
4846
+ *
4847
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
4848
+ * @return UpdateUserMFAAuthenticationSettingsResponse
4849
+ */
3607
4850
  updateUserMFAAuthenticationSettings(request: UpdateUserMFAAuthenticationSettingsRequest): Promise<UpdateUserMFAAuthenticationSettingsResponse>;
4851
+ /**
4852
+ * 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.
4853
+ * ## Limits
4854
+ * 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.
4855
+ *
4856
+ * @param request UpdateUserStatusRequest
4857
+ * @param runtime runtime options for this request RuntimeOptions
4858
+ * @return UpdateUserStatusResponse
4859
+ */
3608
4860
  updateUserStatusWithOptions(request: UpdateUserStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserStatusResponse>;
4861
+ /**
4862
+ * 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.
4863
+ * ## Limits
4864
+ * 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.
4865
+ *
4866
+ * @param request UpdateUserStatusRequest
4867
+ * @return UpdateUserStatusResponse
4868
+ */
3609
4869
  updateUserStatus(request: UpdateUserStatusRequest): Promise<UpdateUserStatusResponse>;
3610
4870
  }