@alicloud/cloudsso20210515 1.6.0 → 1.7.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 +221 -178
- package/dist/client.js +326 -178
- package/dist/client.js.map +1 -1
- package/dist/models/AddExternalSamlidPcertificateRequest.d.ts +3 -3
- package/dist/models/AddPermissionPolicyToAccessConfigurationRequest.d.ts +11 -14
- package/dist/models/AddPermissionPolicyToAccessConfigurationRequest.js.map +1 -1
- package/dist/models/AddUserToGroupResponseBody.d.ts +1 -1
- package/dist/models/ClearExternalSamlidentityProviderRequest.d.ts +1 -1
- package/dist/models/CreateAccessAssignmentRequest.d.ts +13 -14
- package/dist/models/CreateAccessAssignmentRequest.js.map +1 -1
- package/dist/models/CreateAccessAssignmentResponseBody.d.ts +20 -22
- package/dist/models/CreateAccessAssignmentResponseBody.js.map +1 -1
- package/dist/models/CreateDirectoryRequest.d.ts +3 -3
- package/dist/models/CreateDirectoryResponseBody.d.ts +3 -3
- package/dist/models/CreateGroupRequest.d.ts +6 -6
- package/dist/models/CreateGroupResponseBody.d.ts +8 -7
- package/dist/models/CreateGroupResponseBody.js.map +1 -1
- package/dist/models/CreateScimserverCredentialRequest.d.ts +1 -1
- package/dist/models/CreateScimserverCredentialResponseBody.d.ts +8 -7
- package/dist/models/CreateScimserverCredentialResponseBody.js.map +1 -1
- package/dist/models/CreateUserProvisioningRequest.d.ts +15 -20
- package/dist/models/CreateUserProvisioningRequest.js.map +1 -1
- package/dist/models/CreateUserProvisioningResponseBody.d.ts +27 -35
- package/dist/models/CreateUserProvisioningResponseBody.js.map +1 -1
- package/dist/models/DeleteAccessAssignmentRequest.d.ts +17 -16
- package/dist/models/DeleteAccessAssignmentRequest.js.map +1 -1
- package/dist/models/DeleteAccessAssignmentResponseBody.d.ts +19 -17
- package/dist/models/DeleteAccessAssignmentResponseBody.js.map +1 -1
- package/dist/models/DeleteAccessConfigurationRequest.d.ts +2 -3
- package/dist/models/DeleteAccessConfigurationRequest.js.map +1 -1
- package/dist/models/DeleteAccessConfigurationResponseBody.d.ts +1 -1
- package/dist/models/DeleteDirectoryRequest.d.ts +1 -1
- package/dist/models/DeleteGroupRequest.d.ts +1 -1
- package/dist/models/DeleteScimserverCredentialRequest.d.ts +1 -1
- package/dist/models/DeleteUserProvisioningEventRequest.d.ts +4 -4
- package/dist/models/DeleteUserProvisioningRequest.d.ts +6 -7
- package/dist/models/DeleteUserProvisioningRequest.js.map +1 -1
- package/dist/models/DeleteUserRequest.d.ts +2 -2
- package/dist/models/DeprovisionAccessConfigurationRequest.d.ts +6 -2
- package/dist/models/DeprovisionAccessConfigurationRequest.js.map +1 -1
- package/dist/models/DeprovisionAccessConfigurationResponseBody.d.ts +13 -10
- package/dist/models/DeprovisionAccessConfigurationResponseBody.js.map +1 -1
- package/dist/models/EnableDelegateAccountRequest.d.ts +1 -1
- package/dist/models/GetDirectoryRequest.d.ts +1 -1
- package/dist/models/GetDirectoryResponseBody.d.ts +5 -5
- package/dist/models/GetTaskResponseBody.d.ts +22 -19
- package/dist/models/GetTaskResponseBody.js.map +1 -1
- package/dist/models/ListAccessAssignmentsRequest.d.ts +22 -20
- package/dist/models/ListAccessAssignmentsRequest.js.map +1 -1
- package/dist/models/ListAccessAssignmentsResponseBody.d.ts +22 -20
- package/dist/models/ListAccessAssignmentsResponseBody.js.map +1 -1
- package/dist/models/ListAccessConfigurationProvisioningsRequest.d.ts +18 -16
- package/dist/models/ListAccessConfigurationProvisioningsRequest.js.map +1 -1
- package/dist/models/ListAccessConfigurationProvisioningsResponseBody.d.ts +29 -28
- package/dist/models/ListAccessConfigurationProvisioningsResponseBody.js.map +1 -1
- package/dist/models/ListTagResourcesRequest.d.ts +87 -0
- package/dist/models/ListTagResourcesRequest.js +93 -0
- package/dist/models/ListTagResourcesRequest.js.map +1 -0
- package/dist/models/ListTagResourcesResponse.d.ts +19 -0
- package/dist/models/ListTagResourcesResponse.js +69 -0
- package/dist/models/ListTagResourcesResponse.js.map +1 -0
- package/dist/models/ListTagResourcesResponseBody.d.ts +80 -0
- package/dist/models/ListTagResourcesResponseBody.js +90 -0
- package/dist/models/ListTagResourcesResponseBody.js.map +1 -0
- package/dist/models/ListTasksRequest.d.ts +27 -34
- package/dist/models/ListTasksRequest.js.map +1 -1
- package/dist/models/ListTasksResponseBody.d.ts +34 -36
- package/dist/models/ListTasksResponseBody.js.map +1 -1
- package/dist/models/ProvisionAccessConfigurationRequest.d.ts +7 -3
- package/dist/models/ProvisionAccessConfigurationRequest.js.map +1 -1
- package/dist/models/ProvisionAccessConfigurationResponseBody.d.ts +15 -12
- package/dist/models/ProvisionAccessConfigurationResponseBody.js.map +1 -1
- package/dist/models/ResetUserPasswordRequest.d.ts +11 -13
- package/dist/models/ResetUserPasswordRequest.js.map +1 -1
- package/dist/models/ResetUserPasswordResponseBody.d.ts +1 -1
- package/dist/models/TagResourcesRequest.d.ts +95 -0
- package/dist/models/TagResourcesRequest.js +91 -0
- package/dist/models/TagResourcesRequest.js.map +1 -0
- package/dist/models/TagResourcesResponse.d.ts +19 -0
- package/dist/models/TagResourcesResponse.js +69 -0
- package/dist/models/TagResourcesResponse.js.map +1 -0
- package/dist/models/TagResourcesResponseBody.d.ts +21 -0
- package/dist/models/TagResourcesResponseBody.js +58 -0
- package/dist/models/TagResourcesResponseBody.js.map +1 -0
- package/dist/models/UntagResourcesRequest.d.ts +59 -0
- package/dist/models/UntagResourcesRequest.js +72 -0
- package/dist/models/UntagResourcesRequest.js.map +1 -0
- package/dist/models/UntagResourcesResponse.d.ts +19 -0
- package/dist/models/UntagResourcesResponse.js +69 -0
- package/dist/models/UntagResourcesResponse.js.map +1 -0
- package/dist/models/UntagResourcesResponseBody.d.ts +21 -0
- package/dist/models/UntagResourcesResponseBody.js +58 -0
- package/dist/models/UntagResourcesResponseBody.js.map +1 -0
- package/dist/models/UpdateScimserverCredentialStatusRequest.d.ts +4 -5
- package/dist/models/UpdateScimserverCredentialStatusRequest.js.map +1 -1
- package/dist/models/UpdateScimserverCredentialStatusResponseBody.d.ts +6 -7
- package/dist/models/UpdateScimserverCredentialStatusResponseBody.js.map +1 -1
- package/dist/models/model.d.ts +12 -0
- package/dist/models/model.js +31 -7
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +346 -178
- package/src/models/AddExternalSamlidPcertificateRequest.ts +3 -3
- package/src/models/AddPermissionPolicyToAccessConfigurationRequest.ts +11 -14
- package/src/models/AddUserToGroupResponseBody.ts +1 -1
- package/src/models/ClearExternalSamlidentityProviderRequest.ts +1 -1
- package/src/models/CreateAccessAssignmentRequest.ts +13 -14
- package/src/models/CreateAccessAssignmentResponseBody.ts +20 -22
- package/src/models/CreateDirectoryRequest.ts +3 -3
- package/src/models/CreateDirectoryResponseBody.ts +3 -3
- package/src/models/CreateGroupRequest.ts +6 -6
- package/src/models/CreateGroupResponseBody.ts +8 -7
- package/src/models/CreateScimserverCredentialRequest.ts +1 -1
- package/src/models/CreateScimserverCredentialResponseBody.ts +8 -7
- package/src/models/CreateUserProvisioningRequest.ts +15 -20
- package/src/models/CreateUserProvisioningResponseBody.ts +27 -35
- package/src/models/DeleteAccessAssignmentRequest.ts +17 -16
- package/src/models/DeleteAccessAssignmentResponseBody.ts +19 -17
- package/src/models/DeleteAccessConfigurationRequest.ts +2 -3
- package/src/models/DeleteAccessConfigurationResponseBody.ts +1 -1
- package/src/models/DeleteDirectoryRequest.ts +1 -1
- package/src/models/DeleteGroupRequest.ts +1 -1
- package/src/models/DeleteScimserverCredentialRequest.ts +1 -1
- package/src/models/DeleteUserProvisioningEventRequest.ts +4 -4
- package/src/models/DeleteUserProvisioningRequest.ts +6 -7
- package/src/models/DeleteUserRequest.ts +2 -2
- package/src/models/DeprovisionAccessConfigurationRequest.ts +6 -2
- package/src/models/DeprovisionAccessConfigurationResponseBody.ts +13 -10
- package/src/models/EnableDelegateAccountRequest.ts +1 -1
- package/src/models/GetDirectoryRequest.ts +1 -1
- package/src/models/GetDirectoryResponseBody.ts +5 -5
- package/src/models/GetTaskResponseBody.ts +22 -19
- package/src/models/ListAccessAssignmentsRequest.ts +22 -20
- package/src/models/ListAccessAssignmentsResponseBody.ts +22 -20
- package/src/models/ListAccessConfigurationProvisioningsRequest.ts +18 -16
- package/src/models/ListAccessConfigurationProvisioningsResponseBody.ts +29 -28
- package/src/models/ListTagResourcesRequest.ts +126 -0
- package/src/models/ListTagResourcesResponse.ts +40 -0
- package/src/models/ListTagResourcesResponseBody.ts +116 -0
- package/src/models/ListTasksRequest.ts +27 -34
- package/src/models/ListTasksResponseBody.ts +34 -36
- package/src/models/ProvisionAccessConfigurationRequest.ts +7 -3
- package/src/models/ProvisionAccessConfigurationResponseBody.ts +15 -12
- package/src/models/ResetUserPasswordRequest.ts +11 -13
- package/src/models/ResetUserPasswordResponseBody.ts +1 -1
- package/src/models/TagResourcesRequest.ts +132 -0
- package/src/models/TagResourcesResponse.ts +40 -0
- package/src/models/TagResourcesResponseBody.ts +34 -0
- package/src/models/UntagResourcesRequest.ts +86 -0
- package/src/models/UntagResourcesResponse.ts +40 -0
- package/src/models/UntagResourcesResponseBody.ts +34 -0
- package/src/models/UpdateScimserverCredentialStatusRequest.ts +4 -5
- package/src/models/UpdateScimserverCredentialStatusResponseBody.ts +6 -7
- package/src/models/model.ts +12 -0
package/dist/client.d.ts
CHANGED
|
@@ -9,11 +9,11 @@ export default class Client extends OpenApi {
|
|
|
9
9
|
[key: string]: string;
|
|
10
10
|
}, endpoint: string): string;
|
|
11
11
|
/**
|
|
12
|
-
* Adds a
|
|
12
|
+
* Adds a SAML signing certificate.
|
|
13
13
|
*
|
|
14
14
|
* @remarks
|
|
15
15
|
* You can add up to two SAML signing certificates.
|
|
16
|
-
* This topic provides an example
|
|
16
|
+
* This topic provides an example of adding a new SAML signing certificate to the `d-00fc2p61****` directory.
|
|
17
17
|
*
|
|
18
18
|
* @param request - AddExternalSAMLIdPCertificateRequest
|
|
19
19
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -21,21 +21,21 @@ export default class Client extends OpenApi {
|
|
|
21
21
|
*/
|
|
22
22
|
addExternalSAMLIdPCertificateWithOptions(request: $_model.AddExternalSAMLIdPCertificateRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AddExternalSAMLIdPCertificateResponse>;
|
|
23
23
|
/**
|
|
24
|
-
* Adds a
|
|
24
|
+
* Adds a SAML signing certificate.
|
|
25
25
|
*
|
|
26
26
|
* @remarks
|
|
27
27
|
* You can add up to two SAML signing certificates.
|
|
28
|
-
* This topic provides an example
|
|
28
|
+
* This topic provides an example of adding a new SAML signing certificate to the `d-00fc2p61****` directory.
|
|
29
29
|
*
|
|
30
30
|
* @param request - AddExternalSAMLIdPCertificateRequest
|
|
31
31
|
* @returns AddExternalSAMLIdPCertificateResponse
|
|
32
32
|
*/
|
|
33
33
|
addExternalSAMLIdPCertificate(request: $_model.AddExternalSAMLIdPCertificateRequest): Promise<$_model.AddExternalSAMLIdPCertificateResponse>;
|
|
34
34
|
/**
|
|
35
|
-
* Adds
|
|
35
|
+
* Adds an access policy to an access configuration.
|
|
36
36
|
*
|
|
37
37
|
* @remarks
|
|
38
|
-
* This topic provides an example
|
|
38
|
+
* This topic provides an example of adding a system policy named `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
|
|
39
39
|
*
|
|
40
40
|
* @param request - AddPermissionPolicyToAccessConfigurationRequest
|
|
41
41
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -43,10 +43,10 @@ export default class Client extends OpenApi {
|
|
|
43
43
|
*/
|
|
44
44
|
addPermissionPolicyToAccessConfigurationWithOptions(request: $_model.AddPermissionPolicyToAccessConfigurationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AddPermissionPolicyToAccessConfigurationResponse>;
|
|
45
45
|
/**
|
|
46
|
-
* Adds
|
|
46
|
+
* Adds an access policy to an access configuration.
|
|
47
47
|
*
|
|
48
48
|
* @remarks
|
|
49
|
-
* This topic provides an example
|
|
49
|
+
* This topic provides an example of adding a system policy named `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
|
|
50
50
|
*
|
|
51
51
|
* @param request - AddPermissionPolicyToAccessConfigurationRequest
|
|
52
52
|
* @returns AddPermissionPolicyToAccessConfigurationResponse
|
|
@@ -56,8 +56,8 @@ export default class Client extends OpenApi {
|
|
|
56
56
|
* Adds a user to a group.
|
|
57
57
|
*
|
|
58
58
|
* @remarks
|
|
59
|
-
*
|
|
60
|
-
* This topic provides an example
|
|
59
|
+
* After SCIM synchronization is enabled, you cannot add users to SCIM-synchronized groups.
|
|
60
|
+
* This topic provides an example of adding the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
|
|
61
61
|
*
|
|
62
62
|
* @param request - AddUserToGroupRequest
|
|
63
63
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -68,19 +68,19 @@ export default class Client extends OpenApi {
|
|
|
68
68
|
* Adds a user to a group.
|
|
69
69
|
*
|
|
70
70
|
* @remarks
|
|
71
|
-
*
|
|
72
|
-
* This topic provides an example
|
|
71
|
+
* After SCIM synchronization is enabled, you cannot add users to SCIM-synchronized groups.
|
|
72
|
+
* This topic provides an example of adding the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
|
|
73
73
|
*
|
|
74
74
|
* @param request - AddUserToGroupRequest
|
|
75
75
|
* @returns AddUserToGroupResponse
|
|
76
76
|
*/
|
|
77
77
|
addUserToGroup(request: $_model.AddUserToGroupRequest): Promise<$_model.AddUserToGroupResponse>;
|
|
78
78
|
/**
|
|
79
|
-
* Clears the
|
|
79
|
+
* Clears the configuration of the SAML IdP.
|
|
80
80
|
*
|
|
81
81
|
* @remarks
|
|
82
|
-
*
|
|
83
|
-
* This topic provides an example
|
|
82
|
+
* You can clear the SAML IdP information only when SSO logon is disabled. Otherwise, you cannot perform this operation.
|
|
83
|
+
* This topic provides an example of clearing the configuration of the SAML IdP for the `d-00fc2p61****` directory.
|
|
84
84
|
*
|
|
85
85
|
* @param request - ClearExternalSAMLIdentityProviderRequest
|
|
86
86
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -88,23 +88,23 @@ export default class Client extends OpenApi {
|
|
|
88
88
|
*/
|
|
89
89
|
clearExternalSAMLIdentityProviderWithOptions(request: $_model.ClearExternalSAMLIdentityProviderRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ClearExternalSAMLIdentityProviderResponse>;
|
|
90
90
|
/**
|
|
91
|
-
* Clears the
|
|
91
|
+
* Clears the configuration of the SAML IdP.
|
|
92
92
|
*
|
|
93
93
|
* @remarks
|
|
94
|
-
*
|
|
95
|
-
* This topic provides an example
|
|
94
|
+
* You can clear the SAML IdP information only when SSO logon is disabled. Otherwise, you cannot perform this operation.
|
|
95
|
+
* This topic provides an example of clearing the configuration of the SAML IdP for the `d-00fc2p61****` directory.
|
|
96
96
|
*
|
|
97
97
|
* @param request - ClearExternalSAMLIdentityProviderRequest
|
|
98
98
|
* @returns ClearExternalSAMLIdentityProviderResponse
|
|
99
99
|
*/
|
|
100
100
|
clearExternalSAMLIdentityProvider(request: $_model.ClearExternalSAMLIdentityProviderRequest): Promise<$_model.ClearExternalSAMLIdentityProviderResponse>;
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
102
|
+
* Configures the settings for the users or groups allowed to access an account in a resource directory, and the corresponding access permissions (access configurations).
|
|
103
103
|
*
|
|
104
104
|
* @remarks
|
|
105
|
-
*
|
|
106
|
-
* For more information about
|
|
107
|
-
* This topic provides an example on how to assign access
|
|
105
|
+
* This API operation is asynchronous. You can use the TaskId returned in the response to call [GetTask](https://help.aliyun.com/document_detail/340670.html) to query the task execution status.
|
|
106
|
+
* For more information about granting access to an account in a resource directory, see [Multi-account authorization overview](https://help.aliyun.com/document_detail/266726.html).
|
|
107
|
+
* This topic provides an example on how to assign the access configuration `ac-00jhtfl8thteu6uj****` to the CloudSSO user `u-00q8wbq42wiltcrk****` for the account `114240524784****` in a resource directory. This allows the CloudSSO user to access authorized resources in the account.
|
|
108
108
|
*
|
|
109
109
|
* @param request - CreateAccessAssignmentRequest
|
|
110
110
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -112,12 +112,12 @@ export default class Client extends OpenApi {
|
|
|
112
112
|
*/
|
|
113
113
|
createAccessAssignmentWithOptions(request: $_model.CreateAccessAssignmentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAccessAssignmentResponse>;
|
|
114
114
|
/**
|
|
115
|
-
*
|
|
115
|
+
* Configures the settings for the users or groups allowed to access an account in a resource directory, and the corresponding access permissions (access configurations).
|
|
116
116
|
*
|
|
117
117
|
* @remarks
|
|
118
|
-
*
|
|
119
|
-
* For more information about
|
|
120
|
-
* This topic provides an example on how to assign access
|
|
118
|
+
* This API operation is asynchronous. You can use the TaskId returned in the response to call [GetTask](https://help.aliyun.com/document_detail/340670.html) to query the task execution status.
|
|
119
|
+
* For more information about granting access to an account in a resource directory, see [Multi-account authorization overview](https://help.aliyun.com/document_detail/266726.html).
|
|
120
|
+
* This topic provides an example on how to assign the access configuration `ac-00jhtfl8thteu6uj****` to the CloudSSO user `u-00q8wbq42wiltcrk****` for the account `114240524784****` in a resource directory. This allows the CloudSSO user to access authorized resources in the account.
|
|
121
121
|
*
|
|
122
122
|
* @param request - CreateAccessAssignmentRequest
|
|
123
123
|
* @returns CreateAccessAssignmentResponse
|
|
@@ -150,13 +150,13 @@ export default class Client extends OpenApi {
|
|
|
150
150
|
* Creates a directory.
|
|
151
151
|
*
|
|
152
152
|
* @remarks
|
|
153
|
-
* ###
|
|
154
|
-
* A directory is
|
|
155
|
-
*
|
|
153
|
+
* ### Usage notes
|
|
154
|
+
* A directory is an instance in CloudSSO. You must create a directory before you use CloudSSO. All CloudSSO resources must be maintained in the directory.
|
|
155
|
+
* You must select a region for the CloudSSO directory. Alibaba Cloud ensures that all CloudSSO-related data is stored only in this region. This is independent of where you deploy cloud resources such as ECS and ApsaraDB RDS. You can log on to and access cloud resources in any region from anywhere in the world. You can select a region based on your security and compliance requirements and the geographic location of your target users. If you do not have special security and compliance requirements, select the region closest to your target users to improve access speed. Currently, you can create directories in the following four regions: China (Shanghai), China (Hong Kong), US (Silicon Valley), and Germany (Frankfurt).
|
|
156
156
|
* This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
|
|
157
|
-
* ###
|
|
158
|
-
*
|
|
159
|
-
*
|
|
157
|
+
* ### Limits
|
|
158
|
+
* - A management account can create only one directory.
|
|
159
|
+
* - To change the region of the directory, you must delete the existing directory and create a new one in another region.
|
|
160
160
|
*
|
|
161
161
|
* @param request - CreateDirectoryRequest
|
|
162
162
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -167,23 +167,23 @@ export default class Client extends OpenApi {
|
|
|
167
167
|
* Creates a directory.
|
|
168
168
|
*
|
|
169
169
|
* @remarks
|
|
170
|
-
* ###
|
|
171
|
-
* A directory is
|
|
172
|
-
*
|
|
170
|
+
* ### Usage notes
|
|
171
|
+
* A directory is an instance in CloudSSO. You must create a directory before you use CloudSSO. All CloudSSO resources must be maintained in the directory.
|
|
172
|
+
* You must select a region for the CloudSSO directory. Alibaba Cloud ensures that all CloudSSO-related data is stored only in this region. This is independent of where you deploy cloud resources such as ECS and ApsaraDB RDS. You can log on to and access cloud resources in any region from anywhere in the world. You can select a region based on your security and compliance requirements and the geographic location of your target users. If you do not have special security and compliance requirements, select the region closest to your target users to improve access speed. Currently, you can create directories in the following four regions: China (Shanghai), China (Hong Kong), US (Silicon Valley), and Germany (Frankfurt).
|
|
173
173
|
* This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
|
|
174
|
-
* ###
|
|
175
|
-
*
|
|
176
|
-
*
|
|
174
|
+
* ### Limits
|
|
175
|
+
* - A management account can create only one directory.
|
|
176
|
+
* - To change the region of the directory, you must delete the existing directory and create a new one in another region.
|
|
177
177
|
*
|
|
178
178
|
* @param request - CreateDirectoryRequest
|
|
179
179
|
* @returns CreateDirectoryResponse
|
|
180
180
|
*/
|
|
181
181
|
createDirectory(request: $_model.CreateDirectoryRequest): Promise<$_model.CreateDirectoryResponse>;
|
|
182
182
|
/**
|
|
183
|
-
* Creates a group.
|
|
183
|
+
* Creates a user group.
|
|
184
184
|
*
|
|
185
185
|
* @remarks
|
|
186
|
-
* This topic provides an example
|
|
186
|
+
* This topic provides an example of creating a user group named `TestGroup`.
|
|
187
187
|
*
|
|
188
188
|
* @param request - CreateGroupRequest
|
|
189
189
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -191,21 +191,21 @@ export default class Client extends OpenApi {
|
|
|
191
191
|
*/
|
|
192
192
|
createGroupWithOptions(request: $_model.CreateGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateGroupResponse>;
|
|
193
193
|
/**
|
|
194
|
-
* Creates a group.
|
|
194
|
+
* Creates a user group.
|
|
195
195
|
*
|
|
196
196
|
* @remarks
|
|
197
|
-
* This topic provides an example
|
|
197
|
+
* This topic provides an example of creating a user group named `TestGroup`.
|
|
198
198
|
*
|
|
199
199
|
* @param request - CreateGroupRequest
|
|
200
200
|
* @returns CreateGroupResponse
|
|
201
201
|
*/
|
|
202
202
|
createGroup(request: $_model.CreateGroupRequest): Promise<$_model.CreateGroupResponse>;
|
|
203
203
|
/**
|
|
204
|
-
* Creates a
|
|
204
|
+
* Creates a SCIM credential.
|
|
205
205
|
*
|
|
206
206
|
* @remarks
|
|
207
|
-
* SCIM
|
|
208
|
-
* This topic provides an example on how to create a SCIM credential
|
|
207
|
+
* A SCIM credential is required for SCIM synchronization. You can create up to two SCIM credentials.
|
|
208
|
+
* This topic provides an example on how to create a SCIM credential in the directory `d-00fc2p61****`.
|
|
209
209
|
*
|
|
210
210
|
* @param request - CreateSCIMServerCredentialRequest
|
|
211
211
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -213,11 +213,11 @@ export default class Client extends OpenApi {
|
|
|
213
213
|
*/
|
|
214
214
|
createSCIMServerCredentialWithOptions(request: $_model.CreateSCIMServerCredentialRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSCIMServerCredentialResponse>;
|
|
215
215
|
/**
|
|
216
|
-
* Creates a
|
|
216
|
+
* Creates a SCIM credential.
|
|
217
217
|
*
|
|
218
218
|
* @remarks
|
|
219
|
-
* SCIM
|
|
220
|
-
* This topic provides an example on how to create a SCIM credential
|
|
219
|
+
* A SCIM credential is required for SCIM synchronization. You can create up to two SCIM credentials.
|
|
220
|
+
* This topic provides an example on how to create a SCIM credential in the directory `d-00fc2p61****`.
|
|
221
221
|
*
|
|
222
222
|
* @param request - CreateSCIMServerCredentialRequest
|
|
223
223
|
* @returns CreateSCIMServerCredentialResponse
|
|
@@ -239,10 +239,10 @@ export default class Client extends OpenApi {
|
|
|
239
239
|
*/
|
|
240
240
|
createUser(request: $_model.CreateUserRequest): Promise<$_model.CreateUserResponse>;
|
|
241
241
|
/**
|
|
242
|
-
*
|
|
242
|
+
* Invokes CreateUserProvisioning to create a Resource Access Management (RAM) user synchronization.
|
|
243
243
|
*
|
|
244
244
|
* @remarks
|
|
245
|
-
* You can create a
|
|
245
|
+
* You can create a Resource Access Management (RAM) user synchronization to synchronously create a Resource Access Management (RAM) user that has the same name as a CloudSSO user in a destination account in a resource directory. You can then use the Resource Access Management (RAM) user to access resources in the account.
|
|
246
246
|
*
|
|
247
247
|
* @param request - CreateUserProvisioningRequest
|
|
248
248
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -250,21 +250,21 @@ export default class Client extends OpenApi {
|
|
|
250
250
|
*/
|
|
251
251
|
createUserProvisioningWithOptions(request: $_model.CreateUserProvisioningRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateUserProvisioningResponse>;
|
|
252
252
|
/**
|
|
253
|
-
*
|
|
253
|
+
* Invokes CreateUserProvisioning to create a Resource Access Management (RAM) user synchronization.
|
|
254
254
|
*
|
|
255
255
|
* @remarks
|
|
256
|
-
* You can create a
|
|
256
|
+
* You can create a Resource Access Management (RAM) user synchronization to synchronously create a Resource Access Management (RAM) user that has the same name as a CloudSSO user in a destination account in a resource directory. You can then use the Resource Access Management (RAM) user to access resources in the account.
|
|
257
257
|
*
|
|
258
258
|
* @param request - CreateUserProvisioningRequest
|
|
259
259
|
* @returns CreateUserProvisioningResponse
|
|
260
260
|
*/
|
|
261
261
|
createUserProvisioning(request: $_model.CreateUserProvisioningRequest): Promise<$_model.CreateUserProvisioningResponse>;
|
|
262
262
|
/**
|
|
263
|
-
* Removes the
|
|
263
|
+
* Removes the authorization from an account in a resource directory.
|
|
264
264
|
*
|
|
265
265
|
* @remarks
|
|
266
|
-
*
|
|
267
|
-
* This topic provides an example
|
|
266
|
+
* This API operation is asynchronous. You can use the `TaskId` returned in the response to call [GetTask](https://help.aliyun.com/document_detail/340670.html) to query the task execution status.
|
|
267
|
+
* This topic provides an example of removing the authorization for the CloudSSO user `u-00q8wbq42wiltcrk****` to use the access configuration `ac-00jhtfl8thteu6uj****` on the account in a resource directory `114240524784****`.
|
|
268
268
|
*
|
|
269
269
|
* @param request - DeleteAccessAssignmentRequest
|
|
270
270
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -272,11 +272,11 @@ export default class Client extends OpenApi {
|
|
|
272
272
|
*/
|
|
273
273
|
deleteAccessAssignmentWithOptions(request: $_model.DeleteAccessAssignmentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteAccessAssignmentResponse>;
|
|
274
274
|
/**
|
|
275
|
-
* Removes the
|
|
275
|
+
* Removes the authorization from an account in a resource directory.
|
|
276
276
|
*
|
|
277
277
|
* @remarks
|
|
278
|
-
*
|
|
279
|
-
* This topic provides an example
|
|
278
|
+
* This API operation is asynchronous. You can use the `TaskId` returned in the response to call [GetTask](https://help.aliyun.com/document_detail/340670.html) to query the task execution status.
|
|
279
|
+
* This topic provides an example of removing the authorization for the CloudSSO user `u-00q8wbq42wiltcrk****` to use the access configuration `ac-00jhtfl8thteu6uj****` on the account in a resource directory `114240524784****`.
|
|
280
280
|
*
|
|
281
281
|
* @param request - DeleteAccessAssignmentRequest
|
|
282
282
|
* @returns DeleteAccessAssignmentResponse
|
|
@@ -286,10 +286,10 @@ export default class Client extends OpenApi {
|
|
|
286
286
|
* Deletes an access configuration.
|
|
287
287
|
*
|
|
288
288
|
* @remarks
|
|
289
|
-
* ###
|
|
290
|
-
*
|
|
291
|
-
* ###
|
|
292
|
-
* This topic provides an example on how to delete
|
|
289
|
+
* ### Before you begin
|
|
290
|
+
* Before you delete an access configuration, you must deprovision the access configuration from the members of the resource directory. For more information, see [DeprovisionAccessConfiguration](https://help.aliyun.com/document_detail/338352.html).
|
|
291
|
+
* ### Usage notes
|
|
292
|
+
* This topic provides an example on how to delete an access configuration whose ID is `ac-001j9mcm3k7335bc****`.
|
|
293
293
|
*
|
|
294
294
|
* @param request - DeleteAccessConfigurationRequest
|
|
295
295
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -300,10 +300,10 @@ export default class Client extends OpenApi {
|
|
|
300
300
|
* Deletes an access configuration.
|
|
301
301
|
*
|
|
302
302
|
* @remarks
|
|
303
|
-
* ###
|
|
304
|
-
*
|
|
305
|
-
* ###
|
|
306
|
-
* This topic provides an example on how to delete
|
|
303
|
+
* ### Before you begin
|
|
304
|
+
* Before you delete an access configuration, you must deprovision the access configuration from the members of the resource directory. For more information, see [DeprovisionAccessConfiguration](https://help.aliyun.com/document_detail/338352.html).
|
|
305
|
+
* ### Usage notes
|
|
306
|
+
* This topic provides an example on how to delete an access configuration whose ID is `ac-001j9mcm3k7335bc****`.
|
|
307
307
|
*
|
|
308
308
|
* @param request - DeleteAccessConfigurationRequest
|
|
309
309
|
* @returns DeleteAccessConfigurationResponse
|
|
@@ -313,16 +313,16 @@ export default class Client extends OpenApi {
|
|
|
313
313
|
* Deletes a directory.
|
|
314
314
|
*
|
|
315
315
|
* @remarks
|
|
316
|
-
* ###
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
*
|
|
320
|
-
*
|
|
321
|
-
*
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
* ###
|
|
325
|
-
* This topic provides an example on how to delete a directory
|
|
316
|
+
* ### Before you begin
|
|
317
|
+
* Before you delete a directory, make sure that the directory does not contain any resources. Specifically:
|
|
318
|
+
* - Remove all authorizations for users and groups on an account in a resource directory. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
319
|
+
* - Delete users. For more information, see [DeleteUser](https://help.aliyun.com/document_detail/341671.html).
|
|
320
|
+
* - Delete groups. For more information, see [DeleteGroup](https://help.aliyun.com/document_detail/341821.html).
|
|
321
|
+
* - Delete access configurations. For more information, see [DeleteAccessConfiguration](https://help.aliyun.com/document_detail/336907.html).
|
|
322
|
+
* - Delete SCIM credentials. For more information, see [DeleteSCIMServerCredential](https://help.aliyun.com/document_detail/341842.html).
|
|
323
|
+
* - Delete single sign-on configurations. For more information, see [ClearExternalSAMLIdentityProvider](https://help.aliyun.com/document_detail/341573.html).
|
|
324
|
+
* ### Usage notes
|
|
325
|
+
* This topic provides an example on how to delete a directory with the ID `d-00fc2p61****`.
|
|
326
326
|
*
|
|
327
327
|
* @param request - DeleteDirectoryRequest
|
|
328
328
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -333,32 +333,32 @@ export default class Client extends OpenApi {
|
|
|
333
333
|
* Deletes a directory.
|
|
334
334
|
*
|
|
335
335
|
* @remarks
|
|
336
|
-
* ###
|
|
337
|
-
*
|
|
338
|
-
*
|
|
339
|
-
*
|
|
340
|
-
*
|
|
341
|
-
*
|
|
342
|
-
*
|
|
343
|
-
*
|
|
344
|
-
* ###
|
|
345
|
-
* This topic provides an example on how to delete a directory
|
|
336
|
+
* ### Before you begin
|
|
337
|
+
* Before you delete a directory, make sure that the directory does not contain any resources. Specifically:
|
|
338
|
+
* - Remove all authorizations for users and groups on an account in a resource directory. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
339
|
+
* - Delete users. For more information, see [DeleteUser](https://help.aliyun.com/document_detail/341671.html).
|
|
340
|
+
* - Delete groups. For more information, see [DeleteGroup](https://help.aliyun.com/document_detail/341821.html).
|
|
341
|
+
* - Delete access configurations. For more information, see [DeleteAccessConfiguration](https://help.aliyun.com/document_detail/336907.html).
|
|
342
|
+
* - Delete SCIM credentials. For more information, see [DeleteSCIMServerCredential](https://help.aliyun.com/document_detail/341842.html).
|
|
343
|
+
* - Delete single sign-on configurations. For more information, see [ClearExternalSAMLIdentityProvider](https://help.aliyun.com/document_detail/341573.html).
|
|
344
|
+
* ### Usage notes
|
|
345
|
+
* This topic provides an example on how to delete a directory with the ID `d-00fc2p61****`.
|
|
346
346
|
*
|
|
347
347
|
* @param request - DeleteDirectoryRequest
|
|
348
348
|
* @returns DeleteDirectoryResponse
|
|
349
349
|
*/
|
|
350
350
|
deleteDirectory(request: $_model.DeleteDirectoryRequest): Promise<$_model.DeleteDirectoryResponse>;
|
|
351
351
|
/**
|
|
352
|
-
* Deletes a group.
|
|
352
|
+
* Deletes a specified group.
|
|
353
353
|
*
|
|
354
354
|
* @remarks
|
|
355
|
-
* ###
|
|
356
|
-
*
|
|
357
|
-
* - Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
358
|
-
* -
|
|
359
|
-
* ###
|
|
360
|
-
* If
|
|
361
|
-
* This topic provides an example on how to delete the group `g-00jqzghi2n3o5hkh****`.
|
|
355
|
+
* ### Before you begin
|
|
356
|
+
* Before you delete a user group, make sure that the user group is not associated with the following resources. Otherwise, the deletion failed.
|
|
357
|
+
* - Users: You must remove users from the user group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
358
|
+
* - Authorization: You must remove the authorization of the user group on the account in a resource directory. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
359
|
+
* ### Usage notes
|
|
360
|
+
* If SCIM synchronization is enabled, you cannot delete user groups that are synchronized by using SCIM.
|
|
361
|
+
* This topic provides an example on how to delete the user group `g-00jqzghi2n3o5hkh****`.
|
|
362
362
|
*
|
|
363
363
|
* @param request - DeleteGroupRequest
|
|
364
364
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -366,16 +366,16 @@ export default class Client extends OpenApi {
|
|
|
366
366
|
*/
|
|
367
367
|
deleteGroupWithOptions(request: $_model.DeleteGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteGroupResponse>;
|
|
368
368
|
/**
|
|
369
|
-
* Deletes a group.
|
|
369
|
+
* Deletes a specified group.
|
|
370
370
|
*
|
|
371
371
|
* @remarks
|
|
372
|
-
* ###
|
|
373
|
-
*
|
|
374
|
-
* - Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
375
|
-
* -
|
|
376
|
-
* ###
|
|
377
|
-
* If
|
|
378
|
-
* This topic provides an example on how to delete the group `g-00jqzghi2n3o5hkh****`.
|
|
372
|
+
* ### Before you begin
|
|
373
|
+
* Before you delete a user group, make sure that the user group is not associated with the following resources. Otherwise, the deletion failed.
|
|
374
|
+
* - Users: You must remove users from the user group. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
375
|
+
* - Authorization: You must remove the authorization of the user group on the account in a resource directory. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
376
|
+
* ### Usage notes
|
|
377
|
+
* If SCIM synchronization is enabled, you cannot delete user groups that are synchronized by using SCIM.
|
|
378
|
+
* This topic provides an example on how to delete the user group `g-00jqzghi2n3o5hkh****`.
|
|
379
379
|
*
|
|
380
380
|
* @param request - DeleteGroupRequest
|
|
381
381
|
* @returns DeleteGroupResponse
|
|
@@ -403,11 +403,11 @@ export default class Client extends OpenApi {
|
|
|
403
403
|
*/
|
|
404
404
|
deleteMFADeviceForUser(request: $_model.DeleteMFADeviceForUserRequest): Promise<$_model.DeleteMFADeviceForUserResponse>;
|
|
405
405
|
/**
|
|
406
|
-
* Deletes a
|
|
406
|
+
* Deletes a SCIM credential.
|
|
407
407
|
*
|
|
408
408
|
* @remarks
|
|
409
|
-
* After a SCIM credential is deleted,
|
|
410
|
-
* This topic provides an example
|
|
409
|
+
* After a SCIM credential is deleted, synchronization tasks that use the SCIM credential will fail.
|
|
410
|
+
* This topic provides an example of deleting a SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
|
|
411
411
|
*
|
|
412
412
|
* @param request - DeleteSCIMServerCredentialRequest
|
|
413
413
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -415,11 +415,11 @@ export default class Client extends OpenApi {
|
|
|
415
415
|
*/
|
|
416
416
|
deleteSCIMServerCredentialWithOptions(request: $_model.DeleteSCIMServerCredentialRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteSCIMServerCredentialResponse>;
|
|
417
417
|
/**
|
|
418
|
-
* Deletes a
|
|
418
|
+
* Deletes a SCIM credential.
|
|
419
419
|
*
|
|
420
420
|
* @remarks
|
|
421
|
-
* After a SCIM credential is deleted,
|
|
422
|
-
* This topic provides an example
|
|
421
|
+
* After a SCIM credential is deleted, synchronization tasks that use the SCIM credential will fail.
|
|
422
|
+
* This topic provides an example of deleting a SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
|
|
423
423
|
*
|
|
424
424
|
* @param request - DeleteSCIMServerCredentialRequest
|
|
425
425
|
* @returns DeleteSCIMServerCredentialResponse
|
|
@@ -429,14 +429,14 @@ export default class Client extends OpenApi {
|
|
|
429
429
|
* Deletes a user.
|
|
430
430
|
*
|
|
431
431
|
* @remarks
|
|
432
|
-
* ###
|
|
433
|
-
* Before you delete a user,
|
|
434
|
-
*
|
|
435
|
-
*
|
|
436
|
-
*
|
|
437
|
-
* ###
|
|
438
|
-
*
|
|
439
|
-
* This topic provides an example
|
|
432
|
+
* ### Before you begin
|
|
433
|
+
* Before you delete a user, ensure that the user is not associated with the following resources. Otherwise, the deletion will result in a failed state:
|
|
434
|
+
* - MFA devices: You must delete the MFA device attached to the user. For more information, see [DeleteMFADeviceForUser](https://help.aliyun.com/document_detail/341675.html).
|
|
435
|
+
* - Authorization: You must remove the authorization of the user on the account in a resource directory. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
436
|
+
* - Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
437
|
+
* ### Usage notes
|
|
438
|
+
* You cannot delete a SCIM-synchronized user when SCIM synchronization is enabled.
|
|
439
|
+
* This topic provides an example of deleting a user whose ID is `u-00q8wbq42wiltcrk****`.
|
|
440
440
|
*
|
|
441
441
|
* @param request - DeleteUserRequest
|
|
442
442
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -447,21 +447,21 @@ export default class Client extends OpenApi {
|
|
|
447
447
|
* Deletes a user.
|
|
448
448
|
*
|
|
449
449
|
* @remarks
|
|
450
|
-
* ###
|
|
451
|
-
* Before you delete a user,
|
|
452
|
-
*
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
* ###
|
|
456
|
-
*
|
|
457
|
-
* This topic provides an example
|
|
450
|
+
* ### Before you begin
|
|
451
|
+
* Before you delete a user, ensure that the user is not associated with the following resources. Otherwise, the deletion will result in a failed state:
|
|
452
|
+
* - MFA devices: You must delete the MFA device attached to the user. For more information, see [DeleteMFADeviceForUser](https://help.aliyun.com/document_detail/341675.html).
|
|
453
|
+
* - Authorization: You must remove the authorization of the user on the account in a resource directory. For more information, see [DeleteAccessAssignment](https://help.aliyun.com/document_detail/338350.html).
|
|
454
|
+
* - Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](https://help.aliyun.com/document_detail/335116.html).
|
|
455
|
+
* ### Usage notes
|
|
456
|
+
* You cannot delete a SCIM-synchronized user when SCIM synchronization is enabled.
|
|
457
|
+
* This topic provides an example of deleting a user whose ID is `u-00q8wbq42wiltcrk****`.
|
|
458
458
|
*
|
|
459
459
|
* @param request - DeleteUserRequest
|
|
460
460
|
* @returns DeleteUserResponse
|
|
461
461
|
*/
|
|
462
462
|
deleteUser(request: $_model.DeleteUserRequest): Promise<$_model.DeleteUserResponse>;
|
|
463
463
|
/**
|
|
464
|
-
*
|
|
464
|
+
* Invokes DeleteUserProvisioning to delete a Resource Access Management (RAM) user synchronization.
|
|
465
465
|
*
|
|
466
466
|
* @param request - DeleteUserProvisioningRequest
|
|
467
467
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -469,14 +469,14 @@ export default class Client extends OpenApi {
|
|
|
469
469
|
*/
|
|
470
470
|
deleteUserProvisioningWithOptions(request: $_model.DeleteUserProvisioningRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteUserProvisioningResponse>;
|
|
471
471
|
/**
|
|
472
|
-
*
|
|
472
|
+
* Invokes DeleteUserProvisioning to delete a Resource Access Management (RAM) user synchronization.
|
|
473
473
|
*
|
|
474
474
|
* @param request - DeleteUserProvisioningRequest
|
|
475
475
|
* @returns DeleteUserProvisioningResponse
|
|
476
476
|
*/
|
|
477
477
|
deleteUserProvisioning(request: $_model.DeleteUserProvisioningRequest): Promise<$_model.DeleteUserProvisioningResponse>;
|
|
478
478
|
/**
|
|
479
|
-
*
|
|
479
|
+
* Invokes DeleteUserProvisioningEvent to delete a Resource Access Management (RAM) user synchronization event that failed to execute.
|
|
480
480
|
*
|
|
481
481
|
* @param request - DeleteUserProvisioningEventRequest
|
|
482
482
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -484,18 +484,18 @@ export default class Client extends OpenApi {
|
|
|
484
484
|
*/
|
|
485
485
|
deleteUserProvisioningEventWithOptions(request: $_model.DeleteUserProvisioningEventRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteUserProvisioningEventResponse>;
|
|
486
486
|
/**
|
|
487
|
-
*
|
|
487
|
+
* Invokes DeleteUserProvisioningEvent to delete a Resource Access Management (RAM) user synchronization event that failed to execute.
|
|
488
488
|
*
|
|
489
489
|
* @param request - DeleteUserProvisioningEventRequest
|
|
490
490
|
* @returns DeleteUserProvisioningEventResponse
|
|
491
491
|
*/
|
|
492
492
|
deleteUserProvisioningEvent(request: $_model.DeleteUserProvisioningEventRequest): Promise<$_model.DeleteUserProvisioningEventResponse>;
|
|
493
493
|
/**
|
|
494
|
-
*
|
|
494
|
+
* Deprovisions an access configuration from an account in a resource directory.
|
|
495
495
|
*
|
|
496
496
|
* @remarks
|
|
497
|
-
*
|
|
498
|
-
* This topic provides an example
|
|
497
|
+
* This API operation is asynchronous. You can use the `TaskId` returned in the response parameters to call [GetTask](https://help.aliyun.com/document_detail/340670.html) and query the task execution status.
|
|
498
|
+
* This topic provides an example of deprovisioning the access configuration `ac-00jhtfl8thteu6uj****` from the account in a resource directory `114240524784****`.
|
|
499
499
|
*
|
|
500
500
|
* @param request - DeprovisionAccessConfigurationRequest
|
|
501
501
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -503,11 +503,11 @@ export default class Client extends OpenApi {
|
|
|
503
503
|
*/
|
|
504
504
|
deprovisionAccessConfigurationWithOptions(request: $_model.DeprovisionAccessConfigurationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeprovisionAccessConfigurationResponse>;
|
|
505
505
|
/**
|
|
506
|
-
*
|
|
506
|
+
* Deprovisions an access configuration from an account in a resource directory.
|
|
507
507
|
*
|
|
508
508
|
* @remarks
|
|
509
|
-
*
|
|
510
|
-
* This topic provides an example
|
|
509
|
+
* This API operation is asynchronous. You can use the `TaskId` returned in the response parameters to call [GetTask](https://help.aliyun.com/document_detail/340670.html) and query the task execution status.
|
|
510
|
+
* This topic provides an example of deprovisioning the access configuration `ac-00jhtfl8thteu6uj****` from the account in a resource directory `114240524784****`.
|
|
511
511
|
*
|
|
512
512
|
* @param request - DeprovisionAccessConfigurationRequest
|
|
513
513
|
* @returns DeprovisionAccessConfigurationResponse
|
|
@@ -547,11 +547,11 @@ export default class Client extends OpenApi {
|
|
|
547
547
|
*/
|
|
548
548
|
disableService(): Promise<$_model.DisableServiceResponse>;
|
|
549
549
|
/**
|
|
550
|
-
* Enables
|
|
550
|
+
* Enables a CloudSSO delegated administrator account.
|
|
551
551
|
*
|
|
552
552
|
* @remarks
|
|
553
|
-
*
|
|
554
|
-
* After the
|
|
553
|
+
* The management account of a resource directory can set a member of the resource directory as a CloudSSO delegated administrator account. For more information, see [Add a delegated administrator account](https://help.aliyun.com/document_detail/208117.html).
|
|
554
|
+
* After the configuration is complete, you can call this operation to enable the CloudSSO delegated administrator account to manage CloudSSO.
|
|
555
555
|
*
|
|
556
556
|
* @param request - EnableDelegateAccountRequest
|
|
557
557
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -559,11 +559,11 @@ export default class Client extends OpenApi {
|
|
|
559
559
|
*/
|
|
560
560
|
enableDelegateAccountWithOptions(request: $_model.EnableDelegateAccountRequest, runtime: $dara.RuntimeOptions): Promise<$_model.EnableDelegateAccountResponse>;
|
|
561
561
|
/**
|
|
562
|
-
* Enables
|
|
562
|
+
* Enables a CloudSSO delegated administrator account.
|
|
563
563
|
*
|
|
564
564
|
* @remarks
|
|
565
|
-
*
|
|
566
|
-
* After the
|
|
565
|
+
* The management account of a resource directory can set a member of the resource directory as a CloudSSO delegated administrator account. For more information, see [Add a delegated administrator account](https://help.aliyun.com/document_detail/208117.html).
|
|
566
|
+
* After the configuration is complete, you can call this operation to enable the CloudSSO delegated administrator account to manage CloudSSO.
|
|
567
567
|
*
|
|
568
568
|
* @param request - EnableDelegateAccountRequest
|
|
569
569
|
* @returns EnableDelegateAccountResponse
|
|
@@ -632,10 +632,10 @@ export default class Client extends OpenApi {
|
|
|
632
632
|
*/
|
|
633
633
|
getAttributePassingSetting(request: $_model.GetAttributePassingSettingRequest): Promise<$_model.GetAttributePassingSettingResponse>;
|
|
634
634
|
/**
|
|
635
|
-
* Queries
|
|
635
|
+
* Queries the details of a directory.
|
|
636
636
|
*
|
|
637
637
|
* @remarks
|
|
638
|
-
* This topic provides an example
|
|
638
|
+
* This topic provides an example of querying the details of a directory whose ID is `d-00fc2p61****`.
|
|
639
639
|
*
|
|
640
640
|
* @param request - GetDirectoryRequest
|
|
641
641
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -643,10 +643,10 @@ export default class Client extends OpenApi {
|
|
|
643
643
|
*/
|
|
644
644
|
getDirectoryWithOptions(request: $_model.GetDirectoryRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDirectoryResponse>;
|
|
645
645
|
/**
|
|
646
|
-
* Queries
|
|
646
|
+
* Queries the details of a directory.
|
|
647
647
|
*
|
|
648
648
|
* @remarks
|
|
649
|
-
* This topic provides an example
|
|
649
|
+
* This topic provides an example of querying the details of a directory whose ID is `d-00fc2p61****`.
|
|
650
650
|
*
|
|
651
651
|
* @param request - GetDirectoryRequest
|
|
652
652
|
* @returns GetDirectoryResponse
|
|
@@ -869,10 +869,10 @@ export default class Client extends OpenApi {
|
|
|
869
869
|
*/
|
|
870
870
|
getServiceStatus(): Promise<$_model.GetServiceStatusResponse>;
|
|
871
871
|
/**
|
|
872
|
-
* Queries
|
|
872
|
+
* Queries the details of an asynchronous task.
|
|
873
873
|
*
|
|
874
874
|
* @remarks
|
|
875
|
-
* This topic provides an example
|
|
875
|
+
* This topic provides an example of querying the details of a task whose ID is `t-shfqw1u1edszvxw5****`.
|
|
876
876
|
*
|
|
877
877
|
* @param request - GetTaskRequest
|
|
878
878
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -880,10 +880,10 @@ export default class Client extends OpenApi {
|
|
|
880
880
|
*/
|
|
881
881
|
getTaskWithOptions(request: $_model.GetTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetTaskResponse>;
|
|
882
882
|
/**
|
|
883
|
-
* Queries
|
|
883
|
+
* Queries the details of an asynchronous task.
|
|
884
884
|
*
|
|
885
885
|
* @remarks
|
|
886
|
-
* This topic provides an example
|
|
886
|
+
* This topic provides an example of querying the details of a task whose ID is `t-shfqw1u1edszvxw5****`.
|
|
887
887
|
*
|
|
888
888
|
* @param request - GetTaskRequest
|
|
889
889
|
* @returns GetTaskResponse
|
|
@@ -1039,10 +1039,10 @@ export default class Client extends OpenApi {
|
|
|
1039
1039
|
*/
|
|
1040
1040
|
getUserProvisioningStatistics(request: $_model.GetUserProvisioningStatisticsRequest): Promise<$_model.GetUserProvisioningStatisticsResponse>;
|
|
1041
1041
|
/**
|
|
1042
|
-
* Queries
|
|
1042
|
+
* Queries access assignments.
|
|
1043
1043
|
*
|
|
1044
1044
|
* @remarks
|
|
1045
|
-
* This topic provides an example
|
|
1045
|
+
* This topic provides an example of querying the access assignments on the account in a resource directory `114240524784****`. The response shows that one access assignment record exists on the account.
|
|
1046
1046
|
*
|
|
1047
1047
|
* @param request - ListAccessAssignmentsRequest
|
|
1048
1048
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1050,20 +1050,20 @@ export default class Client extends OpenApi {
|
|
|
1050
1050
|
*/
|
|
1051
1051
|
listAccessAssignmentsWithOptions(request: $_model.ListAccessAssignmentsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAccessAssignmentsResponse>;
|
|
1052
1052
|
/**
|
|
1053
|
-
* Queries
|
|
1053
|
+
* Queries access assignments.
|
|
1054
1054
|
*
|
|
1055
1055
|
* @remarks
|
|
1056
|
-
* This topic provides an example
|
|
1056
|
+
* This topic provides an example of querying the access assignments on the account in a resource directory `114240524784****`. The response shows that one access assignment record exists on the account.
|
|
1057
1057
|
*
|
|
1058
1058
|
* @param request - ListAccessAssignmentsRequest
|
|
1059
1059
|
* @returns ListAccessAssignmentsResponse
|
|
1060
1060
|
*/
|
|
1061
1061
|
listAccessAssignments(request: $_model.ListAccessAssignmentsRequest): Promise<$_model.ListAccessAssignmentsResponse>;
|
|
1062
1062
|
/**
|
|
1063
|
-
* Queries
|
|
1063
|
+
* Queries access configuration provisionings.
|
|
1064
1064
|
*
|
|
1065
1065
|
* @remarks
|
|
1066
|
-
* This topic provides an example
|
|
1066
|
+
* This topic provides an example of querying the deployment list of the access configuration `ac-00ccule7tadaijxc****`. The response shows that the access configuration is deployed in two accounts, each being an account in a resource directory.
|
|
1067
1067
|
*
|
|
1068
1068
|
* @param request - ListAccessConfigurationProvisioningsRequest
|
|
1069
1069
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1071,10 +1071,10 @@ export default class Client extends OpenApi {
|
|
|
1071
1071
|
*/
|
|
1072
1072
|
listAccessConfigurationProvisioningsWithOptions(request: $_model.ListAccessConfigurationProvisioningsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAccessConfigurationProvisioningsResponse>;
|
|
1073
1073
|
/**
|
|
1074
|
-
* Queries
|
|
1074
|
+
* Queries access configuration provisionings.
|
|
1075
1075
|
*
|
|
1076
1076
|
* @remarks
|
|
1077
|
-
* This topic provides an example
|
|
1077
|
+
* This topic provides an example of querying the deployment list of the access configuration `ac-00ccule7tadaijxc****`. The response shows that the access configuration is deployed in two accounts, each being an account in a resource directory.
|
|
1078
1078
|
*
|
|
1079
1079
|
* @param request - ListAccessConfigurationProvisioningsRequest
|
|
1080
1080
|
* @returns ListAccessConfigurationProvisioningsResponse
|
|
@@ -1267,11 +1267,25 @@ export default class Client extends OpenApi {
|
|
|
1267
1267
|
*/
|
|
1268
1268
|
listSCIMServerCredentials(request: $_model.ListSCIMServerCredentialsRequest): Promise<$_model.ListSCIMServerCredentialsResponse>;
|
|
1269
1269
|
/**
|
|
1270
|
-
* Queries
|
|
1270
|
+
* Queries the relationships between resources and tags.
|
|
1271
|
+
*
|
|
1272
|
+
* @param request - ListTagResourcesRequest
|
|
1273
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1274
|
+
* @returns ListTagResourcesResponse
|
|
1275
|
+
*/
|
|
1276
|
+
listTagResourcesWithOptions(request: $_model.ListTagResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTagResourcesResponse>;
|
|
1277
|
+
/**
|
|
1278
|
+
* Queries the relationships between resources and tags.
|
|
1279
|
+
*
|
|
1280
|
+
* @param request - ListTagResourcesRequest
|
|
1281
|
+
* @returns ListTagResourcesResponse
|
|
1282
|
+
*/
|
|
1283
|
+
listTagResources(request: $_model.ListTagResourcesRequest): Promise<$_model.ListTagResourcesResponse>;
|
|
1284
|
+
/**
|
|
1285
|
+
* Queries a list of asynchronous tasks.
|
|
1271
1286
|
*
|
|
1272
1287
|
* @remarks
|
|
1273
|
-
* By default, this operation queries the tasks within the
|
|
1274
|
-
* This topic provides an example on how to query the tasks within the previous 24 hours.
|
|
1288
|
+
* By default, this operation queries the list of tasks created within the last 24 hours. You can query tasks created within the last 7 days at most. You can use the Filter parameter to specify the start time of the query. This topic provides an example on how to query the list of tasks created within the last 24 hours.
|
|
1275
1289
|
*
|
|
1276
1290
|
* @param request - ListTasksRequest
|
|
1277
1291
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1279,11 +1293,10 @@ export default class Client extends OpenApi {
|
|
|
1279
1293
|
*/
|
|
1280
1294
|
listTasksWithOptions(request: $_model.ListTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListTasksResponse>;
|
|
1281
1295
|
/**
|
|
1282
|
-
* Queries asynchronous tasks.
|
|
1296
|
+
* Queries a list of asynchronous tasks.
|
|
1283
1297
|
*
|
|
1284
1298
|
* @remarks
|
|
1285
|
-
* By default, this operation queries the tasks within the
|
|
1286
|
-
* This topic provides an example on how to query the tasks within the previous 24 hours.
|
|
1299
|
+
* By default, this operation queries the list of tasks created within the last 24 hours. You can query tasks created within the last 7 days at most. You can use the Filter parameter to specify the start time of the query. This topic provides an example on how to query the list of tasks created within the last 24 hours.
|
|
1287
1300
|
*
|
|
1288
1301
|
* @param request - ListTasksRequest
|
|
1289
1302
|
* @returns ListTasksResponse
|
|
@@ -1335,11 +1348,11 @@ export default class Client extends OpenApi {
|
|
|
1335
1348
|
*/
|
|
1336
1349
|
listUsers(request: $_model.ListUsersRequest): Promise<$_model.ListUsersResponse>;
|
|
1337
1350
|
/**
|
|
1338
|
-
*
|
|
1351
|
+
* Invokes ProvisionAccessConfiguration to perform access configuration provisioning and deployment for an account in a resource directory.
|
|
1339
1352
|
*
|
|
1340
1353
|
* @remarks
|
|
1341
|
-
*
|
|
1342
|
-
* This topic provides an example
|
|
1354
|
+
* This API operation is asynchronous. You can use the `TaskId` returned in the response to call [GetTask](https://help.aliyun.com/document_detail/340670.html) and query the task execution status.
|
|
1355
|
+
* This topic provides an example of provisioning the access configuration `ac-00jhtfl8thteu6uj****` to the account in a resource directory `114240524784****`.
|
|
1343
1356
|
*
|
|
1344
1357
|
* @param request - ProvisionAccessConfigurationRequest
|
|
1345
1358
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1347,11 +1360,11 @@ export default class Client extends OpenApi {
|
|
|
1347
1360
|
*/
|
|
1348
1361
|
provisionAccessConfigurationWithOptions(request: $_model.ProvisionAccessConfigurationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ProvisionAccessConfigurationResponse>;
|
|
1349
1362
|
/**
|
|
1350
|
-
*
|
|
1363
|
+
* Invokes ProvisionAccessConfiguration to perform access configuration provisioning and deployment for an account in a resource directory.
|
|
1351
1364
|
*
|
|
1352
1365
|
* @remarks
|
|
1353
|
-
*
|
|
1354
|
-
* This topic provides an example
|
|
1366
|
+
* This API operation is asynchronous. You can use the `TaskId` returned in the response to call [GetTask](https://help.aliyun.com/document_detail/340670.html) and query the task execution status.
|
|
1367
|
+
* This topic provides an example of provisioning the access configuration `ac-00jhtfl8thteu6uj****` to the account in a resource directory `114240524784****`.
|
|
1355
1368
|
*
|
|
1356
1369
|
* @param request - ProvisionAccessConfigurationRequest
|
|
1357
1370
|
* @returns ProvisionAccessConfigurationResponse
|
|
@@ -1428,9 +1441,9 @@ export default class Client extends OpenApi {
|
|
|
1428
1441
|
* Resets the password of a user.
|
|
1429
1442
|
*
|
|
1430
1443
|
* @remarks
|
|
1431
|
-
*
|
|
1432
|
-
* >
|
|
1433
|
-
* This topic provides an example
|
|
1444
|
+
* A CloudSSO administrator can reset the password of a user when the user forgets the password, the password expires, or the password poses a security risk.
|
|
1445
|
+
* > You cannot reset user passwords after single sign-on (SSO) is enabled.
|
|
1446
|
+
* This topic provides an example of resetting the password of the user u-00q8wbq42wiltcrk**** by using a system-generated password.
|
|
1434
1447
|
*
|
|
1435
1448
|
* @param request - ResetUserPasswordRequest
|
|
1436
1449
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1441,9 +1454,9 @@ export default class Client extends OpenApi {
|
|
|
1441
1454
|
* Resets the password of a user.
|
|
1442
1455
|
*
|
|
1443
1456
|
* @remarks
|
|
1444
|
-
*
|
|
1445
|
-
* >
|
|
1446
|
-
* This topic provides an example
|
|
1457
|
+
* A CloudSSO administrator can reset the password of a user when the user forgets the password, the password expires, or the password poses a security risk.
|
|
1458
|
+
* > You cannot reset user passwords after single sign-on (SSO) is enabled.
|
|
1459
|
+
* This topic provides an example of resetting the password of the user u-00q8wbq42wiltcrk**** by using a system-generated password.
|
|
1447
1460
|
*
|
|
1448
1461
|
* @param request - ResetUserPasswordRequest
|
|
1449
1462
|
* @returns ResetUserPasswordResponse
|
|
@@ -1581,6 +1594,36 @@ export default class Client extends OpenApi {
|
|
|
1581
1594
|
* @returns SetSCIMSynchronizationStatusResponse
|
|
1582
1595
|
*/
|
|
1583
1596
|
setSCIMSynchronizationStatus(request: $_model.SetSCIMSynchronizationStatusRequest): Promise<$_model.SetSCIMSynchronizationStatusResponse>;
|
|
1597
|
+
/**
|
|
1598
|
+
* Tags resources.
|
|
1599
|
+
*
|
|
1600
|
+
* @param request - TagResourcesRequest
|
|
1601
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1602
|
+
* @returns TagResourcesResponse
|
|
1603
|
+
*/
|
|
1604
|
+
tagResourcesWithOptions(request: $_model.TagResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.TagResourcesResponse>;
|
|
1605
|
+
/**
|
|
1606
|
+
* Tags resources.
|
|
1607
|
+
*
|
|
1608
|
+
* @param request - TagResourcesRequest
|
|
1609
|
+
* @returns TagResourcesResponse
|
|
1610
|
+
*/
|
|
1611
|
+
tagResources(request: $_model.TagResourcesRequest): Promise<$_model.TagResourcesResponse>;
|
|
1612
|
+
/**
|
|
1613
|
+
* Untags resources.
|
|
1614
|
+
*
|
|
1615
|
+
* @param request - UntagResourcesRequest
|
|
1616
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1617
|
+
* @returns UntagResourcesResponse
|
|
1618
|
+
*/
|
|
1619
|
+
untagResourcesWithOptions(request: $_model.UntagResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UntagResourcesResponse>;
|
|
1620
|
+
/**
|
|
1621
|
+
* Untags resources.
|
|
1622
|
+
*
|
|
1623
|
+
* @param request - UntagResourcesRequest
|
|
1624
|
+
* @returns UntagResourcesResponse
|
|
1625
|
+
*/
|
|
1626
|
+
untagResources(request: $_model.UntagResourcesRequest): Promise<$_model.UntagResourcesResponse>;
|
|
1584
1627
|
/**
|
|
1585
1628
|
* Modifies information about an access configuration.
|
|
1586
1629
|
*
|
|
@@ -1718,10 +1761,10 @@ export default class Client extends OpenApi {
|
|
|
1718
1761
|
*/
|
|
1719
1762
|
updateMFAAuthenticationSettings(request: $_model.UpdateMFAAuthenticationSettingsRequest): Promise<$_model.UpdateMFAAuthenticationSettingsResponse>;
|
|
1720
1763
|
/**
|
|
1721
|
-
* Enables or disables a
|
|
1764
|
+
* Enables or disables a SCIM credential.
|
|
1722
1765
|
*
|
|
1723
1766
|
* @remarks
|
|
1724
|
-
* This topic provides an example
|
|
1767
|
+
* This topic provides an example of disabling the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the credential is disabled, synchronization tasks that use this SCIM credential will fail. You can call this operation again to enable the SCIM credential.
|
|
1725
1768
|
*
|
|
1726
1769
|
* @param request - UpdateSCIMServerCredentialStatusRequest
|
|
1727
1770
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1729,10 +1772,10 @@ export default class Client extends OpenApi {
|
|
|
1729
1772
|
*/
|
|
1730
1773
|
updateSCIMServerCredentialStatusWithOptions(request: $_model.UpdateSCIMServerCredentialStatusRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateSCIMServerCredentialStatusResponse>;
|
|
1731
1774
|
/**
|
|
1732
|
-
* Enables or disables a
|
|
1775
|
+
* Enables or disables a SCIM credential.
|
|
1733
1776
|
*
|
|
1734
1777
|
* @remarks
|
|
1735
|
-
* This topic provides an example
|
|
1778
|
+
* This topic provides an example of disabling the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the credential is disabled, synchronization tasks that use this SCIM credential will fail. You can call this operation again to enable the SCIM credential.
|
|
1736
1779
|
*
|
|
1737
1780
|
* @param request - UpdateSCIMServerCredentialStatusRequest
|
|
1738
1781
|
* @returns UpdateSCIMServerCredentialStatusResponse
|