@alicloud/cloudsso20210515 1.5.2 → 1.5.3

package/src/models/ListUserProvisioningsResponseBody.ts

@@ -1,15 +1,216 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { ListUserProvisioningsResponseBodyUserProvisionings } from "./ListUserProvisioningsResponseBodyUserProvisionings";
 
 
+export class ListUserProvisioningsResponseBodyUserProvisionings extends $dara.Model {
+  /**
+   * @remarks
+   * The creation time.
+   * 
+   * @example
+   * 2022-11-28T03:55:42Z
+   */
+  createTime?: string;
+  /**
+   * @remarks
+   * The deletion policy. The policy is used to manage synchronized users when you delete the RAM user provisioning. Valid values:
+   * 
+   * - Delete: When you delete the RAM user provisioning, the system deletes the synchronized users.
+   * 
+   * - Keep: When you delete the RAM user provisioning, the system retains the synchronized users.
+   * 
+   * @example
+   * Delete
+   */
+  deletionStrategy?: string;
+  /**
+   * @remarks
+   * The description.
+   * 
+   * @example
+   * this is a user provisioning.
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The ID of the resource directory.
+   * 
+   * @example
+   * d-003qew84****
+   */
+  directoryId?: string;
+  /**
+   * @remarks
+   * The conflict handling policy. The policy is used when a RAM user has the same username as the CloudSSO user who is synchronized to RAM. Valid values:
+   * 
+   * - KeepBoth: When a CloudSSO user is synchronized to RAM, if a RAM user who has the same username as the CloudSSO user exists, the system creates a RAM user whose username is the username of the CloudSSO user plus the suffix `_sso`.
+   * 
+   * - TakeOver: When a CloudSSO user is synchronized to RAM, if a RAM user who has the same username as the CloudSSO user exists, the system replaces the RAM user with the CloudSSO user.
+   * 
+   * @example
+   * KeepBoth
+   */
+  duplicationStrategy?: string;
+  /**
+   * @remarks
+   * The ID of the Alibaba Cloud account to which the resource directory belongs.
+   * 
+   * @example
+   * 1639738******
+   */
+  ownerPk?: string;
+  /**
+   * @remarks
+   * The identity ID of the RAM user provisioning. Valid values:
+   * 
+   * - If `Group` is returned for the `PrincipalType` parameter, the value of this parameter is the ID of a CloudSSO user group (g-\\*\\*\\*\\*\\*\\*\\*\\*).
+   * 
+   * - If `User` is returned for the `PrincipalType` parameter, the value of this parameter is the ID of a CloudSSO user (u-\\*\\*\\*\\*\\*\\*\\*\\*).
+   * 
+   * @example
+   * g-02ha881d*****
+   */
+  principalId?: string;
+  /**
+   * @remarks
+   * The identity name of the RAM user provisioning. Valid values:
+   * 
+   * - If `Group` is returned for the `PrincipalType` parameter, the value of this parameter is the name of a CloudSSO user group.
+   * 
+   * - If `User` is returned for the `PrincipalType` parameter, the value of this parameter is the name of a CloudSSO user.
+   * 
+   * @example
+   * testGroupName
+   */
+  principalName?: string;
+  /**
+   * @remarks
+   * The identity type of the RAM user provisioning. Valid values:
+   * 
+   * - User: The identity of the RAM user provisioning is a CloudSSO user.
+   * 
+   * - Group: The identity of the RAM user provisioning is a CloudSSO user group.
+   * 
+   * @example
+   * Group
+   */
+  principalType?: string;
+  /**
+   * @remarks
+   * The status of the RAM user provisioning. Valid values:
+   * 
+   * - Enabled
+   * 
+   * - Disabled
+   * 
+   * @example
+   * Enabled
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The ID of the object for which you create the RAM user provisioning. The value is fixed as the ID of the member in the resource directory.
+   * 
+   * @example
+   * 1743382******
+   */
+  targetId?: string;
+  /**
+   * @remarks
+   * The object for which you create the RAM user provisioning. The value is fixed as `RD-Account`.
+   * 
+   * @example
+   * testRdMember
+   */
+  targetName?: string;
+  /**
+   * @remarks
+   * The path of the resource directory in which you create the RAM user provisioning for the object.
+   */
+  targetPath?: string;
+  /**
+   * @remarks
+   * The object for which you create the RAM user provisioning. The value is fixed as `RD-Account`.
+   * 
+   * @example
+   * RD-Account
+   */
+  targetType?: string;
+  /**
+   * @remarks
+   * The modification time.
+   * 
+   * @example
+   * 2022-11-28T03:55:42Z
+   */
+  updateTime?: string;
+  /**
+   * @remarks
+   * The ID of the RAM user provisioning.
+   * 
+   * @example
+   * up-002axzhapcbz6e63****
+   */
+  userProvisioningId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      createTime: 'CreateTime',
+      deletionStrategy: 'DeletionStrategy',
+      description: 'Description',
+      directoryId: 'DirectoryId',
+      duplicationStrategy: 'DuplicationStrategy',
+      ownerPk: 'OwnerPk',
+      principalId: 'PrincipalId',
+      principalName: 'PrincipalName',
+      principalType: 'PrincipalType',
+      status: 'Status',
+      targetId: 'TargetId',
+      targetName: 'TargetName',
+      targetPath: 'TargetPath',
+      targetType: 'TargetType',
+      updateTime: 'UpdateTime',
+      userProvisioningId: 'UserProvisioningId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      createTime: 'string',
+      deletionStrategy: 'string',
+      description: 'string',
+      directoryId: 'string',
+      duplicationStrategy: 'string',
+      ownerPk: 'string',
+      principalId: 'string',
+      principalName: 'string',
+      principalType: 'string',
+      status: 'string',
+      targetId: 'string',
+      targetName: 'string',
+      targetPath: 'string',
+      targetType: 'string',
+      updateTime: 'string',
+      userProvisioningId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class ListUserProvisioningsResponseBody extends $dara.Model {
   /**
    * @remarks
    * Indicates whether the queried entries are truncated. Valid values:
    * 
-   * *   true
-   * *   false
+   * - true
+   * 
+   * - false
    * 
    * @example
    * true
@@ -31,7 +232,7 @@ export class ListUserProvisioningsResponseBody extends $dara.Model {
    * @remarks
    * The token that is used to initiate the next request.
    * 
-   * >  This parameter is returned only when the `IsTruncated` parameter is set to `true`.
+   * > This parameter is returned only when the `IsTruncated` parameter is set to `true`.
    * 
    * @example
    * 27EbL9j4ZgZjsMZFqbZFgbwQ1VXFU1Khcpx9e2vrW1zwzTBmTGWaM7ixHhRin8SCsxaJdazYVCzeKc2UF2QkyGb83cPhr8ZxrzoaiTd****

package/src/models/ListUsersRequest.ts

@@ -1,12 +1,51 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { ListUsersRequestTags } from "./ListUsersRequestTags";
 
 
+export class ListUsersRequestTags extends $dara.Model {
+  /**
+   * @remarks
+   * The tag key.
+   * 
+   * @example
+   * TestKey
+   */
+  key?: string;
+  /**
+   * @remarks
+   * The tag value.
+   * 
+   * @example
+   * TestValue
+   */
+  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 ListUsersRequest extends $dara.Model {
   /**
    * @remarks
-   * The ID of the resource directory.
+   * The CloudSSO directory ID.
    * 
    * @example
    * d-00fc2p61****
@@ -16,9 +55,11 @@ export class ListUsersRequest extends $dara.Model {
    * @remarks
    * The filter condition.
    * 
-   * You must specify the value in the `<Attribute> <Operator> <Value>` format. The value is not case-sensitive. You can set `<Attribute>` only to `UserName` and `Operator` only to `eq` or `sw`. The value eq indicates Equals, and the value sw indicates Start With.
+   * The format is `<Attribute> <Operator> <Value>`. The filter is not case-sensitive. The `<Attribute>` only supports `UserName`. The `<Operator>` only supports `eq` (equal to) and `sw` (starts with).
    * 
-   * For example, if you set the Filter parameter to UserName sw test, the operation queries the users whose names start with test. If you set the Filter parameter to UserName eq testuser, the operation queries the user whose name is `testuser`.
+   * Examples:
+   * 
+   * If you configure this parameter to `UserName sw test`, the system queries all users whose usernames start with `test`. If you configure this parameter to `UserName eq testuser`, the system queries the user whose username is `testuser`.
    * 
    * @example
    * UserName sw test
@@ -26,7 +67,7 @@ export class ListUsersRequest extends $dara.Model {
   filter?: string;
   /**
    * @remarks
-   * The number of entries per page.
+   * The maximum number of entries to return on each page.
    * 
    * Valid values: 1 to 100.
    * 
@@ -38,9 +79,9 @@ export class ListUsersRequest extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of the `NextToken` parameter.
+   * The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request.
    * 
-   * When you call this operation for the first time, if the total number of entries to return is larger than the value of the `MaxResults` parameter, the entries are truncated. The system returns entries based on the value of the `MaxResults` parameter, and does not return the excess entries. In this case, the value of the response parameter `IsTruncated` is `true`, and the `NextToken` parameter is returned. In the next call, you can use the value of the `NextToken` parameter and maintain the settings of the other request parameters to query the excess entries. You can repeat the call until the value of the `IsTruncated` parameter becomes `false`. This way, all entries are returned.
+   * If the total number of entries exceeds the value of `MaxResults`, the entries are truncated. The system returns the value of `MaxResults` and a `NextToken`. The `IsTruncated` parameter is set to `true`. You can use the returned `NextToken` in the next call to query the remaining entries. Keep the other request parameters unchanged. Repeat this process until the `IsTruncated` parameter is `false`. This indicates that all entries are returned.
    * 
    * @example
    * K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
@@ -48,10 +89,11 @@ export class ListUsersRequest extends $dara.Model {
   nextToken?: string;
   /**
    * @remarks
-   * The type of the user. The parameter can be used to filter users. Valid values:
+   * The user type. This parameter is used as a filter condition. Valid values:
+   * 
+   * - Manual: The user was manually created.
    * 
-   * *   Manual: The user is manually created.
-   * *   Synchronized: The user is synchronized from an external identity provider (IdP).
+   * - Synchronized: The user was synchronized from an external IdP.
    * 
    * @example
    * Manual
@@ -59,15 +101,20 @@ export class ListUsersRequest extends $dara.Model {
   provisionType?: string;
   /**
    * @remarks
-   * The status of the user. The parameter can be used to filter users. Valid values:
+   * The user status. This parameter is used as a filter condition. Valid values:
    * 
-   * *   Enabled: The logon of the user is enabled.
-   * *   Disabled: The logon of the user is disabled.
+   * - Enabled
+   * 
+   * - Disabled
    * 
    * @example
    * Enabled
    */
   status?: string;
+  /**
+   * @remarks
+   * The tags attached to the user.
+   */
   tags?: ListUsersRequestTags[];
   static names(): { [key: string]: string } {
     return {

package/src/models/ListUsersResponseBody.ts

@@ -1,15 +1,253 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { ListUsersResponseBodyUsers } from "./ListUsersResponseBodyUsers";
 
 
+export class ListUsersResponseBodyUsersExternalId extends $dara.Model {
+  /**
+   * @remarks
+   * The identifier of the user in the external IdP.
+   * 
+   * @example
+   * c73******a5fdd5
+   */
+  id?: string;
+  /**
+   * @remarks
+   * The channel for external user synchronization. Currently, only SCIM synchronization is supported.
+   * 
+   * @example
+   * SCIM
+   */
+  issuer?: string;
+  static names(): { [key: string]: string } {
+    return {
+      id: 'Id',
+      issuer: 'Issuer',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      id: 'string',
+      issuer: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class ListUsersResponseBodyUsersTags extends $dara.Model {
+  /**
+   * @remarks
+   * The tag key.
+   * 
+   * @example
+   * TestKey
+   */
+  key?: string;
+  /**
+   * @remarks
+   * The tag value.
+   * 
+   * @example
+   * TestValue
+   */
+  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 ListUsersResponseBodyUsers extends $dara.Model {
+  /**
+   * @remarks
+   * The time when the user was created. The time is in UTC.
+   * 
+   * @example
+   * 2021-06-30T09:20:08Z
+   */
+  createTime?: string;
+  /**
+   * @remarks
+   * The description of the user.
+   * 
+   * @example
+   * This is a user.
+   */
+  description?: string;
+  /**
+   * @remarks
+   * The display name of the user.
+   * 
+   * @example
+   * AliceLee
+   */
+  displayName?: string;
+  /**
+   * @remarks
+   * The email address of the user.
+   * 
+   * @example
+   * AliceLee@example.onmicrosoft.com
+   */
+  email?: string;
+  /**
+   * @remarks
+   * The identifier of the user in an external IdP.
+   */
+  externalId?: ListUsersResponseBodyUsersExternalId;
+  /**
+   * @remarks
+   * The first name of the user.
+   * 
+   * @example
+   * Alice
+   */
+  firstName?: string;
+  /**
+   * @remarks
+   * The last name of the user.
+   * 
+   * @example
+   * Lee
+   */
+  lastName?: string;
+  /**
+   * @remarks
+   * The type of the user. Valid values:
+   * 
+   * - Manual: The user was manually created.
+   * 
+   * - Synchronized: The user was synchronized from an external IdP.
+   * 
+   * @example
+   * Synchronized
+   */
+  provisionType?: string;
+  /**
+   * @remarks
+   * The status of the user. Valid values:
+   * 
+   * - Enabled
+   * 
+   * - Disabled
+   * 
+   * @example
+   * Enabled
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The tags attached to the user.
+   */
+  tags?: ListUsersResponseBodyUsersTags[];
+  /**
+   * @remarks
+   * The time when the user was last modified. The time is in UTC.
+   * 
+   * @example
+   * 2021-06-30T09:20:08Z
+   */
+  updateTime?: string;
+  /**
+   * @remarks
+   * The user ID.
+   * 
+   * @example
+   * u-00bikzkuzbb58luh****
+   */
+  userId?: string;
+  /**
+   * @remarks
+   * The username.
+   * 
+   * @example
+   * AliceLee@example.onmicrosoft.com
+   */
+  userName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      createTime: 'CreateTime',
+      description: 'Description',
+      displayName: 'DisplayName',
+      email: 'Email',
+      externalId: 'ExternalId',
+      firstName: 'FirstName',
+      lastName: 'LastName',
+      provisionType: 'ProvisionType',
+      status: 'Status',
+      tags: 'Tags',
+      updateTime: 'UpdateTime',
+      userId: 'UserId',
+      userName: 'UserName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      createTime: 'string',
+      description: 'string',
+      displayName: 'string',
+      email: 'string',
+      externalId: ListUsersResponseBodyUsersExternalId,
+      firstName: 'string',
+      lastName: 'string',
+      provisionType: 'string',
+      status: 'string',
+      tags: { 'type': 'array', 'itemType': ListUsersResponseBodyUsersTags },
+      updateTime: 'string',
+      userId: 'string',
+      userName: 'string',
+    };
+  }
+
+  validate() {
+    if(this.externalId && typeof (this.externalId as any).validate === 'function') {
+      (this.externalId as any).validate();
+    }
+    if(Array.isArray(this.tags)) {
+      $dara.Model.validateArray(this.tags);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class ListUsersResponseBody extends $dara.Model {
   /**
    * @remarks
-   * Indicates whether the queried entries are truncated. Valid values:
+   * Indicates whether the results are truncated. Valid values:
+   * 
+   * - true
    * 
-   * *   true
-   * *   false
+   * - false
    * 
    * @example
    * false
@@ -17,7 +255,7 @@ export class ListUsersResponseBody extends $dara.Model {
   isTruncated?: boolean;
   /**
    * @remarks
-   * The number of entries per page.
+   * The maximum number of entries returned per page.
    * 
    * @example
    * 10
@@ -25,9 +263,9 @@ export class ListUsersResponseBody extends $dara.Model {
   maxResults?: number;
   /**
    * @remarks
-   * The pagination token that is used in the next request to retrieve a new page of results.
+   * A pagination token. It can be used in the next request to retrieve a new page of results.
    * 
-   * >  This parameter is returned only when the `IsTruncated` parameter is `true`.
+   * > This parameter is returned only when `IsTruncated` is `true`.
    * 
    * @example
    * K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
@@ -43,7 +281,7 @@ export class ListUsersResponseBody extends $dara.Model {
   requestId?: string;
   /**
    * @remarks
-   * The total number of entries returned.
+   * The total number of entries that meet the filter conditions.
    * 
    * @example
    * 2
@@ -51,7 +289,7 @@ export class ListUsersResponseBody extends $dara.Model {
   totalCounts?: number;
   /**
    * @remarks
-   * The users.
+   * The list of users.
    */
   users?: ListUsersResponseBodyUsers[];
   static names(): { [key: string]: string } {