@alicloud/cloudsso20210515 1.6.0 → 1.7.0

package/src/models/ListTagResourcesRequest.ts

@@ -0,0 +1,126 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListTagResourcesRequestTag extends $dara.Model {
+  /**
+   * @remarks
+   * The tag key.
+   * 
+   * > - - The tag key cannot be an empty string.
+   * 
+   * @example
+   * key
+   */
+  key?: string;
+  /**
+   * @remarks
+   * The tag value.
+   * 
+   * @example
+   * value
+   */
+  value?: string;
+  static names(): { [key: string]: string } {
+    return {
+      key: 'Key',
+      value: 'Value',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      key: 'string',
+      value: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListTagResourcesRequest extends $dara.Model {
+  /**
+   * @remarks
+   * The directory ID.
+   * 
+   * @example
+   * d-00fc2p61****
+   */
+  directoryId?: string;
+  /**
+   * @remarks
+   * The token that is used to retrieve the next page of results when the response is truncated.
+   * 
+   * @example
+   * K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The list of resource IDs. You can specify up to 50 resource IDs in a single call.
+   * > 
+   * > - Supported resource types include users and access configurations:
+   * > - - If the resource type is user, specify the user ID.
+   * > - - If the resource type is access configuration, specify the access configuration ID.
+   * 
+   * <notice>If the DirectoryId parameter is not specified, you must add the prefix "${DirectoryId}_" to the resource ID.</notice>
+   */
+  resourceId?: string[];
+  /**
+   * @remarks
+   * The resource type. Valid values:
+   * - user: The resource is a user.
+   * - accessConfiguration: The resource is an access configuration.
+   * 
+   * This parameter is required.
+   * 
+   * @example
+   * accessConfiguration
+   */
+  resourceType?: string;
+  /**
+   * @remarks
+   * The list of tags. You can specify up to 20 tags in a single call.
+   */
+  tag?: ListTagResourcesRequestTag[];
+  static names(): { [key: string]: string } {
+    return {
+      directoryId: 'DirectoryId',
+      nextToken: 'NextToken',
+      resourceId: 'ResourceId',
+      resourceType: 'ResourceType',
+      tag: 'Tag',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      directoryId: 'string',
+      nextToken: 'string',
+      resourceId: { 'type': 'array', 'itemType': 'string' },
+      resourceType: 'string',
+      tag: { 'type': 'array', 'itemType': ListTagResourcesRequestTag },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.resourceId)) {
+      $dara.Model.validateArray(this.resourceId);
+    }
+    if(Array.isArray(this.tag)) {
+      $dara.Model.validateArray(this.tag);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListTagResourcesResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { ListTagResourcesResponseBody } from "./ListTagResourcesResponseBody";
+
+
+export class ListTagResourcesResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: ListTagResourcesResponseBody;
+  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: ListTagResourcesResponseBody,
+    };
+  }
+
+  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/ListTagResourcesResponseBody.ts

@@ -0,0 +1,116 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class ListTagResourcesResponseBodyTagResources extends $dara.Model {
+  /**
+   * @remarks
+   * The resource ID.
+   * 
+   * @example
+   * u-00a542dx4fp21i7uig48
+   */
+  resourceId?: string;
+  /**
+   * @remarks
+   * The resource type.
+   * 
+   * @example
+   * user
+   */
+  resourceType?: string;
+  /**
+   * @remarks
+   * The tag key.
+   * 
+   * @example
+   * key
+   */
+  tagKey?: string;
+  /**
+   * @remarks
+   * The tag value.
+   * 
+   * @example
+   * value
+   */
+  tagValue?: string;
+  static names(): { [key: string]: string } {
+    return {
+      resourceId: 'ResourceId',
+      resourceType: 'ResourceType',
+      tagKey: 'TagKey',
+      tagValue: 'TagValue',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      resourceId: 'string',
+      resourceType: 'string',
+      tagKey: 'string',
+      tagValue: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListTagResourcesResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The token that is used to retrieve the next page of query results.
+   * 
+   * If NextToken is empty, it indicates that the results are not truncated.
+   * 
+   * @example
+   * K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
+   */
+  nextToken?: string;
+  /**
+   * @remarks
+   * The request ID.
+   * 
+   * @example
+   * 20E9650E-EC23-593E-933F-EA0D280D040C
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * The list of tag-resource relationships.
+   */
+  tagResources?: ListTagResourcesResponseBodyTagResources[];
+  static names(): { [key: string]: string } {
+    return {
+      nextToken: 'NextToken',
+      requestId: 'RequestId',
+      tagResources: 'TagResources',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      nextToken: 'string',
+      requestId: 'string',
+      tagResources: { 'type': 'array', 'itemType': ListTagResourcesResponseBodyTagResources },
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.tagResources)) {
+      $dara.Model.validateArray(this.tagResources);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/ListTasksRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ListTasksRequest 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****
@@ -23,11 +23,11 @@ export class ListTasksRequest extends $dara.Model {
    * @remarks
    * The filter condition.
    * 
-   * The condition is not case-sensitive. The condition must be in the StartTime ge YYYY-MM-DDTHH:mm:SSZ format. You must set YYYY-MM-DDTHH:mm:SSZ to a value that is no more than 7 days from the current time. ge indicates Greater Than or Equals.
+   * Format: <Attribute> <Operator> <Value>. The format is not case-sensitive. <Attribute> only supports StartTime. <Operator> only supports ge (greater than or equal to). <Value> must be in the YYYY-MM-DDTHH:mm:ssZ format and can only be a time within the last 7 days.
    * 
-   * For example, if you set the Filter parameter to StartTime ge 2021-03-15T01:12:23Z, the operation queries the tasks from 2021-03-15T01:12:23 GMT.
+   * Example: Filter = "StartTime ge 2021-03-15T01:12:23Z". This example queries the list of tasks starting from 2021-03-15T01:12:23Z.
    * 
-   * > If you do not specify this parameter, the operation queries the tasks within the previous 24 hours by default.
+   * > If you do not specify this parameter, the list of tasks created within the last 24 hours is returned by default.
    * 
    * @example
    * StartTime ge 2021-03-15T01:12:23Z
@@ -35,7 +35,7 @@ export class ListTasksRequest extends $dara.Model {
   filter?: string;
   /**
    * @remarks
-   * The maximum number of entries per page.
+   * The maximum number of entries to return on each page.
    * 
    * Valid values: 1 to 20.
    * 
@@ -47,9 +47,9 @@ export class ListTasksRequest 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 used to return the next page of the 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 data is truncated. Only the number of entries specified by MaxResults is returned, the IsTruncated response parameter is set to true, and a NextToken value is returned. You can use the returned NextToken value to call this operation again while keeping other request parameters unchanged to query the truncated data. You can repeat this process until IsTruncated is set to false, which indicates that all data is returned.
    * 
    * @example
    * K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
@@ -57,13 +57,12 @@ export class ListTasksRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The ID of the CloudSSO identity. The ID can be used to filter access permissions.
+   * The ID of the CloudSSO identity. This parameter 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`.
+   * > PrincipalId and PrincipalType must be specified at the same time to serve as a valid filter condition.
    * 
    * @example
    * u-00q8wbq42wiltcrk****
@@ -71,13 +70,12 @@ export class ListTasksRequest 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. This parameter is used as a filter condition for the query. Valid values:
    * 
-   * - Group
+   * - User: The CloudSSO user.
+   * - Group: The CloudSSO group.
    * 
-   * > You can use the type to filter access permissions only if you specify both `PrincipalId` and `PrincipalType`.
+   * > PrincipalId and PrincipalType must be specified at the same time to serve as a valid filter condition.
    * 
    * @example
    * User
@@ -85,12 +83,10 @@ export class ListTasksRequest extends $dara.Model {
   principalType?: string;
   /**
    * @remarks
-   * The ID of the task. The ID can be used to filter tasks. Valid values:
+   * The status of the task. This parameter is used as a filter condition for the query. Valid values:
    * 
    * - InProgress: The task is running.
-   * 
-   * - Success: The task is successful.
-   * 
+   * - Success: The task succeeded.
    * - Failed: The task failed.
    * 
    * @example
@@ -99,9 +95,9 @@ export class ListTasksRequest extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The ID of the task object. The ID can be used to filter access permissions.
+   * The ID of the task target. This parameter 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`.
+   * > TargetId and TargetType must be specified at the same time to serve as a valid filter condition.
    * 
    * @example
    * 114240524784****
@@ -109,11 +105,11 @@ export class ListTasksRequest 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. This parameter is used as a filter condition for the query. Valid values:
    * 
-   * Set the value to RD-Account, which specifies the accounts in the resource directory.
+   * - 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`.
+   * > TargetId and TargetType must be specified at the same time to serve as a valid filter condition.
    * 
    * @example
    * RD-Account
@@ -121,15 +117,12 @@ export class ListTasksRequest extends $dara.Model {
   targetType?: string;
   /**
    * @remarks
-   * The type of the task. The type can be used to filter tasks. 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.
+   * The type of the node. This parameter is used as a filter condition for the query. Valid values:
    * 
-   * - DeleteAccessAssignment: Access permissions on an account in the resource directory are removed.
+   * - ProvisionAccessConfiguration: Access configuration deployment.
+   * - DeprovisionAccessConfiguration: Removes access configuration provisioning.
+   * - CreateAccessAssignment: Grants authorization to an account in a resource directory.
+   * - DeleteAccessAssignment: Removes authorization from an account in a resource directory.
    * 
    * @example
    * CreateAccessAssignment

package/src/models/ListTasksResponseBody.ts

@@ -21,7 +21,7 @@ export class ListTasksResponseBodyTasks extends $dara.Model {
   accessConfigurationName?: string;
   /**
    * @remarks
-   * The end time of the task.
+   * The end time of the task. The time is displayed in UTC and follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ssZ format.
    * 
    * @example
    * 2021-11-09T05:50:50Z
@@ -29,15 +29,18 @@ export class ListTasksResponseBodyTasks 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 if Status is set to Failed.
    * 
    * @example
    * No Permission.
    */
   failureReason?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the authorization target belongs.
+   * 
    * @example
    * 114240524784****
    */
@@ -62,9 +65,8 @@ export class ListTasksResponseBodyTasks extends $dara.Model {
    * @remarks
    * The type of the CloudSSO identity. Valid values:
    * 
-   * - User
-   * 
-   * - Group
+   * - User: The CloudSSO user.
+   * - Group: The CloudSSO group.
    * 
    * @example
    * User
@@ -72,7 +74,7 @@ export class ListTasksResponseBodyTasks extends $dara.Model {
   principalType?: string;
   /**
    * @remarks
-   * The start time of the task.
+   * The start time of the task. The time is displayed in UTC and follows the RFC 3339 standard in the YYYY-MM-DDTHH:mm:ssZ format.
    * 
    * @example
    * 2021-11-09T05:50:50Z
@@ -80,12 +82,10 @@ export class ListTasksResponseBodyTasks extends $dara.Model {
   startTime?: string;
   /**
    * @remarks
-   * The task status. Valid values:
+   * The status of the task. Valid values:
    * 
    * - InProgress: The task is running.
-   * 
-   * - Success: The task is successful.
-   * 
+   * - Success: The task succeeded.
    * - Failed: The task failed.
    * 
    * @example
@@ -94,7 +94,7 @@ export class ListTasksResponseBodyTasks extends $dara.Model {
   status?: string;
   /**
    * @remarks
-   * The ID of the task object.
+   * The ID of the task target.
    * 
    * @example
    * 114240524784****
@@ -102,7 +102,7 @@ export class ListTasksResponseBodyTasks extends $dara.Model {
   targetId?: string;
   /**
    * @remarks
-   * The name of the task object.
+   * The name of the task target.
    * 
    * @example
    * dev-test
@@ -110,19 +110,21 @@ export class ListTasksResponseBodyTasks 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 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
@@ -130,7 +132,7 @@ export class ListTasksResponseBodyTasks extends $dara.Model {
   targetType?: string;
   /**
    * @remarks
-   * The ID of the job.
+   * The ID of the task.
    * 
    * @example
    * t-sh5k4gesm6twlrqb****
@@ -138,15 +140,12 @@ export class ListTasksResponseBodyTasks extends $dara.Model {
   taskId?: string;
   /**
    * @remarks
-   * The task type. Valid values:
-   * 
-   * - ProvisionAccessConfiguration: An access configuration is provisioned.
-   * 
-   * - DeprovisionAccessConfiguration: An access configuration is de-provisioned.
+   * The type of the node. Valid values:
    * 
-   * - 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: Access configuration deployment.
+   * - DeprovisionAccessConfiguration: Removes access configuration provisioning.
+   * - CreateAccessAssignment: Grants authorization to an account in a resource directory.
+   * - DeleteAccessAssignment: Removes authorization from an account in a resource directory.
    * 
    * @example
    * CreateAccessAssignment
@@ -208,11 +207,10 @@ export class ListTasksResponseBodyTasks extends $dara.Model {
 export class ListTasksResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the queried entries are truncated. Valid values:
-   * 
-   * - true
+   * Indicates whether the returned results are truncated. Valid values:
    * 
-   * - false
+   * - true: The returned results are truncated.
+   * - false: The returned results are not truncated.
    * 
    * @example
    * false
@@ -220,7 +218,7 @@ export class ListTasksResponseBody 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
@@ -228,9 +226,9 @@ export class ListTasksResponseBody 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 used to return the next page of the query results.
    * 
-   * > This parameter is returned only when the value of `IsTruncated` is `true`.
+   * > This parameter is returned only if IsTruncated is set to true.
    * 
    * @example
    * K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
@@ -238,7 +236,7 @@ export class ListTasksResponseBody extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The request ID.
+   * The ID of the request.
    * 
    * @example
    * C0DA2DFC-EB18-59EF-BD82-C30862EBA3A3
@@ -246,12 +244,12 @@ export class ListTasksResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The tasks.
+   * The list of tasks.
    */
   tasks?: ListTasksResponseBodyTasks[];
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries that meet the conditional request parameter.
    * 
    * @example
    * 1

package/src/models/ProvisionAccessConfigurationRequest.ts

@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
 export class ProvisionAccessConfigurationRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the access configuration.
+   * The access configuration ID.
    * 
    * @example
    * ac-00jhtfl8thteu6uj****
@@ -20,13 +20,16 @@ export class ProvisionAccessConfigurationRequest extends $dara.Model {
    */
   directoryId?: string;
   /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the deployment target belongs.
+   * 
    * @example
    * 114240524784****
    */
   originTargetId?: string;
   /**
    * @remarks
-   * The ID of the task object.
+   * The ID of the task target.
    * 
    * @example
    * 114240524784****
@@ -34,7 +37,8 @@ export class ProvisionAccessConfigurationRequest extends $dara.Model {
   targetId?: string;
   /**
    * @remarks
-   * The type of the task object. Set the value to RD-Account, which specifies the accounts in the resource directory.
+   * The target type of the task. Valid values:
+   * - RD-Account: The task target is an account in a resource directory.
    * 
    * @example
    * RD-Account