@alicloud/cloudsso20210515 1.4.2 → 1.5.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 +1323 -711
- package/dist/client.js +1401 -716
- package/dist/client.js.map +1 -1
- package/package.json +3 -3
- package/src/client.ts +1423 -711
package/dist/client.d.ts
CHANGED
|
@@ -906,6 +906,46 @@ export declare class DeprovisionAccessConfigurationResponse extends $tea.Model {
|
|
|
906
906
|
[key: string]: any;
|
|
907
907
|
});
|
|
908
908
|
}
|
|
909
|
+
export declare class DisableDelegateAccountRequest extends $tea.Model {
|
|
910
|
+
accountId?: string;
|
|
911
|
+
static names(): {
|
|
912
|
+
[key: string]: string;
|
|
913
|
+
};
|
|
914
|
+
static types(): {
|
|
915
|
+
[key: string]: any;
|
|
916
|
+
};
|
|
917
|
+
constructor(map?: {
|
|
918
|
+
[key: string]: any;
|
|
919
|
+
});
|
|
920
|
+
}
|
|
921
|
+
export declare class DisableDelegateAccountResponseBody extends $tea.Model {
|
|
922
|
+
requestId?: string;
|
|
923
|
+
static names(): {
|
|
924
|
+
[key: string]: string;
|
|
925
|
+
};
|
|
926
|
+
static types(): {
|
|
927
|
+
[key: string]: any;
|
|
928
|
+
};
|
|
929
|
+
constructor(map?: {
|
|
930
|
+
[key: string]: any;
|
|
931
|
+
});
|
|
932
|
+
}
|
|
933
|
+
export declare class DisableDelegateAccountResponse extends $tea.Model {
|
|
934
|
+
headers?: {
|
|
935
|
+
[key: string]: string;
|
|
936
|
+
};
|
|
937
|
+
statusCode?: number;
|
|
938
|
+
body?: DisableDelegateAccountResponseBody;
|
|
939
|
+
static names(): {
|
|
940
|
+
[key: string]: string;
|
|
941
|
+
};
|
|
942
|
+
static types(): {
|
|
943
|
+
[key: string]: any;
|
|
944
|
+
};
|
|
945
|
+
constructor(map?: {
|
|
946
|
+
[key: string]: any;
|
|
947
|
+
});
|
|
948
|
+
}
|
|
909
949
|
export declare class DisableServiceResponseBody extends $tea.Model {
|
|
910
950
|
requestId?: string;
|
|
911
951
|
static names(): {
|
|
@@ -934,6 +974,46 @@ export declare class DisableServiceResponse extends $tea.Model {
|
|
|
934
974
|
[key: string]: any;
|
|
935
975
|
});
|
|
936
976
|
}
|
|
977
|
+
export declare class EnableDelegateAccountRequest extends $tea.Model {
|
|
978
|
+
accountId?: string;
|
|
979
|
+
static names(): {
|
|
980
|
+
[key: string]: string;
|
|
981
|
+
};
|
|
982
|
+
static types(): {
|
|
983
|
+
[key: string]: any;
|
|
984
|
+
};
|
|
985
|
+
constructor(map?: {
|
|
986
|
+
[key: string]: any;
|
|
987
|
+
});
|
|
988
|
+
}
|
|
989
|
+
export declare class EnableDelegateAccountResponseBody extends $tea.Model {
|
|
990
|
+
requestId?: string;
|
|
991
|
+
static names(): {
|
|
992
|
+
[key: string]: string;
|
|
993
|
+
};
|
|
994
|
+
static types(): {
|
|
995
|
+
[key: string]: any;
|
|
996
|
+
};
|
|
997
|
+
constructor(map?: {
|
|
998
|
+
[key: string]: any;
|
|
999
|
+
});
|
|
1000
|
+
}
|
|
1001
|
+
export declare class EnableDelegateAccountResponse extends $tea.Model {
|
|
1002
|
+
headers?: {
|
|
1003
|
+
[key: string]: string;
|
|
1004
|
+
};
|
|
1005
|
+
statusCode?: number;
|
|
1006
|
+
body?: EnableDelegateAccountResponseBody;
|
|
1007
|
+
static names(): {
|
|
1008
|
+
[key: string]: string;
|
|
1009
|
+
};
|
|
1010
|
+
static types(): {
|
|
1011
|
+
[key: string]: any;
|
|
1012
|
+
};
|
|
1013
|
+
constructor(map?: {
|
|
1014
|
+
[key: string]: any;
|
|
1015
|
+
});
|
|
1016
|
+
}
|
|
937
1017
|
export declare class EnableServiceResponseBody extends $tea.Model {
|
|
938
1018
|
requestId?: string;
|
|
939
1019
|
static names(): {
|
|
@@ -4641,1136 +4721,1668 @@ export default class Client extends OpenApi {
|
|
|
4641
4721
|
[key: string]: string;
|
|
4642
4722
|
}, endpoint: string): string;
|
|
4643
4723
|
/**
|
|
4644
|
-
|
|
4645
|
-
|
|
4646
|
-
|
|
4647
|
-
|
|
4648
|
-
|
|
4649
|
-
|
|
4724
|
+
* @summary Adds a Security Assertion Markup Language (SAML) signing certificate.
|
|
4725
|
+
*
|
|
4726
|
+
* @description You can add up to two SAML signing certificates.
|
|
4727
|
+
* This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
|
|
4728
|
+
*
|
|
4729
|
+
* @param request AddExternalSAMLIdPCertificateRequest
|
|
4730
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4731
|
+
* @return AddExternalSAMLIdPCertificateResponse
|
|
4650
4732
|
*/
|
|
4651
4733
|
addExternalSAMLIdPCertificateWithOptions(request: AddExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<AddExternalSAMLIdPCertificateResponse>;
|
|
4652
4734
|
/**
|
|
4653
|
-
|
|
4654
|
-
|
|
4655
|
-
|
|
4656
|
-
|
|
4657
|
-
|
|
4735
|
+
* @summary Adds a Security Assertion Markup Language (SAML) signing certificate.
|
|
4736
|
+
*
|
|
4737
|
+
* @description You can add up to two SAML signing certificates.
|
|
4738
|
+
* This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
|
|
4739
|
+
*
|
|
4740
|
+
* @param request AddExternalSAMLIdPCertificateRequest
|
|
4741
|
+
* @return AddExternalSAMLIdPCertificateResponse
|
|
4658
4742
|
*/
|
|
4659
4743
|
addExternalSAMLIdPCertificate(request: AddExternalSAMLIdPCertificateRequest): Promise<AddExternalSAMLIdPCertificateResponse>;
|
|
4660
4744
|
/**
|
|
4661
|
-
|
|
4662
|
-
|
|
4663
|
-
|
|
4664
|
-
|
|
4665
|
-
|
|
4745
|
+
* @summary Adds a policy to an access configuration.
|
|
4746
|
+
*
|
|
4747
|
+
* @description This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
|
|
4748
|
+
*
|
|
4749
|
+
* @param request AddPermissionPolicyToAccessConfigurationRequest
|
|
4750
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4751
|
+
* @return AddPermissionPolicyToAccessConfigurationResponse
|
|
4666
4752
|
*/
|
|
4667
4753
|
addPermissionPolicyToAccessConfigurationWithOptions(request: AddPermissionPolicyToAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<AddPermissionPolicyToAccessConfigurationResponse>;
|
|
4668
4754
|
/**
|
|
4669
|
-
|
|
4670
|
-
|
|
4671
|
-
|
|
4672
|
-
|
|
4755
|
+
* @summary Adds a policy to an access configuration.
|
|
4756
|
+
*
|
|
4757
|
+
* @description This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
|
|
4758
|
+
*
|
|
4759
|
+
* @param request AddPermissionPolicyToAccessConfigurationRequest
|
|
4760
|
+
* @return AddPermissionPolicyToAccessConfigurationResponse
|
|
4673
4761
|
*/
|
|
4674
4762
|
addPermissionPolicyToAccessConfiguration(request: AddPermissionPolicyToAccessConfigurationRequest): Promise<AddPermissionPolicyToAccessConfigurationResponse>;
|
|
4675
4763
|
/**
|
|
4676
|
-
|
|
4677
|
-
|
|
4678
|
-
|
|
4679
|
-
|
|
4680
|
-
|
|
4681
|
-
|
|
4764
|
+
* @summary Adds a user to a group.
|
|
4765
|
+
*
|
|
4766
|
+
* @description 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.
|
|
4767
|
+
* This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
|
|
4768
|
+
*
|
|
4769
|
+
* @param request AddUserToGroupRequest
|
|
4770
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4771
|
+
* @return AddUserToGroupResponse
|
|
4682
4772
|
*/
|
|
4683
4773
|
addUserToGroupWithOptions(request: AddUserToGroupRequest, runtime: $Util.RuntimeOptions): Promise<AddUserToGroupResponse>;
|
|
4684
4774
|
/**
|
|
4685
|
-
|
|
4686
|
-
|
|
4687
|
-
|
|
4688
|
-
|
|
4689
|
-
|
|
4775
|
+
* @summary Adds a user to a group.
|
|
4776
|
+
*
|
|
4777
|
+
* @description 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.
|
|
4778
|
+
* This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
|
|
4779
|
+
*
|
|
4780
|
+
* @param request AddUserToGroupRequest
|
|
4781
|
+
* @return AddUserToGroupResponse
|
|
4690
4782
|
*/
|
|
4691
4783
|
addUserToGroup(request: AddUserToGroupRequest): Promise<AddUserToGroupResponse>;
|
|
4692
4784
|
/**
|
|
4693
|
-
|
|
4694
|
-
|
|
4695
|
-
|
|
4696
|
-
|
|
4697
|
-
|
|
4698
|
-
|
|
4785
|
+
* @summary Clears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
|
|
4786
|
+
*
|
|
4787
|
+
* @description 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.
|
|
4788
|
+
* This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
|
|
4789
|
+
*
|
|
4790
|
+
* @param request ClearExternalSAMLIdentityProviderRequest
|
|
4791
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4792
|
+
* @return ClearExternalSAMLIdentityProviderResponse
|
|
4699
4793
|
*/
|
|
4700
4794
|
clearExternalSAMLIdentityProviderWithOptions(request: ClearExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<ClearExternalSAMLIdentityProviderResponse>;
|
|
4701
4795
|
/**
|
|
4702
|
-
|
|
4703
|
-
|
|
4704
|
-
|
|
4705
|
-
|
|
4706
|
-
|
|
4796
|
+
* @summary Clears the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
|
|
4797
|
+
*
|
|
4798
|
+
* @description 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.
|
|
4799
|
+
* This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
|
|
4800
|
+
*
|
|
4801
|
+
* @param request ClearExternalSAMLIdentityProviderRequest
|
|
4802
|
+
* @return ClearExternalSAMLIdentityProviderResponse
|
|
4707
4803
|
*/
|
|
4708
4804
|
clearExternalSAMLIdentityProvider(request: ClearExternalSAMLIdentityProviderRequest): Promise<ClearExternalSAMLIdentityProviderResponse>;
|
|
4709
4805
|
/**
|
|
4710
|
-
|
|
4711
|
-
|
|
4712
|
-
|
|
4713
|
-
|
|
4714
|
-
|
|
4715
|
-
|
|
4716
|
-
|
|
4806
|
+
* @summary Assigns access permissions on an account in your resource directory to a user or a group by using an access configuration.
|
|
4807
|
+
*
|
|
4808
|
+
* @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
|
|
4809
|
+
* For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](https://help.aliyun.com/document_detail/266726.html).
|
|
4810
|
+
* 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.
|
|
4811
|
+
*
|
|
4812
|
+
* @param request CreateAccessAssignmentRequest
|
|
4813
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4814
|
+
* @return CreateAccessAssignmentResponse
|
|
4717
4815
|
*/
|
|
4718
4816
|
createAccessAssignmentWithOptions(request: CreateAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessAssignmentResponse>;
|
|
4719
4817
|
/**
|
|
4720
|
-
|
|
4721
|
-
|
|
4722
|
-
|
|
4723
|
-
|
|
4724
|
-
|
|
4725
|
-
|
|
4818
|
+
* @summary Assigns access permissions on an account in your resource directory to a user or a group by using an access configuration.
|
|
4819
|
+
*
|
|
4820
|
+
* @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
|
|
4821
|
+
* For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](https://help.aliyun.com/document_detail/266726.html).
|
|
4822
|
+
* 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.
|
|
4823
|
+
*
|
|
4824
|
+
* @param request CreateAccessAssignmentRequest
|
|
4825
|
+
* @return CreateAccessAssignmentResponse
|
|
4726
4826
|
*/
|
|
4727
4827
|
createAccessAssignment(request: CreateAccessAssignmentRequest): Promise<CreateAccessAssignmentResponse>;
|
|
4728
4828
|
/**
|
|
4729
|
-
|
|
4730
|
-
|
|
4731
|
-
|
|
4732
|
-
|
|
4733
|
-
|
|
4734
|
-
|
|
4829
|
+
* @summary Creates an access configuration.
|
|
4830
|
+
*
|
|
4831
|
+
* @description For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
|
|
4832
|
+
* This topic provides an example on how to create an access configuration named `ECS-Admin`.
|
|
4833
|
+
*
|
|
4834
|
+
* @param request CreateAccessConfigurationRequest
|
|
4835
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4836
|
+
* @return CreateAccessConfigurationResponse
|
|
4735
4837
|
*/
|
|
4736
4838
|
createAccessConfigurationWithOptions(request: CreateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<CreateAccessConfigurationResponse>;
|
|
4737
4839
|
/**
|
|
4738
|
-
|
|
4739
|
-
|
|
4740
|
-
|
|
4741
|
-
|
|
4742
|
-
|
|
4840
|
+
* @summary Creates an access configuration.
|
|
4841
|
+
*
|
|
4842
|
+
* @description For more information about access configurations, see [Overview of access configurations](https://help.aliyun.com/document_detail/266737.html).
|
|
4843
|
+
* This topic provides an example on how to create an access configuration named `ECS-Admin`.
|
|
4844
|
+
*
|
|
4845
|
+
* @param request CreateAccessConfigurationRequest
|
|
4846
|
+
* @return CreateAccessConfigurationResponse
|
|
4743
4847
|
*/
|
|
4744
4848
|
createAccessConfiguration(request: CreateAccessConfigurationRequest): Promise<CreateAccessConfigurationResponse>;
|
|
4745
4849
|
/**
|
|
4746
|
-
|
|
4747
|
-
|
|
4748
|
-
|
|
4749
|
-
|
|
4750
|
-
|
|
4751
|
-
|
|
4752
|
-
|
|
4753
|
-
|
|
4754
|
-
|
|
4755
|
-
|
|
4850
|
+
* @summary Creates a directory.
|
|
4851
|
+
*
|
|
4852
|
+
* @description 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.
|
|
4853
|
+
* 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.
|
|
4854
|
+
* This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
|
|
4855
|
+
* ## Limits
|
|
4856
|
+
* - You can create only one directory for a management account.
|
|
4857
|
+
* - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
|
|
4858
|
+
*
|
|
4859
|
+
* @param request CreateDirectoryRequest
|
|
4860
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4861
|
+
* @return CreateDirectoryResponse
|
|
4756
4862
|
*/
|
|
4757
4863
|
createDirectoryWithOptions(request: CreateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<CreateDirectoryResponse>;
|
|
4758
4864
|
/**
|
|
4759
|
-
|
|
4760
|
-
|
|
4761
|
-
|
|
4762
|
-
|
|
4763
|
-
|
|
4764
|
-
|
|
4765
|
-
|
|
4766
|
-
|
|
4767
|
-
|
|
4865
|
+
* @summary Creates a directory.
|
|
4866
|
+
*
|
|
4867
|
+
* @description 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.
|
|
4868
|
+
* 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.
|
|
4869
|
+
* This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
|
|
4870
|
+
* ## Limits
|
|
4871
|
+
* - You can create only one directory for a management account.
|
|
4872
|
+
* - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
|
|
4873
|
+
*
|
|
4874
|
+
* @param request CreateDirectoryRequest
|
|
4875
|
+
* @return CreateDirectoryResponse
|
|
4768
4876
|
*/
|
|
4769
4877
|
createDirectory(request: CreateDirectoryRequest): Promise<CreateDirectoryResponse>;
|
|
4770
4878
|
/**
|
|
4771
|
-
|
|
4772
|
-
|
|
4773
|
-
|
|
4774
|
-
|
|
4775
|
-
|
|
4879
|
+
* @summary Creates a group.
|
|
4880
|
+
*
|
|
4881
|
+
* @description This topic provides an example on how to create a group named `TestGroup`.
|
|
4882
|
+
*
|
|
4883
|
+
* @param request CreateGroupRequest
|
|
4884
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4885
|
+
* @return CreateGroupResponse
|
|
4776
4886
|
*/
|
|
4777
4887
|
createGroupWithOptions(request: CreateGroupRequest, runtime: $Util.RuntimeOptions): Promise<CreateGroupResponse>;
|
|
4778
4888
|
/**
|
|
4779
|
-
|
|
4780
|
-
|
|
4781
|
-
|
|
4782
|
-
|
|
4889
|
+
* @summary Creates a group.
|
|
4890
|
+
*
|
|
4891
|
+
* @description This topic provides an example on how to create a group named `TestGroup`.
|
|
4892
|
+
*
|
|
4893
|
+
* @param request CreateGroupRequest
|
|
4894
|
+
* @return CreateGroupResponse
|
|
4783
4895
|
*/
|
|
4784
4896
|
createGroup(request: CreateGroupRequest): Promise<CreateGroupResponse>;
|
|
4785
4897
|
/**
|
|
4786
|
-
|
|
4787
|
-
|
|
4788
|
-
|
|
4789
|
-
|
|
4790
|
-
|
|
4791
|
-
|
|
4898
|
+
* @summary Creates a Cross-domain Identity Management (SCIM) credential.
|
|
4899
|
+
*
|
|
4900
|
+
* @description SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
|
|
4901
|
+
* This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
|
|
4902
|
+
*
|
|
4903
|
+
* @param request CreateSCIMServerCredentialRequest
|
|
4904
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4905
|
+
* @return CreateSCIMServerCredentialResponse
|
|
4792
4906
|
*/
|
|
4793
4907
|
createSCIMServerCredentialWithOptions(request: CreateSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<CreateSCIMServerCredentialResponse>;
|
|
4794
4908
|
/**
|
|
4795
|
-
|
|
4796
|
-
|
|
4797
|
-
|
|
4798
|
-
|
|
4799
|
-
|
|
4909
|
+
* @summary Creates a Cross-domain Identity Management (SCIM) credential.
|
|
4910
|
+
*
|
|
4911
|
+
* @description SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
|
|
4912
|
+
* This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
|
|
4913
|
+
*
|
|
4914
|
+
* @param request CreateSCIMServerCredentialRequest
|
|
4915
|
+
* @return CreateSCIMServerCredentialResponse
|
|
4800
4916
|
*/
|
|
4801
4917
|
createSCIMServerCredential(request: CreateSCIMServerCredentialRequest): Promise<CreateSCIMServerCredentialResponse>;
|
|
4802
4918
|
/**
|
|
4803
|
-
|
|
4804
|
-
|
|
4805
|
-
|
|
4806
|
-
|
|
4807
|
-
|
|
4919
|
+
* @summary Creates a user.
|
|
4920
|
+
*
|
|
4921
|
+
* @description This topic provides an example on how to create a user named `Alice`.
|
|
4922
|
+
*
|
|
4923
|
+
* @param request CreateUserRequest
|
|
4924
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4925
|
+
* @return CreateUserResponse
|
|
4808
4926
|
*/
|
|
4809
4927
|
createUserWithOptions(request: CreateUserRequest, runtime: $Util.RuntimeOptions): Promise<CreateUserResponse>;
|
|
4810
4928
|
/**
|
|
4811
|
-
|
|
4812
|
-
|
|
4813
|
-
|
|
4814
|
-
|
|
4929
|
+
* @summary Creates a user.
|
|
4930
|
+
*
|
|
4931
|
+
* @description This topic provides an example on how to create a user named `Alice`.
|
|
4932
|
+
*
|
|
4933
|
+
* @param request CreateUserRequest
|
|
4934
|
+
* @return CreateUserResponse
|
|
4815
4935
|
*/
|
|
4816
4936
|
createUser(request: CreateUserRequest): Promise<CreateUserResponse>;
|
|
4937
|
+
/**
|
|
4938
|
+
* @summary Creates a Resource Access Management (RAM) user provisioning.
|
|
4939
|
+
*
|
|
4940
|
+
* @param request CreateUserProvisioningRequest
|
|
4941
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4942
|
+
* @return CreateUserProvisioningResponse
|
|
4943
|
+
*/
|
|
4817
4944
|
createUserProvisioningWithOptions(request: CreateUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<CreateUserProvisioningResponse>;
|
|
4945
|
+
/**
|
|
4946
|
+
* @summary Creates a Resource Access Management (RAM) user provisioning.
|
|
4947
|
+
*
|
|
4948
|
+
* @param request CreateUserProvisioningRequest
|
|
4949
|
+
* @return CreateUserProvisioningResponse
|
|
4950
|
+
*/
|
|
4818
4951
|
createUserProvisioning(request: CreateUserProvisioningRequest): Promise<CreateUserProvisioningResponse>;
|
|
4819
4952
|
/**
|
|
4820
|
-
|
|
4821
|
-
|
|
4822
|
-
|
|
4823
|
-
|
|
4824
|
-
|
|
4825
|
-
|
|
4953
|
+
* @summary Removes the access permissions on an account in a resource directory.
|
|
4954
|
+
*
|
|
4955
|
+
* @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
|
|
4956
|
+
* 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****`.
|
|
4957
|
+
*
|
|
4958
|
+
* @param request DeleteAccessAssignmentRequest
|
|
4959
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4960
|
+
* @return DeleteAccessAssignmentResponse
|
|
4826
4961
|
*/
|
|
4827
4962
|
deleteAccessAssignmentWithOptions(request: DeleteAccessAssignmentRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessAssignmentResponse>;
|
|
4828
4963
|
/**
|
|
4829
|
-
|
|
4830
|
-
|
|
4831
|
-
|
|
4832
|
-
|
|
4833
|
-
|
|
4964
|
+
* @summary Removes the access permissions on an account in a resource directory.
|
|
4965
|
+
*
|
|
4966
|
+
* @description When you call this operation, an asynchronous task is created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
|
|
4967
|
+
* 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****`.
|
|
4968
|
+
*
|
|
4969
|
+
* @param request DeleteAccessAssignmentRequest
|
|
4970
|
+
* @return DeleteAccessAssignmentResponse
|
|
4834
4971
|
*/
|
|
4835
4972
|
deleteAccessAssignment(request: DeleteAccessAssignmentRequest): Promise<DeleteAccessAssignmentResponse>;
|
|
4836
4973
|
/**
|
|
4837
|
-
|
|
4838
|
-
|
|
4839
|
-
|
|
4840
|
-
|
|
4841
|
-
|
|
4842
|
-
|
|
4843
|
-
|
|
4974
|
+
* @summary Deletes an access configuration.
|
|
4975
|
+
*
|
|
4976
|
+
* @description This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
|
|
4977
|
+
* ## Prerequisites
|
|
4978
|
+
* The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](https://help.aliyun.com/document_detail/338352.html).
|
|
4979
|
+
*
|
|
4980
|
+
* @param request DeleteAccessConfigurationRequest
|
|
4981
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
4982
|
+
* @return DeleteAccessConfigurationResponse
|
|
4844
4983
|
*/
|
|
4845
4984
|
deleteAccessConfigurationWithOptions(request: DeleteAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeleteAccessConfigurationResponse>;
|
|
4846
4985
|
/**
|
|
4847
|
-
|
|
4848
|
-
|
|
4849
|
-
|
|
4850
|
-
|
|
4851
|
-
|
|
4852
|
-
|
|
4986
|
+
* @summary Deletes an access configuration.
|
|
4987
|
+
*
|
|
4988
|
+
* @description This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
|
|
4989
|
+
* ## Prerequisites
|
|
4990
|
+
* The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](https://help.aliyun.com/document_detail/338352.html).
|
|
4991
|
+
*
|
|
4992
|
+
* @param request DeleteAccessConfigurationRequest
|
|
4993
|
+
* @return DeleteAccessConfigurationResponse
|
|
4853
4994
|
*/
|
|
4854
4995
|
deleteAccessConfiguration(request: DeleteAccessConfigurationRequest): Promise<DeleteAccessConfigurationResponse>;
|
|
4855
4996
|
/**
|
|
4856
|
-
|
|
4857
|
-
|
|
4858
|
-
|
|
4859
|
-
|
|
4860
|
-
|
|
4861
|
-
|
|
4862
|
-
|
|
4863
|
-
|
|
4864
|
-
|
|
4865
|
-
|
|
4866
|
-
|
|
4867
|
-
|
|
4868
|
-
|
|
4997
|
+
* @summary Deletes a directory.
|
|
4998
|
+
*
|
|
4999
|
+
* @description This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
|
|
5000
|
+
* ## Prerequisites
|
|
5001
|
+
* No resources are contained in the directory that you want to delete.
|
|
5002
|
+
* * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
5003
|
+
* * Users are deleted. For more information, see [DeleteUser](https://help.aliyun.com/document_detail/341671.html).
|
|
5004
|
+
* * Groups are deleted. For more information, see [DeleteGroup](https://help.aliyun.com/document_detail/341821.html).
|
|
5005
|
+
* * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](https://help.aliyun.com/document_detail/336907.html).
|
|
5006
|
+
* * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](https://help.aliyun.com/document_detail/341842.html).
|
|
5007
|
+
* * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](https://help.aliyun.com/document_detail/341573.html).
|
|
5008
|
+
*
|
|
5009
|
+
* @param request DeleteDirectoryRequest
|
|
5010
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5011
|
+
* @return DeleteDirectoryResponse
|
|
4869
5012
|
*/
|
|
4870
5013
|
deleteDirectoryWithOptions(request: DeleteDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<DeleteDirectoryResponse>;
|
|
4871
5014
|
/**
|
|
4872
|
-
|
|
4873
|
-
|
|
4874
|
-
|
|
4875
|
-
|
|
4876
|
-
|
|
4877
|
-
|
|
4878
|
-
|
|
4879
|
-
|
|
4880
|
-
|
|
4881
|
-
|
|
4882
|
-
|
|
4883
|
-
|
|
5015
|
+
* @summary Deletes a directory.
|
|
5016
|
+
*
|
|
5017
|
+
* @description This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
|
|
5018
|
+
* ## Prerequisites
|
|
5019
|
+
* No resources are contained in the directory that you want to delete.
|
|
5020
|
+
* * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
5021
|
+
* * Users are deleted. For more information, see [DeleteUser](https://help.aliyun.com/document_detail/341671.html).
|
|
5022
|
+
* * Groups are deleted. For more information, see [DeleteGroup](https://help.aliyun.com/document_detail/341821.html).
|
|
5023
|
+
* * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](https://help.aliyun.com/document_detail/336907.html).
|
|
5024
|
+
* * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](https://help.aliyun.com/document_detail/341842.html).
|
|
5025
|
+
* * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](https://help.aliyun.com/document_detail/341573.html).
|
|
5026
|
+
*
|
|
5027
|
+
* @param request DeleteDirectoryRequest
|
|
5028
|
+
* @return DeleteDirectoryResponse
|
|
4884
5029
|
*/
|
|
4885
5030
|
deleteDirectory(request: DeleteDirectoryRequest): Promise<DeleteDirectoryResponse>;
|
|
4886
5031
|
/**
|
|
4887
|
-
|
|
4888
|
-
|
|
4889
|
-
|
|
4890
|
-
|
|
4891
|
-
|
|
4892
|
-
|
|
4893
|
-
|
|
4894
|
-
|
|
4895
|
-
|
|
5032
|
+
* @summary Deletes a group.
|
|
5033
|
+
*
|
|
5034
|
+
* @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
|
|
5035
|
+
* ## Prerequisites
|
|
5036
|
+
* 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.
|
|
5037
|
+
* * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
5038
|
+
* * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
5039
|
+
*
|
|
5040
|
+
* @param request DeleteGroupRequest
|
|
5041
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5042
|
+
* @return DeleteGroupResponse
|
|
4896
5043
|
*/
|
|
4897
5044
|
deleteGroupWithOptions(request: DeleteGroupRequest, runtime: $Util.RuntimeOptions): Promise<DeleteGroupResponse>;
|
|
4898
5045
|
/**
|
|
4899
|
-
|
|
4900
|
-
|
|
4901
|
-
|
|
4902
|
-
|
|
4903
|
-
|
|
4904
|
-
|
|
4905
|
-
|
|
4906
|
-
|
|
5046
|
+
* @summary Deletes a group.
|
|
5047
|
+
*
|
|
5048
|
+
* @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
|
|
5049
|
+
* ## Prerequisites
|
|
5050
|
+
* 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.
|
|
5051
|
+
* * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
5052
|
+
* * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
5053
|
+
*
|
|
5054
|
+
* @param request DeleteGroupRequest
|
|
5055
|
+
* @return DeleteGroupResponse
|
|
4907
5056
|
*/
|
|
4908
5057
|
deleteGroup(request: DeleteGroupRequest): Promise<DeleteGroupResponse>;
|
|
4909
5058
|
/**
|
|
4910
|
-
|
|
4911
|
-
|
|
4912
|
-
|
|
4913
|
-
|
|
4914
|
-
|
|
5059
|
+
* @summary Unbinds a multi-factor authentication (MFA) device from a user.
|
|
5060
|
+
*
|
|
5061
|
+
* @description This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
|
|
5062
|
+
*
|
|
5063
|
+
* @param request DeleteMFADeviceForUserRequest
|
|
5064
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5065
|
+
* @return DeleteMFADeviceForUserResponse
|
|
4915
5066
|
*/
|
|
4916
5067
|
deleteMFADeviceForUserWithOptions(request: DeleteMFADeviceForUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteMFADeviceForUserResponse>;
|
|
4917
5068
|
/**
|
|
4918
|
-
|
|
4919
|
-
|
|
4920
|
-
|
|
4921
|
-
|
|
5069
|
+
* @summary Unbinds a multi-factor authentication (MFA) device from a user.
|
|
5070
|
+
*
|
|
5071
|
+
* @description This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
|
|
5072
|
+
*
|
|
5073
|
+
* @param request DeleteMFADeviceForUserRequest
|
|
5074
|
+
* @return DeleteMFADeviceForUserResponse
|
|
4922
5075
|
*/
|
|
4923
5076
|
deleteMFADeviceForUser(request: DeleteMFADeviceForUserRequest): Promise<DeleteMFADeviceForUserResponse>;
|
|
4924
5077
|
/**
|
|
4925
|
-
|
|
4926
|
-
|
|
4927
|
-
|
|
4928
|
-
|
|
4929
|
-
|
|
4930
|
-
|
|
5078
|
+
* @summary Deletes a Cross-domain Identity Management (SCIM) credential.
|
|
5079
|
+
*
|
|
5080
|
+
* @description After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
|
|
5081
|
+
* This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
|
|
5082
|
+
*
|
|
5083
|
+
* @param request DeleteSCIMServerCredentialRequest
|
|
5084
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5085
|
+
* @return DeleteSCIMServerCredentialResponse
|
|
4931
5086
|
*/
|
|
4932
5087
|
deleteSCIMServerCredentialWithOptions(request: DeleteSCIMServerCredentialRequest, runtime: $Util.RuntimeOptions): Promise<DeleteSCIMServerCredentialResponse>;
|
|
4933
5088
|
/**
|
|
4934
|
-
|
|
4935
|
-
|
|
4936
|
-
|
|
4937
|
-
|
|
4938
|
-
|
|
5089
|
+
* @summary Deletes a Cross-domain Identity Management (SCIM) credential.
|
|
5090
|
+
*
|
|
5091
|
+
* @description After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
|
|
5092
|
+
* This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
|
|
5093
|
+
*
|
|
5094
|
+
* @param request DeleteSCIMServerCredentialRequest
|
|
5095
|
+
* @return DeleteSCIMServerCredentialResponse
|
|
4939
5096
|
*/
|
|
4940
5097
|
deleteSCIMServerCredential(request: DeleteSCIMServerCredentialRequest): Promise<DeleteSCIMServerCredentialResponse>;
|
|
4941
5098
|
/**
|
|
4942
|
-
|
|
4943
|
-
|
|
4944
|
-
|
|
4945
|
-
|
|
4946
|
-
|
|
4947
|
-
|
|
4948
|
-
|
|
4949
|
-
|
|
4950
|
-
|
|
4951
|
-
|
|
5099
|
+
* @summary Deletes a user.
|
|
5100
|
+
*
|
|
5101
|
+
* @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
|
|
5102
|
+
* ## Prerequisites
|
|
5103
|
+
* 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.
|
|
5104
|
+
* * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](https://help.aliyun.com/document_detail/341675.html).
|
|
5105
|
+
* * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
5106
|
+
* * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
5107
|
+
*
|
|
5108
|
+
* @param request DeleteUserRequest
|
|
5109
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5110
|
+
* @return DeleteUserResponse
|
|
4952
5111
|
*/
|
|
4953
5112
|
deleteUserWithOptions(request: DeleteUserRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserResponse>;
|
|
4954
5113
|
/**
|
|
4955
|
-
|
|
4956
|
-
|
|
4957
|
-
|
|
4958
|
-
|
|
4959
|
-
|
|
4960
|
-
|
|
4961
|
-
|
|
4962
|
-
|
|
4963
|
-
|
|
5114
|
+
* @summary Deletes a user.
|
|
5115
|
+
*
|
|
5116
|
+
* @description If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
|
|
5117
|
+
* ## Prerequisites
|
|
5118
|
+
* 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.
|
|
5119
|
+
* * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](https://help.aliyun.com/document_detail/341675.html).
|
|
5120
|
+
* * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
5121
|
+
* * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
5122
|
+
*
|
|
5123
|
+
* @param request DeleteUserRequest
|
|
5124
|
+
* @return DeleteUserResponse
|
|
4964
5125
|
*/
|
|
4965
5126
|
deleteUser(request: DeleteUserRequest): Promise<DeleteUserResponse>;
|
|
5127
|
+
/**
|
|
5128
|
+
* @summary Deletes a Resource Access Management (RAM) user provisioning.
|
|
5129
|
+
*
|
|
5130
|
+
* @param request DeleteUserProvisioningRequest
|
|
5131
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5132
|
+
* @return DeleteUserProvisioningResponse
|
|
5133
|
+
*/
|
|
4966
5134
|
deleteUserProvisioningWithOptions(request: DeleteUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserProvisioningResponse>;
|
|
5135
|
+
/**
|
|
5136
|
+
* @summary Deletes a Resource Access Management (RAM) user provisioning.
|
|
5137
|
+
*
|
|
5138
|
+
* @param request DeleteUserProvisioningRequest
|
|
5139
|
+
* @return DeleteUserProvisioningResponse
|
|
5140
|
+
*/
|
|
4967
5141
|
deleteUserProvisioning(request: DeleteUserProvisioningRequest): Promise<DeleteUserProvisioningResponse>;
|
|
5142
|
+
/**
|
|
5143
|
+
* @summary Deletes a Resource Access Management (RAM) user provisioning event.
|
|
5144
|
+
*
|
|
5145
|
+
* @param request DeleteUserProvisioningEventRequest
|
|
5146
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5147
|
+
* @return DeleteUserProvisioningEventResponse
|
|
5148
|
+
*/
|
|
4968
5149
|
deleteUserProvisioningEventWithOptions(request: DeleteUserProvisioningEventRequest, runtime: $Util.RuntimeOptions): Promise<DeleteUserProvisioningEventResponse>;
|
|
5150
|
+
/**
|
|
5151
|
+
* @summary Deletes a Resource Access Management (RAM) user provisioning event.
|
|
5152
|
+
*
|
|
5153
|
+
* @param request DeleteUserProvisioningEventRequest
|
|
5154
|
+
* @return DeleteUserProvisioningEventResponse
|
|
5155
|
+
*/
|
|
4969
5156
|
deleteUserProvisioningEvent(request: DeleteUserProvisioningEventRequest): Promise<DeleteUserProvisioningEventResponse>;
|
|
4970
5157
|
/**
|
|
4971
|
-
|
|
4972
|
-
|
|
4973
|
-
|
|
4974
|
-
|
|
4975
|
-
|
|
4976
|
-
|
|
5158
|
+
* @summary De-provisions an access configuration from an account in your resource directory.
|
|
5159
|
+
*
|
|
5160
|
+
* @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
|
|
5161
|
+
* This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
|
|
5162
|
+
*
|
|
5163
|
+
* @param request DeprovisionAccessConfigurationRequest
|
|
5164
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5165
|
+
* @return DeprovisionAccessConfigurationResponse
|
|
4977
5166
|
*/
|
|
4978
5167
|
deprovisionAccessConfigurationWithOptions(request: DeprovisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<DeprovisionAccessConfigurationResponse>;
|
|
4979
5168
|
/**
|
|
4980
|
-
|
|
4981
|
-
|
|
4982
|
-
|
|
4983
|
-
|
|
4984
|
-
|
|
5169
|
+
* @summary De-provisions an access configuration from an account in your resource directory.
|
|
5170
|
+
*
|
|
5171
|
+
* @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
|
|
5172
|
+
* This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
|
|
5173
|
+
*
|
|
5174
|
+
* @param request DeprovisionAccessConfigurationRequest
|
|
5175
|
+
* @return DeprovisionAccessConfigurationResponse
|
|
4985
5176
|
*/
|
|
4986
5177
|
deprovisionAccessConfiguration(request: DeprovisionAccessConfigurationRequest): Promise<DeprovisionAccessConfigurationResponse>;
|
|
4987
5178
|
/**
|
|
4988
|
-
|
|
4989
|
-
|
|
4990
|
-
|
|
4991
|
-
|
|
4992
|
-
|
|
5179
|
+
* @summary DisableDelegateAccount
|
|
5180
|
+
*
|
|
5181
|
+
* @param request DisableDelegateAccountRequest
|
|
5182
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5183
|
+
* @return DisableDelegateAccountResponse
|
|
5184
|
+
*/
|
|
5185
|
+
disableDelegateAccountWithOptions(request: DisableDelegateAccountRequest, runtime: $Util.RuntimeOptions): Promise<DisableDelegateAccountResponse>;
|
|
5186
|
+
/**
|
|
5187
|
+
* @summary DisableDelegateAccount
|
|
5188
|
+
*
|
|
5189
|
+
* @param request DisableDelegateAccountRequest
|
|
5190
|
+
* @return DisableDelegateAccountResponse
|
|
5191
|
+
*/
|
|
5192
|
+
disableDelegateAccount(request: DisableDelegateAccountRequest): Promise<DisableDelegateAccountResponse>;
|
|
5193
|
+
/**
|
|
5194
|
+
* @summary Disables CloudSSO.
|
|
5195
|
+
*
|
|
5196
|
+
* @description 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.
|
|
5197
|
+
*
|
|
5198
|
+
* @param request DisableServiceRequest
|
|
5199
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5200
|
+
* @return DisableServiceResponse
|
|
4993
5201
|
*/
|
|
4994
5202
|
disableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<DisableServiceResponse>;
|
|
4995
5203
|
/**
|
|
4996
|
-
|
|
4997
|
-
|
|
4998
|
-
|
|
5204
|
+
* @summary Disables CloudSSO.
|
|
5205
|
+
*
|
|
5206
|
+
* @description 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.
|
|
5207
|
+
*
|
|
5208
|
+
* @return DisableServiceResponse
|
|
4999
5209
|
*/
|
|
5000
5210
|
disableService(): Promise<DisableServiceResponse>;
|
|
5001
5211
|
/**
|
|
5002
|
-
|
|
5003
|
-
|
|
5004
|
-
|
|
5005
|
-
|
|
5006
|
-
|
|
5007
|
-
|
|
5212
|
+
* @summary EnableDelegateAccount
|
|
5213
|
+
*
|
|
5214
|
+
* @param request EnableDelegateAccountRequest
|
|
5215
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5216
|
+
* @return EnableDelegateAccountResponse
|
|
5217
|
+
*/
|
|
5218
|
+
enableDelegateAccountWithOptions(request: EnableDelegateAccountRequest, runtime: $Util.RuntimeOptions): Promise<EnableDelegateAccountResponse>;
|
|
5219
|
+
/**
|
|
5220
|
+
* @summary EnableDelegateAccount
|
|
5221
|
+
*
|
|
5222
|
+
* @param request EnableDelegateAccountRequest
|
|
5223
|
+
* @return EnableDelegateAccountResponse
|
|
5224
|
+
*/
|
|
5225
|
+
enableDelegateAccount(request: EnableDelegateAccountRequest): Promise<EnableDelegateAccountResponse>;
|
|
5226
|
+
/**
|
|
5227
|
+
* @summary Enables CloudSSO.
|
|
5228
|
+
*
|
|
5229
|
+
* @description 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](https://help.aliyun.com/document_detail/262819.html).
|
|
5230
|
+
* 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).
|
|
5231
|
+
*
|
|
5232
|
+
* @param request EnableServiceRequest
|
|
5233
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5234
|
+
* @return EnableServiceResponse
|
|
5008
5235
|
*/
|
|
5009
5236
|
enableServiceWithOptions(runtime: $Util.RuntimeOptions): Promise<EnableServiceResponse>;
|
|
5010
5237
|
/**
|
|
5011
|
-
|
|
5012
|
-
|
|
5013
|
-
|
|
5014
|
-
|
|
5238
|
+
* @summary Enables CloudSSO.
|
|
5239
|
+
*
|
|
5240
|
+
* @description 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](https://help.aliyun.com/document_detail/262819.html).
|
|
5241
|
+
* 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).
|
|
5242
|
+
*
|
|
5243
|
+
* @return EnableServiceResponse
|
|
5015
5244
|
*/
|
|
5016
5245
|
enableService(): Promise<EnableServiceResponse>;
|
|
5017
5246
|
/**
|
|
5018
|
-
|
|
5019
|
-
|
|
5020
|
-
|
|
5021
|
-
|
|
5022
|
-
|
|
5247
|
+
* @summary Queries information about an access configuration.
|
|
5248
|
+
*
|
|
5249
|
+
* @description This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
|
|
5250
|
+
*
|
|
5251
|
+
* @param request GetAccessConfigurationRequest
|
|
5252
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5253
|
+
* @return GetAccessConfigurationResponse
|
|
5023
5254
|
*/
|
|
5024
5255
|
getAccessConfigurationWithOptions(request: GetAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<GetAccessConfigurationResponse>;
|
|
5025
5256
|
/**
|
|
5026
|
-
|
|
5027
|
-
|
|
5028
|
-
|
|
5029
|
-
|
|
5257
|
+
* @summary Queries information about an access configuration.
|
|
5258
|
+
*
|
|
5259
|
+
* @description This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
|
|
5260
|
+
*
|
|
5261
|
+
* @param request GetAccessConfigurationRequest
|
|
5262
|
+
* @return GetAccessConfigurationResponse
|
|
5030
5263
|
*/
|
|
5031
5264
|
getAccessConfiguration(request: GetAccessConfigurationRequest): Promise<GetAccessConfigurationResponse>;
|
|
5032
5265
|
/**
|
|
5033
|
-
|
|
5034
|
-
|
|
5035
|
-
|
|
5036
|
-
|
|
5037
|
-
|
|
5266
|
+
* @summary Queries information about a directory.
|
|
5267
|
+
*
|
|
5268
|
+
* @description This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
|
|
5269
|
+
*
|
|
5270
|
+
* @param request GetDirectoryRequest
|
|
5271
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5272
|
+
* @return GetDirectoryResponse
|
|
5038
5273
|
*/
|
|
5039
5274
|
getDirectoryWithOptions(request: GetDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryResponse>;
|
|
5040
5275
|
/**
|
|
5041
|
-
|
|
5042
|
-
|
|
5043
|
-
|
|
5044
|
-
|
|
5276
|
+
* @summary Queries information about a directory.
|
|
5277
|
+
*
|
|
5278
|
+
* @description This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
|
|
5279
|
+
*
|
|
5280
|
+
* @param request GetDirectoryRequest
|
|
5281
|
+
* @return GetDirectoryResponse
|
|
5045
5282
|
*/
|
|
5046
5283
|
getDirectory(request: GetDirectoryRequest): Promise<GetDirectoryResponse>;
|
|
5047
5284
|
/**
|
|
5048
|
-
|
|
5049
|
-
|
|
5050
|
-
|
|
5051
|
-
|
|
5052
|
-
|
|
5053
|
-
|
|
5285
|
+
* @summary Queries information about a Security Assertion Markup Language (SAML) service provider (SP).
|
|
5286
|
+
*
|
|
5287
|
+
* @description 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).
|
|
5288
|
+
* This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
|
|
5289
|
+
*
|
|
5290
|
+
* @param request GetDirectorySAMLServiceProviderInfoRequest
|
|
5291
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5292
|
+
* @return GetDirectorySAMLServiceProviderInfoResponse
|
|
5054
5293
|
*/
|
|
5055
5294
|
getDirectorySAMLServiceProviderInfoWithOptions(request: GetDirectorySAMLServiceProviderInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectorySAMLServiceProviderInfoResponse>;
|
|
5056
5295
|
/**
|
|
5057
|
-
|
|
5058
|
-
|
|
5059
|
-
|
|
5060
|
-
|
|
5061
|
-
|
|
5296
|
+
* @summary Queries information about a Security Assertion Markup Language (SAML) service provider (SP).
|
|
5297
|
+
*
|
|
5298
|
+
* @description 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).
|
|
5299
|
+
* This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
|
|
5300
|
+
*
|
|
5301
|
+
* @param request GetDirectorySAMLServiceProviderInfoRequest
|
|
5302
|
+
* @return GetDirectorySAMLServiceProviderInfoResponse
|
|
5062
5303
|
*/
|
|
5063
5304
|
getDirectorySAMLServiceProviderInfo(request: GetDirectorySAMLServiceProviderInfoRequest): Promise<GetDirectorySAMLServiceProviderInfoResponse>;
|
|
5064
5305
|
/**
|
|
5065
|
-
|
|
5066
|
-
|
|
5067
|
-
|
|
5068
|
-
|
|
5069
|
-
|
|
5070
|
-
|
|
5071
|
-
|
|
5072
|
-
|
|
5306
|
+
* @summary Queries the statistics of a directory.
|
|
5307
|
+
*
|
|
5308
|
+
* @description ### [](#)
|
|
5309
|
+
* This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
|
|
5310
|
+
* ### [](#qps)Limit
|
|
5311
|
+
* 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.
|
|
5312
|
+
*
|
|
5313
|
+
* @param request GetDirectoryStatisticsRequest
|
|
5314
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5315
|
+
* @return GetDirectoryStatisticsResponse
|
|
5073
5316
|
*/
|
|
5074
5317
|
getDirectoryStatisticsWithOptions(request: GetDirectoryStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<GetDirectoryStatisticsResponse>;
|
|
5075
5318
|
/**
|
|
5076
|
-
|
|
5077
|
-
|
|
5078
|
-
|
|
5079
|
-
|
|
5080
|
-
|
|
5081
|
-
|
|
5082
|
-
|
|
5319
|
+
* @summary Queries the statistics of a directory.
|
|
5320
|
+
*
|
|
5321
|
+
* @description ### [](#)
|
|
5322
|
+
* This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
|
|
5323
|
+
* ### [](#qps)Limit
|
|
5324
|
+
* 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.
|
|
5325
|
+
*
|
|
5326
|
+
* @param request GetDirectoryStatisticsRequest
|
|
5327
|
+
* @return GetDirectoryStatisticsResponse
|
|
5083
5328
|
*/
|
|
5084
5329
|
getDirectoryStatistics(request: GetDirectoryStatisticsRequest): Promise<GetDirectoryStatisticsResponse>;
|
|
5085
5330
|
/**
|
|
5086
|
-
|
|
5087
|
-
|
|
5088
|
-
|
|
5089
|
-
|
|
5090
|
-
|
|
5331
|
+
* @summary Queries the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
|
|
5332
|
+
*
|
|
5333
|
+
* @description This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
|
|
5334
|
+
*
|
|
5335
|
+
* @param request GetExternalSAMLIdentityProviderRequest
|
|
5336
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5337
|
+
* @return GetExternalSAMLIdentityProviderResponse
|
|
5091
5338
|
*/
|
|
5092
5339
|
getExternalSAMLIdentityProviderWithOptions(request: GetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<GetExternalSAMLIdentityProviderResponse>;
|
|
5093
5340
|
/**
|
|
5094
|
-
|
|
5095
|
-
|
|
5096
|
-
|
|
5097
|
-
|
|
5341
|
+
* @summary Queries the configurations of a Security Assertion Markup Language (SAML) identity provider (IdP).
|
|
5342
|
+
*
|
|
5343
|
+
* @description This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
|
|
5344
|
+
*
|
|
5345
|
+
* @param request GetExternalSAMLIdentityProviderRequest
|
|
5346
|
+
* @return GetExternalSAMLIdentityProviderResponse
|
|
5098
5347
|
*/
|
|
5099
5348
|
getExternalSAMLIdentityProvider(request: GetExternalSAMLIdentityProviderRequest): Promise<GetExternalSAMLIdentityProviderResponse>;
|
|
5100
5349
|
/**
|
|
5101
|
-
|
|
5102
|
-
|
|
5103
|
-
|
|
5104
|
-
|
|
5105
|
-
|
|
5350
|
+
* @summary Queries information about a group.
|
|
5351
|
+
*
|
|
5352
|
+
* @description This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
|
|
5353
|
+
*
|
|
5354
|
+
* @param request GetGroupRequest
|
|
5355
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5356
|
+
* @return GetGroupResponse
|
|
5106
5357
|
*/
|
|
5107
5358
|
getGroupWithOptions(request: GetGroupRequest, runtime: $Util.RuntimeOptions): Promise<GetGroupResponse>;
|
|
5108
5359
|
/**
|
|
5109
|
-
|
|
5110
|
-
|
|
5111
|
-
|
|
5112
|
-
|
|
5360
|
+
* @summary Queries information about a group.
|
|
5361
|
+
*
|
|
5362
|
+
* @description This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
|
|
5363
|
+
*
|
|
5364
|
+
* @param request GetGroupRequest
|
|
5365
|
+
* @return GetGroupResponse
|
|
5113
5366
|
*/
|
|
5114
5367
|
getGroup(request: GetGroupRequest): Promise<GetGroupResponse>;
|
|
5368
|
+
/**
|
|
5369
|
+
* @summary Queries the logon preference of CloudSSO users.
|
|
5370
|
+
*
|
|
5371
|
+
* @param request GetLoginPreferenceRequest
|
|
5372
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5373
|
+
* @return GetLoginPreferenceResponse
|
|
5374
|
+
*/
|
|
5115
5375
|
getLoginPreferenceWithOptions(request: GetLoginPreferenceRequest, runtime: $Util.RuntimeOptions): Promise<GetLoginPreferenceResponse>;
|
|
5376
|
+
/**
|
|
5377
|
+
* @summary Queries the logon preference of CloudSSO users.
|
|
5378
|
+
*
|
|
5379
|
+
* @param request GetLoginPreferenceRequest
|
|
5380
|
+
* @return GetLoginPreferenceResponse
|
|
5381
|
+
*/
|
|
5116
5382
|
getLoginPreference(request: GetLoginPreferenceRequest): Promise<GetLoginPreferenceResponse>;
|
|
5117
5383
|
/**
|
|
5118
|
-
|
|
5119
|
-
|
|
5120
|
-
|
|
5121
|
-
|
|
5122
|
-
|
|
5123
|
-
|
|
5384
|
+
* @summary Queries the multi-factor authentication (MFA) setting of all users.
|
|
5385
|
+
*
|
|
5386
|
+
* @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
|
|
5387
|
+
* This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
|
|
5388
|
+
*
|
|
5389
|
+
* @param request GetMFAAuthenticationSettingInfoRequest
|
|
5390
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5391
|
+
* @return GetMFAAuthenticationSettingInfoResponse
|
|
5124
5392
|
*/
|
|
5125
5393
|
getMFAAuthenticationSettingInfoWithOptions(request: GetMFAAuthenticationSettingInfoRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingInfoResponse>;
|
|
5126
5394
|
/**
|
|
5127
|
-
|
|
5128
|
-
|
|
5129
|
-
|
|
5130
|
-
|
|
5131
|
-
|
|
5395
|
+
* @summary Queries the multi-factor authentication (MFA) setting of all users.
|
|
5396
|
+
*
|
|
5397
|
+
* @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
|
|
5398
|
+
* This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
|
|
5399
|
+
*
|
|
5400
|
+
* @param request GetMFAAuthenticationSettingInfoRequest
|
|
5401
|
+
* @return GetMFAAuthenticationSettingInfoResponse
|
|
5132
5402
|
*/
|
|
5133
5403
|
getMFAAuthenticationSettingInfo(request: GetMFAAuthenticationSettingInfoRequest): Promise<GetMFAAuthenticationSettingInfoResponse>;
|
|
5134
5404
|
/**
|
|
5135
|
-
|
|
5136
|
-
|
|
5137
|
-
|
|
5138
|
-
|
|
5139
|
-
|
|
5140
|
-
|
|
5405
|
+
* @summary Queries the multi-factor authentication (MFA) setting of all users.
|
|
5406
|
+
*
|
|
5407
|
+
* @description > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](https://help.aliyun.com/document_detail/611286.html) operation to query more detailed information.
|
|
5408
|
+
* 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.
|
|
5409
|
+
*
|
|
5410
|
+
* @param request GetMFAAuthenticationSettingsRequest
|
|
5411
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5412
|
+
* @return GetMFAAuthenticationSettingsResponse
|
|
5141
5413
|
*/
|
|
5142
5414
|
getMFAAuthenticationSettingsWithOptions(request: GetMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationSettingsResponse>;
|
|
5143
5415
|
/**
|
|
5144
|
-
|
|
5145
|
-
|
|
5146
|
-
|
|
5147
|
-
|
|
5148
|
-
|
|
5416
|
+
* @summary Queries the multi-factor authentication (MFA) setting of all users.
|
|
5417
|
+
*
|
|
5418
|
+
* @description > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](https://help.aliyun.com/document_detail/611286.html) operation to query more detailed information.
|
|
5419
|
+
* 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.
|
|
5420
|
+
*
|
|
5421
|
+
* @param request GetMFAAuthenticationSettingsRequest
|
|
5422
|
+
* @return GetMFAAuthenticationSettingsResponse
|
|
5149
5423
|
*/
|
|
5150
5424
|
getMFAAuthenticationSettings(request: GetMFAAuthenticationSettingsRequest): Promise<GetMFAAuthenticationSettingsResponse>;
|
|
5151
5425
|
/**
|
|
5152
|
-
|
|
5153
|
-
|
|
5154
|
-
|
|
5155
|
-
|
|
5156
|
-
|
|
5426
|
+
* @summary Checks whether multi-factor authentication (MFA) is enabled for users.
|
|
5427
|
+
*
|
|
5428
|
+
* @description 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.
|
|
5429
|
+
*
|
|
5430
|
+
* @param request GetMFAAuthenticationStatusRequest
|
|
5431
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5432
|
+
* @return GetMFAAuthenticationStatusResponse
|
|
5157
5433
|
*/
|
|
5158
5434
|
getMFAAuthenticationStatusWithOptions(request: GetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetMFAAuthenticationStatusResponse>;
|
|
5159
5435
|
/**
|
|
5160
|
-
|
|
5161
|
-
|
|
5162
|
-
|
|
5163
|
-
|
|
5436
|
+
* @summary Checks whether multi-factor authentication (MFA) is enabled for users.
|
|
5437
|
+
*
|
|
5438
|
+
* @description 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.
|
|
5439
|
+
*
|
|
5440
|
+
* @param request GetMFAAuthenticationStatusRequest
|
|
5441
|
+
* @return GetMFAAuthenticationStatusResponse
|
|
5164
5442
|
*/
|
|
5165
5443
|
getMFAAuthenticationStatus(request: GetMFAAuthenticationStatusRequest): Promise<GetMFAAuthenticationStatusResponse>;
|
|
5444
|
+
/**
|
|
5445
|
+
* @summary Queries the password policy of CloudSSO users.
|
|
5446
|
+
*
|
|
5447
|
+
* @param request GetPasswordPolicyRequest
|
|
5448
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5449
|
+
* @return GetPasswordPolicyResponse
|
|
5450
|
+
*/
|
|
5166
5451
|
getPasswordPolicyWithOptions(request: GetPasswordPolicyRequest, runtime: $Util.RuntimeOptions): Promise<GetPasswordPolicyResponse>;
|
|
5452
|
+
/**
|
|
5453
|
+
* @summary Queries the password policy of CloudSSO users.
|
|
5454
|
+
*
|
|
5455
|
+
* @param request GetPasswordPolicyRequest
|
|
5456
|
+
* @return GetPasswordPolicyResponse
|
|
5457
|
+
*/
|
|
5167
5458
|
getPasswordPolicy(request: GetPasswordPolicyRequest): Promise<GetPasswordPolicyResponse>;
|
|
5168
5459
|
/**
|
|
5169
|
-
|
|
5170
|
-
|
|
5171
|
-
|
|
5172
|
-
|
|
5173
|
-
|
|
5460
|
+
* @summary Queries the status of System for Cross-domain Identity Management (SCIM) synchronization.
|
|
5461
|
+
*
|
|
5462
|
+
* @description 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.
|
|
5463
|
+
*
|
|
5464
|
+
* @param request GetSCIMSynchronizationStatusRequest
|
|
5465
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5466
|
+
* @return GetSCIMSynchronizationStatusResponse
|
|
5174
5467
|
*/
|
|
5175
5468
|
getSCIMSynchronizationStatusWithOptions(request: GetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetSCIMSynchronizationStatusResponse>;
|
|
5176
5469
|
/**
|
|
5177
|
-
|
|
5178
|
-
|
|
5179
|
-
|
|
5180
|
-
|
|
5470
|
+
* @summary Queries the status of System for Cross-domain Identity Management (SCIM) synchronization.
|
|
5471
|
+
*
|
|
5472
|
+
* @description 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.
|
|
5473
|
+
*
|
|
5474
|
+
* @param request GetSCIMSynchronizationStatusRequest
|
|
5475
|
+
* @return GetSCIMSynchronizationStatusResponse
|
|
5181
5476
|
*/
|
|
5182
5477
|
getSCIMSynchronizationStatus(request: GetSCIMSynchronizationStatusRequest): Promise<GetSCIMSynchronizationStatusResponse>;
|
|
5478
|
+
/**
|
|
5479
|
+
* @summary Queries the status of CloudSSO.
|
|
5480
|
+
*
|
|
5481
|
+
* @param request GetServiceStatusRequest
|
|
5482
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5483
|
+
* @return GetServiceStatusResponse
|
|
5484
|
+
*/
|
|
5183
5485
|
getServiceStatusWithOptions(runtime: $Util.RuntimeOptions): Promise<GetServiceStatusResponse>;
|
|
5486
|
+
/**
|
|
5487
|
+
* @summary Queries the status of CloudSSO.
|
|
5488
|
+
*
|
|
5489
|
+
* @return GetServiceStatusResponse
|
|
5490
|
+
*/
|
|
5184
5491
|
getServiceStatus(): Promise<GetServiceStatusResponse>;
|
|
5185
5492
|
/**
|
|
5186
|
-
|
|
5187
|
-
|
|
5188
|
-
|
|
5189
|
-
|
|
5190
|
-
|
|
5493
|
+
* @summary Queries information about an asynchronous task.
|
|
5494
|
+
*
|
|
5495
|
+
* @description This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
|
|
5496
|
+
*
|
|
5497
|
+
* @param request GetTaskRequest
|
|
5498
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5499
|
+
* @return GetTaskResponse
|
|
5191
5500
|
*/
|
|
5192
5501
|
getTaskWithOptions(request: GetTaskRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskResponse>;
|
|
5193
5502
|
/**
|
|
5194
|
-
|
|
5195
|
-
|
|
5196
|
-
|
|
5197
|
-
|
|
5503
|
+
* @summary Queries information about an asynchronous task.
|
|
5504
|
+
*
|
|
5505
|
+
* @description This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
|
|
5506
|
+
*
|
|
5507
|
+
* @param request GetTaskRequest
|
|
5508
|
+
* @return GetTaskResponse
|
|
5198
5509
|
*/
|
|
5199
5510
|
getTask(request: GetTaskRequest): Promise<GetTaskResponse>;
|
|
5200
5511
|
/**
|
|
5201
|
-
|
|
5202
|
-
|
|
5203
|
-
|
|
5204
|
-
|
|
5205
|
-
|
|
5206
|
-
|
|
5512
|
+
* @summary Queries the status of an asynchronous task.
|
|
5513
|
+
*
|
|
5514
|
+
* @description 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, call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation.
|
|
5515
|
+
* This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
|
|
5516
|
+
*
|
|
5517
|
+
* @param request GetTaskStatusRequest
|
|
5518
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5519
|
+
* @return GetTaskStatusResponse
|
|
5207
5520
|
*/
|
|
5208
5521
|
getTaskStatusWithOptions(request: GetTaskStatusRequest, runtime: $Util.RuntimeOptions): Promise<GetTaskStatusResponse>;
|
|
5209
5522
|
/**
|
|
5210
|
-
|
|
5211
|
-
|
|
5212
|
-
|
|
5213
|
-
|
|
5214
|
-
|
|
5523
|
+
* @summary Queries the status of an asynchronous task.
|
|
5524
|
+
*
|
|
5525
|
+
* @description 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, call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation.
|
|
5526
|
+
* This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
|
|
5527
|
+
*
|
|
5528
|
+
* @param request GetTaskStatusRequest
|
|
5529
|
+
* @return GetTaskStatusResponse
|
|
5215
5530
|
*/
|
|
5216
5531
|
getTaskStatus(request: GetTaskStatusRequest): Promise<GetTaskStatusResponse>;
|
|
5217
5532
|
/**
|
|
5218
|
-
|
|
5219
|
-
|
|
5220
|
-
|
|
5221
|
-
|
|
5222
|
-
|
|
5533
|
+
* @summary Queries information about a user.
|
|
5534
|
+
*
|
|
5535
|
+
* @description This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
|
|
5536
|
+
*
|
|
5537
|
+
* @param request GetUserRequest
|
|
5538
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5539
|
+
* @return GetUserResponse
|
|
5223
5540
|
*/
|
|
5224
5541
|
getUserWithOptions(request: GetUserRequest, runtime: $Util.RuntimeOptions): Promise<GetUserResponse>;
|
|
5225
5542
|
/**
|
|
5226
|
-
|
|
5227
|
-
|
|
5228
|
-
|
|
5229
|
-
|
|
5543
|
+
* @summary Queries information about a user.
|
|
5544
|
+
*
|
|
5545
|
+
* @description This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
|
|
5546
|
+
*
|
|
5547
|
+
* @param request GetUserRequest
|
|
5548
|
+
* @return GetUserResponse
|
|
5230
5549
|
*/
|
|
5231
5550
|
getUser(request: GetUserRequest): Promise<GetUserResponse>;
|
|
5551
|
+
/**
|
|
5552
|
+
* @summary Queries the ID of a user in a resource directory by using the ExternalId parameter.
|
|
5553
|
+
*
|
|
5554
|
+
* @param tmpReq GetUserIdRequest
|
|
5555
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5556
|
+
* @return GetUserIdResponse
|
|
5557
|
+
*/
|
|
5232
5558
|
getUserIdWithOptions(tmpReq: GetUserIdRequest, runtime: $Util.RuntimeOptions): Promise<GetUserIdResponse>;
|
|
5559
|
+
/**
|
|
5560
|
+
* @summary Queries the ID of a user in a resource directory by using the ExternalId parameter.
|
|
5561
|
+
*
|
|
5562
|
+
* @param request GetUserIdRequest
|
|
5563
|
+
* @return GetUserIdResponse
|
|
5564
|
+
*/
|
|
5233
5565
|
getUserId(request: GetUserIdRequest): Promise<GetUserIdResponse>;
|
|
5234
5566
|
/**
|
|
5235
|
-
|
|
5236
|
-
|
|
5237
|
-
|
|
5238
|
-
|
|
5239
|
-
|
|
5567
|
+
* @summary Queries the multi-factor authentication (MFA) setting of a single user.
|
|
5568
|
+
*
|
|
5569
|
+
* @description 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.
|
|
5570
|
+
*
|
|
5571
|
+
* @param request GetUserMFAAuthenticationSettingsRequest
|
|
5572
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5573
|
+
* @return GetUserMFAAuthenticationSettingsResponse
|
|
5240
5574
|
*/
|
|
5241
5575
|
getUserMFAAuthenticationSettingsWithOptions(request: GetUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<GetUserMFAAuthenticationSettingsResponse>;
|
|
5242
5576
|
/**
|
|
5243
|
-
|
|
5244
|
-
|
|
5245
|
-
|
|
5246
|
-
|
|
5577
|
+
* @summary Queries the multi-factor authentication (MFA) setting of a single user.
|
|
5578
|
+
*
|
|
5579
|
+
* @description 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.
|
|
5580
|
+
*
|
|
5581
|
+
* @param request GetUserMFAAuthenticationSettingsRequest
|
|
5582
|
+
* @return GetUserMFAAuthenticationSettingsResponse
|
|
5247
5583
|
*/
|
|
5248
5584
|
getUserMFAAuthenticationSettings(request: GetUserMFAAuthenticationSettingsRequest): Promise<GetUserMFAAuthenticationSettingsResponse>;
|
|
5585
|
+
/**
|
|
5586
|
+
* @summary Queries a Resource Access Management (RAM) user provisioning.
|
|
5587
|
+
*
|
|
5588
|
+
* @param request GetUserProvisioningRequest
|
|
5589
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5590
|
+
* @return GetUserProvisioningResponse
|
|
5591
|
+
*/
|
|
5249
5592
|
getUserProvisioningWithOptions(request: GetUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningResponse>;
|
|
5593
|
+
/**
|
|
5594
|
+
* @summary Queries a Resource Access Management (RAM) user provisioning.
|
|
5595
|
+
*
|
|
5596
|
+
* @param request GetUserProvisioningRequest
|
|
5597
|
+
* @return GetUserProvisioningResponse
|
|
5598
|
+
*/
|
|
5250
5599
|
getUserProvisioning(request: GetUserProvisioningRequest): Promise<GetUserProvisioningResponse>;
|
|
5600
|
+
/**
|
|
5601
|
+
* @summary Queries the global configurations of a Resource Access Management (RAM) user provisioning.
|
|
5602
|
+
*
|
|
5603
|
+
* @param request GetUserProvisioningConfigurationRequest
|
|
5604
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5605
|
+
* @return GetUserProvisioningConfigurationResponse
|
|
5606
|
+
*/
|
|
5251
5607
|
getUserProvisioningConfigurationWithOptions(request: GetUserProvisioningConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningConfigurationResponse>;
|
|
5608
|
+
/**
|
|
5609
|
+
* @summary Queries the global configurations of a Resource Access Management (RAM) user provisioning.
|
|
5610
|
+
*
|
|
5611
|
+
* @param request GetUserProvisioningConfigurationRequest
|
|
5612
|
+
* @return GetUserProvisioningConfigurationResponse
|
|
5613
|
+
*/
|
|
5252
5614
|
getUserProvisioningConfiguration(request: GetUserProvisioningConfigurationRequest): Promise<GetUserProvisioningConfigurationResponse>;
|
|
5615
|
+
/**
|
|
5616
|
+
* @summary Queries a Resource Access Management (RAM) user provisioning event.
|
|
5617
|
+
*
|
|
5618
|
+
* @param request GetUserProvisioningEventRequest
|
|
5619
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5620
|
+
* @return GetUserProvisioningEventResponse
|
|
5621
|
+
*/
|
|
5253
5622
|
getUserProvisioningEventWithOptions(request: GetUserProvisioningEventRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningEventResponse>;
|
|
5623
|
+
/**
|
|
5624
|
+
* @summary Queries a Resource Access Management (RAM) user provisioning event.
|
|
5625
|
+
*
|
|
5626
|
+
* @param request GetUserProvisioningEventRequest
|
|
5627
|
+
* @return GetUserProvisioningEventResponse
|
|
5628
|
+
*/
|
|
5254
5629
|
getUserProvisioningEvent(request: GetUserProvisioningEventRequest): Promise<GetUserProvisioningEventResponse>;
|
|
5630
|
+
/**
|
|
5631
|
+
* @summary Queries statistics of Resource Access Management (RAM) user provisioning events that are created for the member in a resource directory.
|
|
5632
|
+
*
|
|
5633
|
+
* @param request GetUserProvisioningRdAccountStatisticsRequest
|
|
5634
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5635
|
+
* @return GetUserProvisioningRdAccountStatisticsResponse
|
|
5636
|
+
*/
|
|
5255
5637
|
getUserProvisioningRdAccountStatisticsWithOptions(request: GetUserProvisioningRdAccountStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningRdAccountStatisticsResponse>;
|
|
5638
|
+
/**
|
|
5639
|
+
* @summary Queries statistics of Resource Access Management (RAM) user provisioning events that are created for the member in a resource directory.
|
|
5640
|
+
*
|
|
5641
|
+
* @param request GetUserProvisioningRdAccountStatisticsRequest
|
|
5642
|
+
* @return GetUserProvisioningRdAccountStatisticsResponse
|
|
5643
|
+
*/
|
|
5256
5644
|
getUserProvisioningRdAccountStatistics(request: GetUserProvisioningRdAccountStatisticsRequest): Promise<GetUserProvisioningRdAccountStatisticsResponse>;
|
|
5645
|
+
/**
|
|
5646
|
+
* @summary Queries the statistics of a Resource Access Management (RAM) user provisioning.
|
|
5647
|
+
*
|
|
5648
|
+
* @param request GetUserProvisioningStatisticsRequest
|
|
5649
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5650
|
+
* @return GetUserProvisioningStatisticsResponse
|
|
5651
|
+
*/
|
|
5257
5652
|
getUserProvisioningStatisticsWithOptions(request: GetUserProvisioningStatisticsRequest, runtime: $Util.RuntimeOptions): Promise<GetUserProvisioningStatisticsResponse>;
|
|
5653
|
+
/**
|
|
5654
|
+
* @summary Queries the statistics of a Resource Access Management (RAM) user provisioning.
|
|
5655
|
+
*
|
|
5656
|
+
* @param request GetUserProvisioningStatisticsRequest
|
|
5657
|
+
* @return GetUserProvisioningStatisticsResponse
|
|
5658
|
+
*/
|
|
5258
5659
|
getUserProvisioningStatistics(request: GetUserProvisioningStatisticsRequest): Promise<GetUserProvisioningStatisticsResponse>;
|
|
5259
5660
|
/**
|
|
5260
|
-
|
|
5261
|
-
|
|
5262
|
-
|
|
5263
|
-
|
|
5264
|
-
|
|
5661
|
+
* @summary Queries the access permissions that are assigned.
|
|
5662
|
+
*
|
|
5663
|
+
* @description 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.
|
|
5664
|
+
*
|
|
5665
|
+
* @param request ListAccessAssignmentsRequest
|
|
5666
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5667
|
+
* @return ListAccessAssignmentsResponse
|
|
5265
5668
|
*/
|
|
5266
5669
|
listAccessAssignmentsWithOptions(request: ListAccessAssignmentsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessAssignmentsResponse>;
|
|
5267
5670
|
/**
|
|
5268
|
-
|
|
5269
|
-
|
|
5270
|
-
|
|
5271
|
-
|
|
5671
|
+
* @summary Queries the access permissions that are assigned.
|
|
5672
|
+
*
|
|
5673
|
+
* @description 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.
|
|
5674
|
+
*
|
|
5675
|
+
* @param request ListAccessAssignmentsRequest
|
|
5676
|
+
* @return ListAccessAssignmentsResponse
|
|
5272
5677
|
*/
|
|
5273
5678
|
listAccessAssignments(request: ListAccessAssignmentsRequest): Promise<ListAccessAssignmentsResponse>;
|
|
5274
5679
|
/**
|
|
5275
|
-
|
|
5276
|
-
|
|
5277
|
-
|
|
5278
|
-
|
|
5279
|
-
|
|
5680
|
+
* @summary Queries the access configurations that are provisioned.
|
|
5681
|
+
*
|
|
5682
|
+
* @description 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.
|
|
5683
|
+
*
|
|
5684
|
+
* @param request ListAccessConfigurationProvisioningsRequest
|
|
5685
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5686
|
+
* @return ListAccessConfigurationProvisioningsResponse
|
|
5280
5687
|
*/
|
|
5281
5688
|
listAccessConfigurationProvisioningsWithOptions(request: ListAccessConfigurationProvisioningsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationProvisioningsResponse>;
|
|
5282
5689
|
/**
|
|
5283
|
-
|
|
5284
|
-
|
|
5285
|
-
|
|
5286
|
-
|
|
5690
|
+
* @summary Queries the access configurations that are provisioned.
|
|
5691
|
+
*
|
|
5692
|
+
* @description 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.
|
|
5693
|
+
*
|
|
5694
|
+
* @param request ListAccessConfigurationProvisioningsRequest
|
|
5695
|
+
* @return ListAccessConfigurationProvisioningsResponse
|
|
5287
5696
|
*/
|
|
5288
5697
|
listAccessConfigurationProvisionings(request: ListAccessConfigurationProvisioningsRequest): Promise<ListAccessConfigurationProvisioningsResponse>;
|
|
5289
5698
|
/**
|
|
5290
|
-
|
|
5291
|
-
|
|
5292
|
-
|
|
5293
|
-
|
|
5294
|
-
|
|
5699
|
+
* @summary Queries access configurations.
|
|
5700
|
+
*
|
|
5701
|
+
* @description 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.
|
|
5702
|
+
*
|
|
5703
|
+
* @param request ListAccessConfigurationsRequest
|
|
5704
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5705
|
+
* @return ListAccessConfigurationsResponse
|
|
5295
5706
|
*/
|
|
5296
5707
|
listAccessConfigurationsWithOptions(request: ListAccessConfigurationsRequest, runtime: $Util.RuntimeOptions): Promise<ListAccessConfigurationsResponse>;
|
|
5297
5708
|
/**
|
|
5298
|
-
|
|
5299
|
-
|
|
5300
|
-
|
|
5301
|
-
|
|
5709
|
+
* @summary Queries access configurations.
|
|
5710
|
+
*
|
|
5711
|
+
* @description 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.
|
|
5712
|
+
*
|
|
5713
|
+
* @param request ListAccessConfigurationsRequest
|
|
5714
|
+
* @return ListAccessConfigurationsResponse
|
|
5302
5715
|
*/
|
|
5303
5716
|
listAccessConfigurations(request: ListAccessConfigurationsRequest): Promise<ListAccessConfigurationsResponse>;
|
|
5304
5717
|
/**
|
|
5305
|
-
|
|
5306
|
-
|
|
5307
|
-
|
|
5308
|
-
|
|
5309
|
-
|
|
5718
|
+
* @summary Queries directories.
|
|
5719
|
+
*
|
|
5720
|
+
* @description 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.
|
|
5721
|
+
*
|
|
5722
|
+
* @param request ListDirectoriesRequest
|
|
5723
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5724
|
+
* @return ListDirectoriesResponse
|
|
5310
5725
|
*/
|
|
5311
5726
|
listDirectoriesWithOptions(runtime: $Util.RuntimeOptions): Promise<ListDirectoriesResponse>;
|
|
5312
5727
|
/**
|
|
5313
|
-
|
|
5314
|
-
|
|
5315
|
-
|
|
5728
|
+
* @summary Queries directories.
|
|
5729
|
+
*
|
|
5730
|
+
* @description 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.
|
|
5731
|
+
*
|
|
5732
|
+
* @return ListDirectoriesResponse
|
|
5316
5733
|
*/
|
|
5317
5734
|
listDirectories(): Promise<ListDirectoriesResponse>;
|
|
5318
5735
|
/**
|
|
5319
|
-
|
|
5320
|
-
|
|
5321
|
-
|
|
5322
|
-
|
|
5323
|
-
|
|
5736
|
+
* @summary Queries Security Assertion Markup Language (SAML) signing certificates.
|
|
5737
|
+
*
|
|
5738
|
+
* @description 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.
|
|
5739
|
+
*
|
|
5740
|
+
* @param request ListExternalSAMLIdPCertificatesRequest
|
|
5741
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5742
|
+
* @return ListExternalSAMLIdPCertificatesResponse
|
|
5324
5743
|
*/
|
|
5325
5744
|
listExternalSAMLIdPCertificatesWithOptions(request: ListExternalSAMLIdPCertificatesRequest, runtime: $Util.RuntimeOptions): Promise<ListExternalSAMLIdPCertificatesResponse>;
|
|
5326
5745
|
/**
|
|
5327
|
-
|
|
5328
|
-
|
|
5329
|
-
|
|
5330
|
-
|
|
5746
|
+
* @summary Queries Security Assertion Markup Language (SAML) signing certificates.
|
|
5747
|
+
*
|
|
5748
|
+
* @description 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.
|
|
5749
|
+
*
|
|
5750
|
+
* @param request ListExternalSAMLIdPCertificatesRequest
|
|
5751
|
+
* @return ListExternalSAMLIdPCertificatesResponse
|
|
5331
5752
|
*/
|
|
5332
5753
|
listExternalSAMLIdPCertificates(request: ListExternalSAMLIdPCertificatesRequest): Promise<ListExternalSAMLIdPCertificatesResponse>;
|
|
5333
5754
|
/**
|
|
5334
|
-
|
|
5335
|
-
|
|
5336
|
-
|
|
5337
|
-
|
|
5338
|
-
|
|
5755
|
+
* @summary Queries the users in a group.
|
|
5756
|
+
*
|
|
5757
|
+
* @description 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`.
|
|
5758
|
+
*
|
|
5759
|
+
* @param request ListGroupMembersRequest
|
|
5760
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5761
|
+
* @return ListGroupMembersResponse
|
|
5339
5762
|
*/
|
|
5340
5763
|
listGroupMembersWithOptions(request: ListGroupMembersRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupMembersResponse>;
|
|
5341
5764
|
/**
|
|
5342
|
-
|
|
5343
|
-
|
|
5344
|
-
|
|
5345
|
-
|
|
5765
|
+
* @summary Queries the users in a group.
|
|
5766
|
+
*
|
|
5767
|
+
* @description 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`.
|
|
5768
|
+
*
|
|
5769
|
+
* @param request ListGroupMembersRequest
|
|
5770
|
+
* @return ListGroupMembersResponse
|
|
5346
5771
|
*/
|
|
5347
5772
|
listGroupMembers(request: ListGroupMembersRequest): Promise<ListGroupMembersResponse>;
|
|
5348
5773
|
/**
|
|
5349
|
-
|
|
5350
|
-
|
|
5351
|
-
|
|
5352
|
-
|
|
5353
|
-
|
|
5774
|
+
* @summary Queries groups.
|
|
5775
|
+
*
|
|
5776
|
+
* @description 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.
|
|
5777
|
+
*
|
|
5778
|
+
* @param request ListGroupsRequest
|
|
5779
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5780
|
+
* @return ListGroupsResponse
|
|
5354
5781
|
*/
|
|
5355
5782
|
listGroupsWithOptions(request: ListGroupsRequest, runtime: $Util.RuntimeOptions): Promise<ListGroupsResponse>;
|
|
5356
5783
|
/**
|
|
5357
|
-
|
|
5358
|
-
|
|
5359
|
-
|
|
5360
|
-
|
|
5784
|
+
* @summary Queries groups.
|
|
5785
|
+
*
|
|
5786
|
+
* @description 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.
|
|
5787
|
+
*
|
|
5788
|
+
* @param request ListGroupsRequest
|
|
5789
|
+
* @return ListGroupsResponse
|
|
5361
5790
|
*/
|
|
5362
5791
|
listGroups(request: ListGroupsRequest): Promise<ListGroupsResponse>;
|
|
5363
5792
|
/**
|
|
5364
|
-
|
|
5365
|
-
|
|
5366
|
-
|
|
5367
|
-
|
|
5368
|
-
|
|
5793
|
+
* @summary Queries the groups to which a user is added.
|
|
5794
|
+
*
|
|
5795
|
+
* @description 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.
|
|
5796
|
+
*
|
|
5797
|
+
* @param request ListJoinedGroupsForUserRequest
|
|
5798
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5799
|
+
* @return ListJoinedGroupsForUserResponse
|
|
5369
5800
|
*/
|
|
5370
5801
|
listJoinedGroupsForUserWithOptions(request: ListJoinedGroupsForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListJoinedGroupsForUserResponse>;
|
|
5371
5802
|
/**
|
|
5372
|
-
|
|
5373
|
-
|
|
5374
|
-
|
|
5375
|
-
|
|
5803
|
+
* @summary Queries the groups to which a user is added.
|
|
5804
|
+
*
|
|
5805
|
+
* @description 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.
|
|
5806
|
+
*
|
|
5807
|
+
* @param request ListJoinedGroupsForUserRequest
|
|
5808
|
+
* @return ListJoinedGroupsForUserResponse
|
|
5376
5809
|
*/
|
|
5377
5810
|
listJoinedGroupsForUser(request: ListJoinedGroupsForUserRequest): Promise<ListJoinedGroupsForUserResponse>;
|
|
5378
5811
|
/**
|
|
5379
|
-
|
|
5380
|
-
|
|
5381
|
-
|
|
5382
|
-
|
|
5383
|
-
|
|
5812
|
+
* @summary Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
|
|
5813
|
+
*
|
|
5814
|
+
* @description 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.
|
|
5815
|
+
*
|
|
5816
|
+
* @param request ListMFADevicesForUserRequest
|
|
5817
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5818
|
+
* @return ListMFADevicesForUserResponse
|
|
5384
5819
|
*/
|
|
5385
5820
|
listMFADevicesForUserWithOptions(request: ListMFADevicesForUserRequest, runtime: $Util.RuntimeOptions): Promise<ListMFADevicesForUserResponse>;
|
|
5386
5821
|
/**
|
|
5387
|
-
|
|
5388
|
-
|
|
5389
|
-
|
|
5390
|
-
|
|
5822
|
+
* @summary Queries the multi-factor authentication (MFA) devices that are bound to a user. Up to two MFA devices can be bound to a user.
|
|
5823
|
+
*
|
|
5824
|
+
* @description 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.
|
|
5825
|
+
*
|
|
5826
|
+
* @param request ListMFADevicesForUserRequest
|
|
5827
|
+
* @return ListMFADevicesForUserResponse
|
|
5391
5828
|
*/
|
|
5392
5829
|
listMFADevicesForUser(request: ListMFADevicesForUserRequest): Promise<ListMFADevicesForUserResponse>;
|
|
5393
5830
|
/**
|
|
5394
|
-
|
|
5395
|
-
|
|
5396
|
-
|
|
5397
|
-
|
|
5398
|
-
|
|
5831
|
+
* @summary Queries the policies that are created for an access configuration.
|
|
5832
|
+
*
|
|
5833
|
+
* @description 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.
|
|
5834
|
+
*
|
|
5835
|
+
* @param request ListPermissionPoliciesInAccessConfigurationRequest
|
|
5836
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5837
|
+
* @return ListPermissionPoliciesInAccessConfigurationResponse
|
|
5399
5838
|
*/
|
|
5400
5839
|
listPermissionPoliciesInAccessConfigurationWithOptions(request: ListPermissionPoliciesInAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ListPermissionPoliciesInAccessConfigurationResponse>;
|
|
5401
5840
|
/**
|
|
5402
|
-
|
|
5403
|
-
|
|
5404
|
-
|
|
5405
|
-
|
|
5841
|
+
* @summary Queries the policies that are created for an access configuration.
|
|
5842
|
+
*
|
|
5843
|
+
* @description 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.
|
|
5844
|
+
*
|
|
5845
|
+
* @param request ListPermissionPoliciesInAccessConfigurationRequest
|
|
5846
|
+
* @return ListPermissionPoliciesInAccessConfigurationResponse
|
|
5406
5847
|
*/
|
|
5407
5848
|
listPermissionPoliciesInAccessConfiguration(request: ListPermissionPoliciesInAccessConfigurationRequest): Promise<ListPermissionPoliciesInAccessConfigurationResponse>;
|
|
5408
5849
|
/**
|
|
5409
|
-
|
|
5410
|
-
|
|
5411
|
-
|
|
5412
|
-
|
|
5413
|
-
|
|
5850
|
+
* @summary Queries Cross-domain Identity Management (SCIM) credentials.
|
|
5851
|
+
*
|
|
5852
|
+
* @description This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
|
|
5853
|
+
*
|
|
5854
|
+
* @param request ListSCIMServerCredentialsRequest
|
|
5855
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5856
|
+
* @return ListSCIMServerCredentialsResponse
|
|
5414
5857
|
*/
|
|
5415
5858
|
listSCIMServerCredentialsWithOptions(request: ListSCIMServerCredentialsRequest, runtime: $Util.RuntimeOptions): Promise<ListSCIMServerCredentialsResponse>;
|
|
5416
5859
|
/**
|
|
5417
|
-
|
|
5418
|
-
|
|
5419
|
-
|
|
5420
|
-
|
|
5860
|
+
* @summary Queries Cross-domain Identity Management (SCIM) credentials.
|
|
5861
|
+
*
|
|
5862
|
+
* @description This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
|
|
5863
|
+
*
|
|
5864
|
+
* @param request ListSCIMServerCredentialsRequest
|
|
5865
|
+
* @return ListSCIMServerCredentialsResponse
|
|
5421
5866
|
*/
|
|
5422
5867
|
listSCIMServerCredentials(request: ListSCIMServerCredentialsRequest): Promise<ListSCIMServerCredentialsResponse>;
|
|
5423
5868
|
/**
|
|
5424
|
-
|
|
5425
|
-
|
|
5426
|
-
|
|
5427
|
-
|
|
5428
|
-
|
|
5429
|
-
|
|
5869
|
+
* @summary Queries asynchronous tasks.
|
|
5870
|
+
*
|
|
5871
|
+
* @description 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`.
|
|
5872
|
+
* This topic provides an example on how to query the tasks within the previous 24 hours.
|
|
5873
|
+
*
|
|
5874
|
+
* @param request ListTasksRequest
|
|
5875
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5876
|
+
* @return ListTasksResponse
|
|
5430
5877
|
*/
|
|
5431
5878
|
listTasksWithOptions(request: ListTasksRequest, runtime: $Util.RuntimeOptions): Promise<ListTasksResponse>;
|
|
5432
5879
|
/**
|
|
5433
|
-
|
|
5434
|
-
|
|
5435
|
-
|
|
5436
|
-
|
|
5437
|
-
|
|
5880
|
+
* @summary Queries asynchronous tasks.
|
|
5881
|
+
*
|
|
5882
|
+
* @description 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`.
|
|
5883
|
+
* This topic provides an example on how to query the tasks within the previous 24 hours.
|
|
5884
|
+
*
|
|
5885
|
+
* @param request ListTasksRequest
|
|
5886
|
+
* @return ListTasksResponse
|
|
5438
5887
|
*/
|
|
5439
5888
|
listTasks(request: ListTasksRequest): Promise<ListTasksResponse>;
|
|
5889
|
+
/**
|
|
5890
|
+
* @summary Queries Resource Access Management (RAM) user provisioning events.
|
|
5891
|
+
*
|
|
5892
|
+
* @param request ListUserProvisioningEventsRequest
|
|
5893
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5894
|
+
* @return ListUserProvisioningEventsResponse
|
|
5895
|
+
*/
|
|
5440
5896
|
listUserProvisioningEventsWithOptions(request: ListUserProvisioningEventsRequest, runtime: $Util.RuntimeOptions): Promise<ListUserProvisioningEventsResponse>;
|
|
5897
|
+
/**
|
|
5898
|
+
* @summary Queries Resource Access Management (RAM) user provisioning events.
|
|
5899
|
+
*
|
|
5900
|
+
* @param request ListUserProvisioningEventsRequest
|
|
5901
|
+
* @return ListUserProvisioningEventsResponse
|
|
5902
|
+
*/
|
|
5441
5903
|
listUserProvisioningEvents(request: ListUserProvisioningEventsRequest): Promise<ListUserProvisioningEventsResponse>;
|
|
5904
|
+
/**
|
|
5905
|
+
* @summary Queries Resource Access Management (RAM) user provisionings.
|
|
5906
|
+
*
|
|
5907
|
+
* @param request ListUserProvisioningsRequest
|
|
5908
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5909
|
+
* @return ListUserProvisioningsResponse
|
|
5910
|
+
*/
|
|
5442
5911
|
listUserProvisioningsWithOptions(request: ListUserProvisioningsRequest, runtime: $Util.RuntimeOptions): Promise<ListUserProvisioningsResponse>;
|
|
5912
|
+
/**
|
|
5913
|
+
* @summary Queries Resource Access Management (RAM) user provisionings.
|
|
5914
|
+
*
|
|
5915
|
+
* @param request ListUserProvisioningsRequest
|
|
5916
|
+
* @return ListUserProvisioningsResponse
|
|
5917
|
+
*/
|
|
5443
5918
|
listUserProvisionings(request: ListUserProvisioningsRequest): Promise<ListUserProvisioningsResponse>;
|
|
5444
5919
|
/**
|
|
5445
|
-
|
|
5446
|
-
|
|
5447
|
-
|
|
5448
|
-
|
|
5449
|
-
|
|
5920
|
+
* @summary Queries users.
|
|
5921
|
+
*
|
|
5922
|
+
* @description 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.
|
|
5923
|
+
*
|
|
5924
|
+
* @param request ListUsersRequest
|
|
5925
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5926
|
+
* @return ListUsersResponse
|
|
5450
5927
|
*/
|
|
5451
5928
|
listUsersWithOptions(request: ListUsersRequest, runtime: $Util.RuntimeOptions): Promise<ListUsersResponse>;
|
|
5452
5929
|
/**
|
|
5453
|
-
|
|
5454
|
-
|
|
5455
|
-
|
|
5456
|
-
|
|
5930
|
+
* @summary Queries users.
|
|
5931
|
+
*
|
|
5932
|
+
* @description 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.
|
|
5933
|
+
*
|
|
5934
|
+
* @param request ListUsersRequest
|
|
5935
|
+
* @return ListUsersResponse
|
|
5457
5936
|
*/
|
|
5458
5937
|
listUsers(request: ListUsersRequest): Promise<ListUsersResponse>;
|
|
5459
5938
|
/**
|
|
5460
|
-
|
|
5461
|
-
|
|
5462
|
-
|
|
5463
|
-
|
|
5464
|
-
|
|
5465
|
-
|
|
5939
|
+
* @summary Provisions an access configuration for an account in your resource directory.
|
|
5940
|
+
*
|
|
5941
|
+
* @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
|
|
5942
|
+
* This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
|
|
5943
|
+
*
|
|
5944
|
+
* @param request ProvisionAccessConfigurationRequest
|
|
5945
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5946
|
+
* @return ProvisionAccessConfigurationResponse
|
|
5466
5947
|
*/
|
|
5467
5948
|
provisionAccessConfigurationWithOptions(request: ProvisionAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<ProvisionAccessConfigurationResponse>;
|
|
5468
5949
|
/**
|
|
5469
|
-
|
|
5470
|
-
|
|
5471
|
-
|
|
5472
|
-
|
|
5473
|
-
|
|
5950
|
+
* @summary Provisions an access configuration for an account in your resource directory.
|
|
5951
|
+
*
|
|
5952
|
+
* @description When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](https://help.aliyun.com/document_detail/340670.html) operation to query the progress of the task based on the value of the `TaskId` response parameter.
|
|
5953
|
+
* This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
|
|
5954
|
+
*
|
|
5955
|
+
* @param request ProvisionAccessConfigurationRequest
|
|
5956
|
+
* @return ProvisionAccessConfigurationResponse
|
|
5474
5957
|
*/
|
|
5475
5958
|
provisionAccessConfiguration(request: ProvisionAccessConfigurationRequest): Promise<ProvisionAccessConfigurationResponse>;
|
|
5476
5959
|
/**
|
|
5477
|
-
|
|
5478
|
-
|
|
5479
|
-
|
|
5480
|
-
|
|
5481
|
-
|
|
5960
|
+
* @summary Removes a Security Assertion Markup Language (SAML) signing certificate.
|
|
5961
|
+
*
|
|
5962
|
+
* @description This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
|
|
5963
|
+
*
|
|
5964
|
+
* @param request RemoveExternalSAMLIdPCertificateRequest
|
|
5965
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5966
|
+
* @return RemoveExternalSAMLIdPCertificateResponse
|
|
5482
5967
|
*/
|
|
5483
5968
|
removeExternalSAMLIdPCertificateWithOptions(request: RemoveExternalSAMLIdPCertificateRequest, runtime: $Util.RuntimeOptions): Promise<RemoveExternalSAMLIdPCertificateResponse>;
|
|
5484
5969
|
/**
|
|
5485
|
-
|
|
5486
|
-
|
|
5487
|
-
|
|
5488
|
-
|
|
5970
|
+
* @summary Removes a Security Assertion Markup Language (SAML) signing certificate.
|
|
5971
|
+
*
|
|
5972
|
+
* @description This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
|
|
5973
|
+
*
|
|
5974
|
+
* @param request RemoveExternalSAMLIdPCertificateRequest
|
|
5975
|
+
* @return RemoveExternalSAMLIdPCertificateResponse
|
|
5489
5976
|
*/
|
|
5490
5977
|
removeExternalSAMLIdPCertificate(request: RemoveExternalSAMLIdPCertificateRequest): Promise<RemoveExternalSAMLIdPCertificateResponse>;
|
|
5491
5978
|
/**
|
|
5492
|
-
|
|
5493
|
-
|
|
5494
|
-
|
|
5495
|
-
|
|
5496
|
-
|
|
5497
|
-
|
|
5979
|
+
* @summary Removes a policy from an access configuration.
|
|
5980
|
+
*
|
|
5981
|
+
* @description After you remove an inline policy from an access configuration, the policy cannot be restored.
|
|
5982
|
+
* This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
|
|
5983
|
+
*
|
|
5984
|
+
* @param request RemovePermissionPolicyFromAccessConfigurationRequest
|
|
5985
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
5986
|
+
* @return RemovePermissionPolicyFromAccessConfigurationResponse
|
|
5498
5987
|
*/
|
|
5499
5988
|
removePermissionPolicyFromAccessConfigurationWithOptions(request: RemovePermissionPolicyFromAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<RemovePermissionPolicyFromAccessConfigurationResponse>;
|
|
5500
5989
|
/**
|
|
5501
|
-
|
|
5502
|
-
|
|
5503
|
-
|
|
5504
|
-
|
|
5505
|
-
|
|
5990
|
+
* @summary Removes a policy from an access configuration.
|
|
5991
|
+
*
|
|
5992
|
+
* @description After you remove an inline policy from an access configuration, the policy cannot be restored.
|
|
5993
|
+
* This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
|
|
5994
|
+
*
|
|
5995
|
+
* @param request RemovePermissionPolicyFromAccessConfigurationRequest
|
|
5996
|
+
* @return RemovePermissionPolicyFromAccessConfigurationResponse
|
|
5506
5997
|
*/
|
|
5507
5998
|
removePermissionPolicyFromAccessConfiguration(request: RemovePermissionPolicyFromAccessConfigurationRequest): Promise<RemovePermissionPolicyFromAccessConfigurationResponse>;
|
|
5508
5999
|
/**
|
|
5509
|
-
|
|
5510
|
-
|
|
5511
|
-
|
|
5512
|
-
|
|
5513
|
-
|
|
5514
|
-
|
|
6000
|
+
* @summary Removes a user from a group.
|
|
6001
|
+
*
|
|
6002
|
+
* @description 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.
|
|
6003
|
+
* This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
|
|
6004
|
+
*
|
|
6005
|
+
* @param request RemoveUserFromGroupRequest
|
|
6006
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6007
|
+
* @return RemoveUserFromGroupResponse
|
|
5515
6008
|
*/
|
|
5516
6009
|
removeUserFromGroupWithOptions(request: RemoveUserFromGroupRequest, runtime: $Util.RuntimeOptions): Promise<RemoveUserFromGroupResponse>;
|
|
5517
6010
|
/**
|
|
5518
|
-
|
|
5519
|
-
|
|
5520
|
-
|
|
5521
|
-
|
|
5522
|
-
|
|
6011
|
+
* @summary Removes a user from a group.
|
|
6012
|
+
*
|
|
6013
|
+
* @description 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.
|
|
6014
|
+
* This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
|
|
6015
|
+
*
|
|
6016
|
+
* @param request RemoveUserFromGroupRequest
|
|
6017
|
+
* @return RemoveUserFromGroupResponse
|
|
5523
6018
|
*/
|
|
5524
6019
|
removeUserFromGroup(request: RemoveUserFromGroupRequest): Promise<RemoveUserFromGroupResponse>;
|
|
5525
6020
|
/**
|
|
5526
|
-
|
|
5527
|
-
|
|
5528
|
-
|
|
5529
|
-
|
|
5530
|
-
|
|
5531
|
-
|
|
5532
|
-
|
|
6021
|
+
* @summary Resets the password of a user.
|
|
6022
|
+
*
|
|
6023
|
+
* @description If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
|
|
6024
|
+
* > After you enable SSO logon, your password cannot be reset.
|
|
6025
|
+
* 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.
|
|
6026
|
+
*
|
|
6027
|
+
* @param request ResetUserPasswordRequest
|
|
6028
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6029
|
+
* @return ResetUserPasswordResponse
|
|
5533
6030
|
*/
|
|
5534
6031
|
resetUserPasswordWithOptions(request: ResetUserPasswordRequest, runtime: $Util.RuntimeOptions): Promise<ResetUserPasswordResponse>;
|
|
5535
6032
|
/**
|
|
5536
|
-
|
|
5537
|
-
|
|
5538
|
-
|
|
5539
|
-
|
|
5540
|
-
|
|
5541
|
-
|
|
6033
|
+
* @summary Resets the password of a user.
|
|
6034
|
+
*
|
|
6035
|
+
* @description If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
|
|
6036
|
+
* > After you enable SSO logon, your password cannot be reset.
|
|
6037
|
+
* 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.
|
|
6038
|
+
*
|
|
6039
|
+
* @param request ResetUserPasswordRequest
|
|
6040
|
+
* @return ResetUserPasswordResponse
|
|
5542
6041
|
*/
|
|
5543
6042
|
resetUserPassword(request: ResetUserPasswordRequest): Promise<ResetUserPasswordResponse>;
|
|
6043
|
+
/**
|
|
6044
|
+
* @summary Retries a Resource Access Management (RAM) user provisioning event.
|
|
6045
|
+
*
|
|
6046
|
+
* @param request RetryUserProvisioningEventRequest
|
|
6047
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6048
|
+
* @return RetryUserProvisioningEventResponse
|
|
6049
|
+
*/
|
|
5544
6050
|
retryUserProvisioningEventWithOptions(request: RetryUserProvisioningEventRequest, runtime: $Util.RuntimeOptions): Promise<RetryUserProvisioningEventResponse>;
|
|
6051
|
+
/**
|
|
6052
|
+
* @summary Retries a Resource Access Management (RAM) user provisioning event.
|
|
6053
|
+
*
|
|
6054
|
+
* @param request RetryUserProvisioningEventRequest
|
|
6055
|
+
* @return RetryUserProvisioningEventResponse
|
|
6056
|
+
*/
|
|
5545
6057
|
retryUserProvisioningEvent(request: RetryUserProvisioningEventRequest): Promise<RetryUserProvisioningEventResponse>;
|
|
5546
6058
|
/**
|
|
5547
|
-
|
|
5548
|
-
|
|
5549
|
-
|
|
5550
|
-
|
|
5551
|
-
|
|
5552
|
-
|
|
5553
|
-
|
|
5554
|
-
|
|
5555
|
-
|
|
5556
|
-
|
|
5557
|
-
|
|
5558
|
-
|
|
5559
|
-
|
|
6059
|
+
* @summary Configures a Security Assertion Markup Language (SAML) identity provider (IdP).
|
|
6060
|
+
*
|
|
6061
|
+
* @description 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.
|
|
6062
|
+
* 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.
|
|
6063
|
+
* * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
|
|
6064
|
+
* * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
|
|
6065
|
+
* If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
|
|
6066
|
+
* * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
|
|
6067
|
+
* * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
|
|
6068
|
+
* > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
|
|
6069
|
+
* This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
|
|
6070
|
+
*
|
|
6071
|
+
* @param request SetExternalSAMLIdentityProviderRequest
|
|
6072
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6073
|
+
* @return SetExternalSAMLIdentityProviderResponse
|
|
5560
6074
|
*/
|
|
5561
6075
|
setExternalSAMLIdentityProviderWithOptions(request: SetExternalSAMLIdentityProviderRequest, runtime: $Util.RuntimeOptions): Promise<SetExternalSAMLIdentityProviderResponse>;
|
|
5562
6076
|
/**
|
|
5563
|
-
|
|
5564
|
-
|
|
5565
|
-
|
|
5566
|
-
|
|
5567
|
-
|
|
5568
|
-
|
|
5569
|
-
|
|
5570
|
-
|
|
5571
|
-
|
|
5572
|
-
|
|
5573
|
-
|
|
5574
|
-
|
|
6077
|
+
* @summary Configures a Security Assertion Markup Language (SAML) identity provider (IdP).
|
|
6078
|
+
*
|
|
6079
|
+
* @description 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.
|
|
6080
|
+
* 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.
|
|
6081
|
+
* * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
|
|
6082
|
+
* * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
|
|
6083
|
+
* If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
|
|
6084
|
+
* * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
|
|
6085
|
+
* * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
|
|
6086
|
+
* > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
|
|
6087
|
+
* This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
|
|
6088
|
+
*
|
|
6089
|
+
* @param request SetExternalSAMLIdentityProviderRequest
|
|
6090
|
+
* @return SetExternalSAMLIdentityProviderResponse
|
|
5575
6091
|
*/
|
|
5576
6092
|
setExternalSAMLIdentityProvider(request: SetExternalSAMLIdentityProviderRequest): Promise<SetExternalSAMLIdentityProviderResponse>;
|
|
6093
|
+
/**
|
|
6094
|
+
* @summary Configures the logon preference of CloudSSO users.
|
|
6095
|
+
*
|
|
6096
|
+
* @param request SetLoginPreferenceRequest
|
|
6097
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6098
|
+
* @return SetLoginPreferenceResponse
|
|
6099
|
+
*/
|
|
5577
6100
|
setLoginPreferenceWithOptions(request: SetLoginPreferenceRequest, runtime: $Util.RuntimeOptions): Promise<SetLoginPreferenceResponse>;
|
|
6101
|
+
/**
|
|
6102
|
+
* @summary Configures the logon preference of CloudSSO users.
|
|
6103
|
+
*
|
|
6104
|
+
* @param request SetLoginPreferenceRequest
|
|
6105
|
+
* @return SetLoginPreferenceResponse
|
|
6106
|
+
*/
|
|
5578
6107
|
setLoginPreference(request: SetLoginPreferenceRequest): Promise<SetLoginPreferenceResponse>;
|
|
5579
6108
|
/**
|
|
5580
|
-
|
|
5581
|
-
|
|
5582
|
-
|
|
5583
|
-
|
|
5584
|
-
|
|
5585
|
-
|
|
6109
|
+
* @summary Enables or disables multi-factor authentication (MFA) for users in a directory.
|
|
6110
|
+
*
|
|
6111
|
+
* @description 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.
|
|
6112
|
+
* This topic provides an example on how to enable MFA for users.
|
|
6113
|
+
*
|
|
6114
|
+
* @param request SetMFAAuthenticationStatusRequest
|
|
6115
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6116
|
+
* @return SetMFAAuthenticationStatusResponse
|
|
5586
6117
|
*/
|
|
5587
6118
|
setMFAAuthenticationStatusWithOptions(request: SetMFAAuthenticationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetMFAAuthenticationStatusResponse>;
|
|
5588
6119
|
/**
|
|
5589
|
-
|
|
5590
|
-
|
|
5591
|
-
|
|
5592
|
-
|
|
5593
|
-
|
|
6120
|
+
* @summary Enables or disables multi-factor authentication (MFA) for users in a directory.
|
|
6121
|
+
*
|
|
6122
|
+
* @description 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.
|
|
6123
|
+
* This topic provides an example on how to enable MFA for users.
|
|
6124
|
+
*
|
|
6125
|
+
* @param request SetMFAAuthenticationStatusRequest
|
|
6126
|
+
* @return SetMFAAuthenticationStatusResponse
|
|
5594
6127
|
*/
|
|
5595
6128
|
setMFAAuthenticationStatus(request: SetMFAAuthenticationStatusRequest): Promise<SetMFAAuthenticationStatusResponse>;
|
|
6129
|
+
/**
|
|
6130
|
+
* @summary Configures a password policy for CloudSSO users.
|
|
6131
|
+
*
|
|
6132
|
+
* @param request SetPasswordPolicyRequest
|
|
6133
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6134
|
+
* @return SetPasswordPolicyResponse
|
|
6135
|
+
*/
|
|
5596
6136
|
setPasswordPolicyWithOptions(request: SetPasswordPolicyRequest, runtime: $Util.RuntimeOptions): Promise<SetPasswordPolicyResponse>;
|
|
6137
|
+
/**
|
|
6138
|
+
* @summary Configures a password policy for CloudSSO users.
|
|
6139
|
+
*
|
|
6140
|
+
* @param request SetPasswordPolicyRequest
|
|
6141
|
+
* @return SetPasswordPolicyResponse
|
|
6142
|
+
*/
|
|
5597
6143
|
setPasswordPolicy(request: SetPasswordPolicyRequest): Promise<SetPasswordPolicyResponse>;
|
|
5598
6144
|
/**
|
|
5599
|
-
|
|
5600
|
-
|
|
5601
|
-
|
|
5602
|
-
|
|
5603
|
-
|
|
5604
|
-
|
|
5605
|
-
|
|
5606
|
-
|
|
6145
|
+
* @summary Enables or disables Cross-domain Identity Management (SCIM) synchronization.
|
|
6146
|
+
*
|
|
6147
|
+
* @description 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:
|
|
6148
|
+
* * 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.
|
|
6149
|
+
* * 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.
|
|
6150
|
+
* This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
|
|
6151
|
+
*
|
|
6152
|
+
* @param request SetSCIMSynchronizationStatusRequest
|
|
6153
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6154
|
+
* @return SetSCIMSynchronizationStatusResponse
|
|
5607
6155
|
*/
|
|
5608
6156
|
setSCIMSynchronizationStatusWithOptions(request: SetSCIMSynchronizationStatusRequest, runtime: $Util.RuntimeOptions): Promise<SetSCIMSynchronizationStatusResponse>;
|
|
5609
6157
|
/**
|
|
5610
|
-
|
|
5611
|
-
|
|
5612
|
-
|
|
5613
|
-
|
|
5614
|
-
|
|
5615
|
-
|
|
5616
|
-
|
|
6158
|
+
* @summary Enables or disables Cross-domain Identity Management (SCIM) synchronization.
|
|
6159
|
+
*
|
|
6160
|
+
* @description 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:
|
|
6161
|
+
* * 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.
|
|
6162
|
+
* * 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.
|
|
6163
|
+
* This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
|
|
6164
|
+
*
|
|
6165
|
+
* @param request SetSCIMSynchronizationStatusRequest
|
|
6166
|
+
* @return SetSCIMSynchronizationStatusResponse
|
|
5617
6167
|
*/
|
|
5618
6168
|
setSCIMSynchronizationStatus(request: SetSCIMSynchronizationStatusRequest): Promise<SetSCIMSynchronizationStatusResponse>;
|
|
5619
6169
|
/**
|
|
5620
|
-
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
6170
|
+
* @summary Modifies information about an access configuration.
|
|
6171
|
+
*
|
|
6172
|
+
* @description You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
|
|
6173
|
+
* 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`.
|
|
6174
|
+
*
|
|
6175
|
+
* @param request UpdateAccessConfigurationRequest
|
|
6176
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6177
|
+
* @return UpdateAccessConfigurationResponse
|
|
5626
6178
|
*/
|
|
5627
6179
|
updateAccessConfigurationWithOptions(request: UpdateAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateAccessConfigurationResponse>;
|
|
5628
6180
|
/**
|
|
5629
|
-
|
|
5630
|
-
|
|
5631
|
-
|
|
5632
|
-
|
|
5633
|
-
|
|
6181
|
+
* @summary Modifies information about an access configuration.
|
|
6182
|
+
*
|
|
6183
|
+
* @description You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
|
|
6184
|
+
* 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`.
|
|
6185
|
+
*
|
|
6186
|
+
* @param request UpdateAccessConfigurationRequest
|
|
6187
|
+
* @return UpdateAccessConfigurationResponse
|
|
5634
6188
|
*/
|
|
5635
6189
|
updateAccessConfiguration(request: UpdateAccessConfigurationRequest): Promise<UpdateAccessConfigurationResponse>;
|
|
5636
6190
|
/**
|
|
5637
|
-
|
|
5638
|
-
|
|
5639
|
-
|
|
5640
|
-
|
|
5641
|
-
|
|
5642
|
-
|
|
6191
|
+
* @summary Changes the name of a directory.
|
|
6192
|
+
*
|
|
6193
|
+
* @description 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.
|
|
6194
|
+
* This topic provides an example on how to change the name of a directory to `new-example`.
|
|
6195
|
+
*
|
|
6196
|
+
* @param request UpdateDirectoryRequest
|
|
6197
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6198
|
+
* @return UpdateDirectoryResponse
|
|
5643
6199
|
*/
|
|
5644
6200
|
updateDirectoryWithOptions(request: UpdateDirectoryRequest, runtime: $Util.RuntimeOptions): Promise<UpdateDirectoryResponse>;
|
|
5645
6201
|
/**
|
|
5646
|
-
|
|
5647
|
-
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
|
|
6202
|
+
* @summary Changes the name of a directory.
|
|
6203
|
+
*
|
|
6204
|
+
* @description 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.
|
|
6205
|
+
* This topic provides an example on how to change the name of a directory to `new-example`.
|
|
6206
|
+
*
|
|
6207
|
+
* @param request UpdateDirectoryRequest
|
|
6208
|
+
* @return UpdateDirectoryResponse
|
|
5651
6209
|
*/
|
|
5652
6210
|
updateDirectory(request: UpdateDirectoryRequest): Promise<UpdateDirectoryResponse>;
|
|
5653
6211
|
/**
|
|
5654
|
-
|
|
5655
|
-
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5660
|
-
|
|
6212
|
+
* @summary Modifies information about a group.
|
|
6213
|
+
*
|
|
6214
|
+
* @description You can modify `GroupName` and `Description` for a group.
|
|
6215
|
+
* > 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.
|
|
6216
|
+
* This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
|
|
6217
|
+
*
|
|
6218
|
+
* @param request UpdateGroupRequest
|
|
6219
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6220
|
+
* @return UpdateGroupResponse
|
|
5661
6221
|
*/
|
|
5662
6222
|
updateGroupWithOptions(request: UpdateGroupRequest, runtime: $Util.RuntimeOptions): Promise<UpdateGroupResponse>;
|
|
5663
6223
|
/**
|
|
5664
|
-
|
|
5665
|
-
|
|
5666
|
-
|
|
5667
|
-
|
|
5668
|
-
|
|
5669
|
-
|
|
6224
|
+
* @summary Modifies information about a group.
|
|
6225
|
+
*
|
|
6226
|
+
* @description You can modify `GroupName` and `Description` for a group.
|
|
6227
|
+
* > 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.
|
|
6228
|
+
* This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
|
|
6229
|
+
*
|
|
6230
|
+
* @param request UpdateGroupRequest
|
|
6231
|
+
* @return UpdateGroupResponse
|
|
5670
6232
|
*/
|
|
5671
6233
|
updateGroup(request: UpdateGroupRequest): Promise<UpdateGroupResponse>;
|
|
5672
6234
|
/**
|
|
5673
|
-
|
|
5674
|
-
|
|
5675
|
-
|
|
5676
|
-
|
|
5677
|
-
|
|
6235
|
+
* @summary Modifies an inline policy that is created for an access configuration.
|
|
6236
|
+
*
|
|
6237
|
+
* @description This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
|
|
6238
|
+
*
|
|
6239
|
+
* @param request UpdateInlinePolicyForAccessConfigurationRequest
|
|
6240
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6241
|
+
* @return UpdateInlinePolicyForAccessConfigurationResponse
|
|
5678
6242
|
*/
|
|
5679
6243
|
updateInlinePolicyForAccessConfigurationWithOptions(request: UpdateInlinePolicyForAccessConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateInlinePolicyForAccessConfigurationResponse>;
|
|
5680
6244
|
/**
|
|
5681
|
-
|
|
5682
|
-
|
|
5683
|
-
|
|
5684
|
-
|
|
6245
|
+
* @summary Modifies an inline policy that is created for an access configuration.
|
|
6246
|
+
*
|
|
6247
|
+
* @description This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
|
|
6248
|
+
*
|
|
6249
|
+
* @param request UpdateInlinePolicyForAccessConfigurationRequest
|
|
6250
|
+
* @return UpdateInlinePolicyForAccessConfigurationResponse
|
|
5685
6251
|
*/
|
|
5686
6252
|
updateInlinePolicyForAccessConfiguration(request: UpdateInlinePolicyForAccessConfigurationRequest): Promise<UpdateInlinePolicyForAccessConfigurationResponse>;
|
|
5687
6253
|
/**
|
|
5688
|
-
|
|
5689
|
-
|
|
5690
|
-
|
|
5691
|
-
|
|
5692
|
-
|
|
5693
|
-
|
|
6254
|
+
* @summary Modifies the multi-factor authentication (MFA) setting of all users.
|
|
6255
|
+
*
|
|
6256
|
+
* @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
|
|
6257
|
+
* This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
|
|
6258
|
+
*
|
|
6259
|
+
* @param request UpdateMFAAuthenticationSettingsRequest
|
|
6260
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6261
|
+
* @return UpdateMFAAuthenticationSettingsResponse
|
|
5694
6262
|
*/
|
|
5695
6263
|
updateMFAAuthenticationSettingsWithOptions(request: UpdateMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateMFAAuthenticationSettingsResponse>;
|
|
5696
6264
|
/**
|
|
5697
|
-
|
|
5698
|
-
|
|
5699
|
-
|
|
5700
|
-
|
|
5701
|
-
|
|
6265
|
+
* @summary Modifies the multi-factor authentication (MFA) setting of all users.
|
|
6266
|
+
*
|
|
6267
|
+
* @description If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
|
|
6268
|
+
* This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
|
|
6269
|
+
*
|
|
6270
|
+
* @param request UpdateMFAAuthenticationSettingsRequest
|
|
6271
|
+
* @return UpdateMFAAuthenticationSettingsResponse
|
|
5702
6272
|
*/
|
|
5703
6273
|
updateMFAAuthenticationSettings(request: UpdateMFAAuthenticationSettingsRequest): Promise<UpdateMFAAuthenticationSettingsResponse>;
|
|
5704
6274
|
/**
|
|
5705
|
-
|
|
5706
|
-
|
|
5707
|
-
|
|
5708
|
-
|
|
5709
|
-
|
|
6275
|
+
* @summary Enables or disables a Cross-domain Identity Management (SCIM) credential.
|
|
6276
|
+
*
|
|
6277
|
+
* @description 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.
|
|
6278
|
+
*
|
|
6279
|
+
* @param request UpdateSCIMServerCredentialStatusRequest
|
|
6280
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6281
|
+
* @return UpdateSCIMServerCredentialStatusResponse
|
|
5710
6282
|
*/
|
|
5711
6283
|
updateSCIMServerCredentialStatusWithOptions(request: UpdateSCIMServerCredentialStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateSCIMServerCredentialStatusResponse>;
|
|
5712
6284
|
/**
|
|
5713
|
-
|
|
5714
|
-
|
|
5715
|
-
|
|
5716
|
-
|
|
6285
|
+
* @summary Enables or disables a Cross-domain Identity Management (SCIM) credential.
|
|
6286
|
+
*
|
|
6287
|
+
* @description 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.
|
|
6288
|
+
*
|
|
6289
|
+
* @param request UpdateSCIMServerCredentialStatusRequest
|
|
6290
|
+
* @return UpdateSCIMServerCredentialStatusResponse
|
|
5717
6291
|
*/
|
|
5718
6292
|
updateSCIMServerCredentialStatus(request: UpdateSCIMServerCredentialStatusRequest): Promise<UpdateSCIMServerCredentialStatusResponse>;
|
|
5719
6293
|
/**
|
|
5720
|
-
|
|
5721
|
-
|
|
5722
|
-
|
|
5723
|
-
|
|
5724
|
-
|
|
5725
|
-
|
|
5726
|
-
|
|
6294
|
+
* @summary Modifies information about a user.
|
|
6295
|
+
*
|
|
6296
|
+
* @description You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
|
|
6297
|
+
* > 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.
|
|
6298
|
+
* This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
|
|
6299
|
+
*
|
|
6300
|
+
* @param request UpdateUserRequest
|
|
6301
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6302
|
+
* @return UpdateUserResponse
|
|
5727
6303
|
*/
|
|
5728
6304
|
updateUserWithOptions(request: UpdateUserRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserResponse>;
|
|
5729
6305
|
/**
|
|
5730
|
-
|
|
5731
|
-
|
|
5732
|
-
|
|
5733
|
-
|
|
5734
|
-
|
|
5735
|
-
|
|
6306
|
+
* @summary Modifies information about a user.
|
|
6307
|
+
*
|
|
6308
|
+
* @description You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
|
|
6309
|
+
* > 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.
|
|
6310
|
+
* This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
|
|
6311
|
+
*
|
|
6312
|
+
* @param request UpdateUserRequest
|
|
6313
|
+
* @return UpdateUserResponse
|
|
5736
6314
|
*/
|
|
5737
6315
|
updateUser(request: UpdateUserRequest): Promise<UpdateUserResponse>;
|
|
5738
6316
|
/**
|
|
5739
|
-
|
|
5740
|
-
|
|
5741
|
-
|
|
5742
|
-
|
|
5743
|
-
|
|
5744
|
-
|
|
5745
|
-
|
|
6317
|
+
* @summary Modifies the multi-factor authentication (MFA) setting of a single user.
|
|
6318
|
+
*
|
|
6319
|
+
* @description If you call the [UpdateMFAAuthenticationSettings](https://help.aliyun.com/document_detail/450134.html) 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.
|
|
6320
|
+
* By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
|
|
6321
|
+
* This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
|
|
6322
|
+
*
|
|
6323
|
+
* @param request UpdateUserMFAAuthenticationSettingsRequest
|
|
6324
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6325
|
+
* @return UpdateUserMFAAuthenticationSettingsResponse
|
|
5746
6326
|
*/
|
|
5747
6327
|
updateUserMFAAuthenticationSettingsWithOptions(request: UpdateUserMFAAuthenticationSettingsRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserMFAAuthenticationSettingsResponse>;
|
|
5748
6328
|
/**
|
|
5749
|
-
|
|
5750
|
-
|
|
5751
|
-
|
|
5752
|
-
|
|
5753
|
-
|
|
5754
|
-
|
|
6329
|
+
* @summary Modifies the multi-factor authentication (MFA) setting of a single user.
|
|
6330
|
+
*
|
|
6331
|
+
* @description If you call the [UpdateMFAAuthenticationSettings](https://help.aliyun.com/document_detail/450134.html) 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.
|
|
6332
|
+
* By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
|
|
6333
|
+
* This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
|
|
6334
|
+
*
|
|
6335
|
+
* @param request UpdateUserMFAAuthenticationSettingsRequest
|
|
6336
|
+
* @return UpdateUserMFAAuthenticationSettingsResponse
|
|
5755
6337
|
*/
|
|
5756
6338
|
updateUserMFAAuthenticationSettings(request: UpdateUserMFAAuthenticationSettingsRequest): Promise<UpdateUserMFAAuthenticationSettingsResponse>;
|
|
6339
|
+
/**
|
|
6340
|
+
* @summary Modifies a Resource Access Management (RAM) user provisioning.
|
|
6341
|
+
*
|
|
6342
|
+
* @param request UpdateUserProvisioningRequest
|
|
6343
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6344
|
+
* @return UpdateUserProvisioningResponse
|
|
6345
|
+
*/
|
|
5757
6346
|
updateUserProvisioningWithOptions(request: UpdateUserProvisioningRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserProvisioningResponse>;
|
|
6347
|
+
/**
|
|
6348
|
+
* @summary Modifies a Resource Access Management (RAM) user provisioning.
|
|
6349
|
+
*
|
|
6350
|
+
* @param request UpdateUserProvisioningRequest
|
|
6351
|
+
* @return UpdateUserProvisioningResponse
|
|
6352
|
+
*/
|
|
5758
6353
|
updateUserProvisioning(request: UpdateUserProvisioningRequest): Promise<UpdateUserProvisioningResponse>;
|
|
6354
|
+
/**
|
|
6355
|
+
* @summary Modifies the global configurations of a Resource Access Management (RAM) user provisioning.
|
|
6356
|
+
*
|
|
6357
|
+
* @param request UpdateUserProvisioningConfigurationRequest
|
|
6358
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6359
|
+
* @return UpdateUserProvisioningConfigurationResponse
|
|
6360
|
+
*/
|
|
5759
6361
|
updateUserProvisioningConfigurationWithOptions(request: UpdateUserProvisioningConfigurationRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserProvisioningConfigurationResponse>;
|
|
6362
|
+
/**
|
|
6363
|
+
* @summary Modifies the global configurations of a Resource Access Management (RAM) user provisioning.
|
|
6364
|
+
*
|
|
6365
|
+
* @param request UpdateUserProvisioningConfigurationRequest
|
|
6366
|
+
* @return UpdateUserProvisioningConfigurationResponse
|
|
6367
|
+
*/
|
|
5760
6368
|
updateUserProvisioningConfiguration(request: UpdateUserProvisioningConfigurationRequest): Promise<UpdateUserProvisioningConfigurationResponse>;
|
|
5761
6369
|
/**
|
|
5762
|
-
|
|
5763
|
-
|
|
5764
|
-
|
|
5765
|
-
|
|
5766
|
-
|
|
6370
|
+
* @summary Changes the status of a user.
|
|
6371
|
+
*
|
|
6372
|
+
* @description 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.
|
|
6373
|
+
*
|
|
6374
|
+
* @param request UpdateUserStatusRequest
|
|
6375
|
+
* @param runtime runtime options for this request RuntimeOptions
|
|
6376
|
+
* @return UpdateUserStatusResponse
|
|
5767
6377
|
*/
|
|
5768
6378
|
updateUserStatusWithOptions(request: UpdateUserStatusRequest, runtime: $Util.RuntimeOptions): Promise<UpdateUserStatusResponse>;
|
|
5769
6379
|
/**
|
|
5770
|
-
|
|
5771
|
-
|
|
5772
|
-
|
|
5773
|
-
|
|
6380
|
+
* @summary Changes the status of a user.
|
|
6381
|
+
*
|
|
6382
|
+
* @description 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.
|
|
6383
|
+
*
|
|
6384
|
+
* @param request UpdateUserStatusRequest
|
|
6385
|
+
* @return UpdateUserStatusResponse
|
|
5774
6386
|
*/
|
|
5775
6387
|
updateUserStatus(request: UpdateUserStatusRequest): Promise<UpdateUserStatusResponse>;
|
|
5776
6388
|
}
|