@alicloud/cloudsso20210515 1.5.4 → 1.7.0

package/src/models/GetAttributePassingSettingResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { GetAttributePassingSettingResponseBody } from "./GetAttributePassingSettingResponseBody";
+
+
+export class GetAttributePassingSettingResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: GetAttributePassingSettingResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: GetAttributePassingSettingResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetAttributePassingSettingResponseBody.ts

@@ -0,0 +1,78 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetAttributePassingSettingResponseBodyAttributePassingSetting extends $dara.Model {
+  /**
+   * @remarks
+   * The SourceIdentity pass-through mode. If not configured, Disabled is returned by default. Valid values:
+   * 
+   * - IdP: Uses the SourceIdentity attribute value carried in the SAML assertion from the external identity provider (IdP). The attribute value must be 2 to 64 characters in length and can contain only letters, digits, and the following special characters: =,.@-_.
+   * - UserName: Uses the CloudSSO username as the SourceIdentity. The system automatically adds a reserved prefix, resulting in the format acs:sso:<username>. The total length cannot exceed 64 characters.
+   * - Disabled: Does not pass through the SourceIdentity.
+   * 
+   * @example
+   * Disabled
+   */
+  sourceIdentityPassing?: string;
+  static names(): { [key: string]: string } {
+    return {
+      sourceIdentityPassing: 'SourceIdentityPassing',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      sourceIdentityPassing: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetAttributePassingSettingResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The attribute passing settings.
+   */
+  attributePassingSetting?: GetAttributePassingSettingResponseBodyAttributePassingSetting;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * F6F90F3D-4502-5877-B80B-97476F6AE2CC
+   */
+  requestId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      attributePassingSetting: 'AttributePassingSetting',
+      requestId: 'RequestId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      attributePassingSetting: GetAttributePassingSettingResponseBodyAttributePassingSetting,
+      requestId: 'string',
+    };
+  }
+
+  validate() {
+    if(this.attributePassingSetting && typeof (this.attributePassingSetting as any).validate === 'function') {
+      (this.attributePassingSetting as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetDirectoryRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDirectoryRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the directory.
+   * The directory ID.
    * 
    * @example
    * d-00fc2p61****

package/src/models/GetDirectoryResponseBody.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class GetDirectoryResponseBodyDirectory extends $dara.Model {
   /**
    * @remarks
-   * The time when the directory was created.
+   * The time when the directory was created. The time is in UTC and follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ssZ format.
    * 
    * @example
    * 2021-06-30T08:35:26Z
@@ -13,7 +13,7 @@ export class GetDirectoryResponseBodyDirectory extends $dara.Model {
   createTime?: string;
   /**
    * @remarks
-   * The ID of the directory.
+   * The directory ID.
    * 
    * @example
    * d-00fc2p61****
@@ -29,7 +29,7 @@ export class GetDirectoryResponseBodyDirectory extends $dara.Model {
   directoryName?: string;
   /**
    * @remarks
-   * The region ID of the directory.
+   * The ID of the region where the directory is located.
    * 
    * @example
    * cn-shanghai
@@ -37,7 +37,7 @@ export class GetDirectoryResponseBodyDirectory extends $dara.Model {
   region?: string;
   /**
    * @remarks
-   * The time when the directory was modified.
+   * The time when the directory was updated. The time is in UTC and follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ssZ format.
    * 
    * @example
    * 2021-10-25T07:18:46Z
@@ -75,7 +75,7 @@ export class GetDirectoryResponseBodyDirectory extends $dara.Model {
 export class GetDirectoryResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The information about the directory.
+   * The directory information.
    */
   directory?: GetDirectoryResponseBodyDirectory;
   /**

package/src/models/GetTaskResponseBody.ts

@@ -21,7 +21,7 @@ export class GetTaskResponseBodyTask extends $dara.Model {
   accessConfigurationName?: string;
   /**
    * @remarks
-   * The end time of the task.
+   * The end time of the task. The time is in UTC and follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ssZ format.
    * 
    * @example
    * 2021-11-05T02:58:08Z
@@ -29,15 +29,18 @@ export class GetTaskResponseBodyTask extends $dara.Model {
   endTime?: string;
   /**
    * @remarks
-   * The cause of the task failure.
+   * The reason why the task failed.
    * 
-   * >  This parameter is returned only when the value of `Status` is `Failed`.
+   * > This parameter is returned only when `Status` is `Failed`.
    * 
    * @example
    * No Permission.
    */
   failureReason?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the target belongs.
+   * 
    * @example
    * 17xxxxxxxxxxxx73
    */
@@ -60,10 +63,10 @@ export class GetTaskResponseBodyTask extends $dara.Model {
   principalName?: string;
   /**
    * @remarks
-   * The type of the CloudSSO identity. Valid values:
+   * The CloudSSO identity type. Valid values:
    * 
-   * *   User
-   * *   Group
+   * - User: user.
+   * - Group: user group.
    * 
    * @example
    * User
@@ -71,7 +74,7 @@ export class GetTaskResponseBodyTask extends $dara.Model {
   principalType?: string;
   /**
    * @remarks
-   * The start time of the task.
+   * The start time of the task. The time is in UTC and follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ssZ format.
    * 
    * @example
    * 2021-11-05T02:58:07Z
@@ -81,9 +84,9 @@ export class GetTaskResponseBodyTask extends $dara.Model {
    * @remarks
    * The task status. Valid values:
    * 
-   * *   InProgress: The task is running.
-   * *   Success: The task is successful.
-   * *   Failed: The task failed.
+   * - InProgress: The task is in progress.
+   * - Success: The task succeeded.
+   * - Failed: The task failed.
    * 
    * @example
    * Success
@@ -91,7 +94,7 @@ export class GetTaskResponseBodyTask extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The ID of the task object.
+   * The ID of the task target.
    * 
    * @example
    * 114240524784****
@@ -99,7 +102,7 @@ export class GetTaskResponseBodyTask extends $dara.Model {
   targetId?: string;
   /**
    * @remarks
-   * The name of the task object.
+   * The name of the task target.
    * 
    * @example
    * dev-test
@@ -107,17 +110,17 @@ export class GetTaskResponseBodyTask extends $dara.Model {
   targetName?: string;
   /**
    * @remarks
-   * The path ID of the task object in the resource directory.
+   * The path ID of the task target in the resource directory.
    */
   targetPath?: string;
   /**
    * @remarks
-   * The path name of the task object in the resource directory.
+   * The path name of the task target in the resource directory.
    */
   targetPathName?: string;
   /**
    * @remarks
-   * The type of the task object. The value is fixed as RD-Account, which indicates the accounts in the resource directory.
+   * The task target type. Valid values: RD-Account, which indicates that the task target is an account in a resource directory.
    * 
    * @example
    * RD-Account
@@ -135,10 +138,10 @@ export class GetTaskResponseBodyTask extends $dara.Model {
    * @remarks
    * The task type. Valid values:
    * 
-   * *   ProvisionAccessConfiguration: An access configuration is provisioned.
-   * *   DeprovisionAccessConfiguration: An access configuration is de-provisioned.
-   * *   CreateAccessAssignment: Access permissions on an account in the resource directory are assigned.
-   * *   DeleteAccessAssignment: Access permissions on an account in the resource directory are removed.
+   * - ProvisionAccessConfiguration: Deploys the access configuration.
+   * - DeprovisionAccessConfiguration: Removes the access configuration deployment.
+   * - CreateAccessAssignment: Grants authorization to an account in a resource directory.
+   * - DeleteAccessAssignment: Revokes authorization from an account in a resource directory.
    * 
    * @example
    * DeleteAccessAssignment

package/src/models/ListAccessAssignmentsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListAccessAssignmentsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the access configuration. The ID can be used to filter access permissions.
+   * The ID of the access configuration. This parameter is used as a filter condition for the query.
    * 
    * @example
    * ac-00jhtfl8thteu6uj****
@@ -13,7 +13,7 @@ export class ListAccessAssignmentsRequest extends $dara.Model {
   accessConfigurationId?: string;
   /**
    * @remarks
-   * The directory ID.
+   * The ID of the directory.
    * 
    * @example
    * d-00fc2p61****
@@ -21,7 +21,7 @@ export class ListAccessAssignmentsRequest extends $dara.Model {
   directoryId?: string;
   /**
    * @remarks
-   * The maximum number of entries per page.
+   * The maximum number of entries to return on each page.
    * 
    * Valid values: 1 to 20.
    * 
@@ -33,28 +33,30 @@ export class ListAccessAssignmentsRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token that is used in the next request to retrieve a new page of results. If this is your first time to call this operation, you do not need to specify the `NextToken` parameter.
+   * The token for the next page of query results. You do not need to specify `NextToken` when you call this operation for the first time.
    * 
-   * When you call this operation for the first time, if the total number of entries to return exceeds the value of `MaxResults`, the entries are truncated. Only the entries that match the value of `MaxResults` are returned, and the excess entries are not returned. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.
+   * When you call this operation for the first time, if the total number of returned entries exceeds the value of `MaxResults`, the returned entries are truncated. Only the number of entries specified by `MaxResults` is returned, the `IsTruncated` parameter is set to `true`, and a `NextToken` value is returned. You can use the returned `NextToken` value to call this operation again to query the truncated entries while keeping other request parameters unchanged. You can repeat this process until `IsTruncated` is set to `false`, which indicates that all entries are returned.
    * 
    * @example
    * K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the authorization target belongs.
+   * 
    * @example
    * 114240524784****
    */
   originTargetId?: string;
   /**
    * @remarks
-   * The ID of the CloudSSO identity. The ID can be used to filter access permissions.
+   * The ID of the CloudSSO identity, which is used as a filter condition for the query. Details:
    * 
-   * - If you set `PrincipalType` to User, set `PrincipalId` to the ID of the CloudSSO user.
+   * - If `PrincipalType` is set to User, `PrincipalId` is the ID of the CloudSSO user.
+   * - If `PrincipalType` is set to Group, `PrincipalId` is the ID of the CloudSSO group.
    * 
-   * - If you set `PrincipalType` to Group, set `PrincipalId` to the ID of the CloudSSO group.
-   * 
-   * > You can use the type to filter access permissions only if you specify both PrincipalId and `PrincipalType`.\\`\\`
+   * > You must specify both `PrincipalId` and `PrincipalType` for the filter condition to take effect.
    * 
    * @example
    * u-00q8wbq42wiltcrk****
@@ -62,13 +64,12 @@ export class ListAccessAssignmentsRequest extends $dara.Model {
   principalId?: string;
   /**
    * @remarks
-   * The type of the CloudSSO identity. The type can be used to filter access permissions. Valid values:
-   * 
-   * - User
+   * The type of the CloudSSO identity, which is used as a filter condition for the query. Valid values:
    * 
-   * - Group
+   * - User: user.
+   * - Group: group.
    * 
-   * > You can use the type to filter access permissions only if you specify both PrincipalId and `PrincipalType`.\\`\\`
+   * > You must specify both `PrincipalId` and `PrincipalType` for the filter condition to take effect.
    * 
    * @example
    * User
@@ -76,9 +77,9 @@ export class ListAccessAssignmentsRequest extends $dara.Model {
   principalType?: string;
   /**
    * @remarks
-   * The ID of the task object. The ID can be used to filter access permissions.
+   * The ID of the task target, which is used as a filter condition for the query.
    * 
-   * > You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.
+   * > You must specify both `TargetId` and `TargetType` for the filter condition to take effect.
    * 
    * @example
    * 114240524784****
@@ -86,11 +87,12 @@ export class ListAccessAssignmentsRequest extends $dara.Model {
   targetId?: string;
   /**
    * @remarks
-   * The type of the task object. The type can be used to filter access permissions.
+   * The type of the task target, which is used as a filter condition for the query.
    * 
-   * Set the value to RD-Account, which specifies the accounts in the resource directory.
+   * Valid values:
+   * - RD-Account: The task target is an account in a resource directory.
    * 
-   * > You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.
+   * > You must specify both `TargetId` and `TargetType` for the filter condition to take effect.
    * 
    * @example
    * RD-Account

package/src/models/ListAccessAssignmentsResponseBody.ts

@@ -21,13 +21,16 @@ export class ListAccessAssignmentsResponseBodyAccessAssignments extends $dara.Mo
   accessConfigurationName?: string;
   /**
    * @remarks
-   * The time when the access permissions were assigned.
+   * The time when the access assignment was successful. The time follows the RFC 3339 standard and is displayed in UTC in the YYYY-MM-DDTHH:mm:ssZ format.
    * 
    * @example
    * 2021-11-04T10:03:08Z
    */
   createTime?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the authorization target belongs.
+   * 
    * @example
    * 114240524784****
    */
@@ -52,9 +55,8 @@ export class ListAccessAssignmentsResponseBodyAccessAssignments extends $dara.Mo
    * @remarks
    * The type of the CloudSSO identity. Valid values:
    * 
-   * - User
-   * 
-   * - Group
+   * - User: user.
+   * - Group: group.
    * 
    * @example
    * User
@@ -62,7 +64,7 @@ export class ListAccessAssignmentsResponseBodyAccessAssignments extends $dara.Mo
   principalType?: string;
   /**
    * @remarks
-   * The ID of the task object.
+   * The ID of the task target.
    * 
    * @example
    * 114240524784****
@@ -70,7 +72,7 @@ export class ListAccessAssignmentsResponseBodyAccessAssignments extends $dara.Mo
   targetId?: string;
   /**
    * @remarks
-   * The name of the task object.
+   * The name of the task target.
    * 
    * @example
    * dev-test
@@ -78,19 +80,20 @@ export class ListAccessAssignmentsResponseBodyAccessAssignments extends $dara.Mo
   targetName?: string;
   /**
    * @remarks
-   * The path ID of the task object in the resource directory.
+   * The path ID of the task target in the resource directory.
    */
   targetPath?: string;
   /**
    * @remarks
-   * The path name of the task object in the resource directory.
+   * The path name of the task target in the resource directory.
    */
   targetPathName?: string;
   /**
    * @remarks
-   * The type of the task object.
+   * The type of the task target.
    * 
-   * The value is fixed as RD-Account, which indicates the accounts in the resource directory.
+   * Valid values:
+   * - RD-Account: The task target is an account in a resource directory.
    * 
    * @example
    * RD-Account
@@ -142,16 +145,15 @@ export class ListAccessAssignmentsResponseBodyAccessAssignments extends $dara.Mo
 export class ListAccessAssignmentsResponseBody extends $dara.Model {
   /**
    * @remarks
-   * The access permissions that are assigned.
+   * The list of access assignments.
    */
   accessAssignments?: ListAccessAssignmentsResponseBodyAccessAssignments[];
   /**
    * @remarks
-   * Indicates whether the queried entries are truncated. Valid values:
-   * 
-   * - true
+   * Indicates whether the returned result is truncated. Valid values:
    * 
-   * - false
+   * - true: The result is truncated.
+   * - false: The result is not truncated.
    * 
    * @example
    * false
@@ -159,7 +161,7 @@ export class ListAccessAssignmentsResponseBody extends $dara.Model {
   isTruncated?: boolean;
   /**
    * @remarks
-   * The maximum number of entries returned per page.
+   * The maximum number of entries returned on each page.
    * 
    * @example
    * 10
@@ -167,9 +169,9 @@ export class ListAccessAssignmentsResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results.
+   * The token for the next page of query results.
    * 
-   * > This parameter is returned only when the value of IsTruncated is `true`.\\`\\`
+   * > This parameter is returned only when `IsTruncated` is set to `true`.
    * 
    * @example
    * K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
@@ -177,7 +179,7 @@ export class ListAccessAssignmentsResponseBody extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * 66898413-EB80-556D-9429-06FE3548F672
@@ -185,7 +187,7 @@ export class ListAccessAssignmentsResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries that meet the filter conditions specified in the request parameters.
    * 
    * @example
    * 1

package/src/models/ListAccessConfigurationProvisioningsRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListAccessConfigurationProvisioningsRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the access configuration. The ID can be used to filter access permissions.
+   * The access configuration ID used as a filter condition for the query.
    * 
    * @example
    * ac-00ccule7tadaijxc****
@@ -13,7 +13,7 @@ export class ListAccessConfigurationProvisioningsRequest extends $dara.Model {
   accessConfigurationId?: string;
   /**
    * @remarks
-   * The ID of the directory.
+   * The directory ID.
    * 
    * @example
    * d-00fc2p61****
@@ -21,7 +21,7 @@ export class ListAccessConfigurationProvisioningsRequest extends $dara.Model {
   directoryId?: string;
   /**
    * @remarks
-   * The maximum number of entries per page.
+   * The maximum number of entries to return on each page.
    * 
    * Valid values: 1 to 20.
    * 
@@ -33,28 +33,29 @@ export class ListAccessConfigurationProvisioningsRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. If this is your first time to call this operation, you do not need to specify the `NextToken` parameter.
+   * The token used to return the next page of query results. You do not need to specify NextToken when you call this operation for the first time.
    * 
-   * When you call this operation for the first time, if the total number of entries to return exceeds the value of `MaxResults`, the entries are truncated. Only the entries that match the value of `MaxResults` are returned, and the excess entries are not returned. In this case, the value of the response parameter `IsTruncated` is `true`, and `NextToken` is returned. In the next call, you can use the value of `NextToken` and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of `IsTruncated` becomes `false`. This way, all entries are returned.
+   * When you call this operation for the first time, if the total number of returned entries exceeds the value of MaxResults, the returned results are truncated. Only the number of entries specified by MaxResults is returned, the IsTruncated parameter is set to true, and a NextToken is returned. You can use the returned NextToken to call this operation again to query the truncated entries while keeping other request parameters unchanged. You can repeat this process until IsTruncated is set to false, which indicates that all entries are returned.
    * 
    * @example
    * K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
    */
   nextToken?: string;
   /**
+   * @remarks
+   * The Alibaba Cloud account ID of the provisioning target.
+   * 
    * @example
    * 114240524784****
    */
   originTargetId?: string;
   /**
    * @remarks
-   * The status of the access configuration. The value can be used to filter accounts. Valid values:
-   * 
-   * - Provisioned: The access configuration is provisioned.
-   * 
-   * - ReprovisionRequired: The access configuration needs to be re-provisioned.
+   * The provisioning status used as a filter condition for the query. Valid values:
    * 
-   * - DeprovisionFailed: The access configuration failed to be provisioned.
+   * - Provisioned: The provisioning succeeded.
+   * - ReprovisionRequired: Reprovisioning is required.
+   * - DeprovisionFailed: The provisioning failed.
    * 
    * @example
    * Provisioned
@@ -62,9 +63,9 @@ export class ListAccessConfigurationProvisioningsRequest extends $dara.Model {
   provisioningStatus?: string;
   /**
    * @remarks
-   * The ID of the task object. The ID can be used to filter access permissions.
+   * The target ID used as a filter condition for the query.
    * 
-   * > You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.
+   * > You must specify both TargetId and TargetType for them to take effect as filter conditions.
    * 
    * @example
    * 114240524784****
@@ -72,11 +73,12 @@ export class ListAccessConfigurationProvisioningsRequest extends $dara.Model {
   targetId?: string;
   /**
    * @remarks
-   * The type of the task object. The type can be used to filter access permissions.
+   * The target type used as a filter condition for the query.
    * 
-   * Set the value to RD-Account, which specifies the accounts in the resource directory.
+   * Valid values:
+   * - RD-Account: The target is an account in a resource directory.
    * 
-   * > You can use the type to filter access permissions only if you specify both `TargetId` and `TargetType`.
+   * > You must specify both TargetId and TargetType for them to take effect as filter conditions.
    * 
    * @example
    * RD-Account