@alicloud/agentcore20260804 2.5.0 → 3.0.0

package/src/models/GetIdentityProviderServiceProviderResponseBody.ts

@@ -0,0 +1,141 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetIdentityProviderServiceProviderResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * 我方 SAML 断言消费地址，配置到外部 IdP。
+   * 
+   * @example
+   * https://sp.example.com/saml/acs
+   */
+  acsUrl?: string;
+  /**
+   * @remarks
+   * 我方 SP 的实体标识，配置到外部 IdP；不是外部 IdP Entity ID。
+   * 
+   * @example
+   * https://sp.example.com/entity
+   */
+  entityId?: string;
+  /**
+   * @remarks
+   * 我方 SP Metadata XML，供外部 IdP 导入；不能作为 IdP XML 提交 SAML 配置。
+   * 
+   * @example
+   * <EntityDescriptor xmlns="urn:oasis:names:tc:SAML:2.0:metadata" entityID="https://sp.example.com/entity"><SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol"><AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://sp.example.com/saml/acs" index="0"/></SPSSODescriptor></EntityDescriptor>
+   */
+  metadataXml?: string;
+  /**
+   * @remarks
+   * 查询参数必填，仅支持精确值 SAML；响应返回 SAML。
+   * 
+   * @example
+   * SAML
+   */
+  protocol?: string;
+  static names(): { [key: string]: string } {
+    return {
+      acsUrl: 'acsUrl',
+      entityId: 'entityId',
+      metadataXml: 'metadataXml',
+      protocol: 'protocol',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      acsUrl: 'string',
+      entityId: 'string',
+      metadataXml: 'string',
+      protocol: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetIdentityProviderServiceProviderResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * 失败时结合 HTTP 状态及 message 处理。
+   * 
+   * @example
+   * SUCCESS
+   */
+  code?: string;
+  /**
+   * @remarks
+   * 结果结构见本接口返回字段；异步写接口的返回表示受理，不保证后台任务已完成。
+   */
+  data?: GetIdentityProviderServiceProviderResponseBodyData;
+  /**
+   * @remarks
+   * 本次请求的处理状态，不等同后台任务最终结果。
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * 请求受理或错误消息；异步任务结果需按对应查询接口核对。
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * 用于关联本次调用与排障，失败时请保留。
+   * 
+   * @example
+   * request-example
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * true 表示本次请求处理成功；异步写入仍需继续查询任务结果。
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      data: 'data',
+      httpStatusCode: 'httpStatusCode',
+      message: 'message',
+      requestId: 'requestId',
+      success: 'success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: GetIdentityProviderServiceProviderResponseBodyData,
+      httpStatusCode: 'number',
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetIdentityProviderSyncJobRequest.ts

@@ -0,0 +1,24 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetIdentityProviderSyncJobRequest extends $dara.Model {
+  static names(): { [key: string]: string } {
+    return {
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetIdentityProviderSyncJobResponse.ts

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

@@ -0,0 +1,174 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetIdentityProviderSyncJobResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The current execution step of the AgentCore asynchronous task. This field may not be returned if the task has not started.
+   * 
+   * @example
+   * SYNC
+   */
+  currentStep?: string;
+  /**
+   * @remarks
+   * The failure summary of the asynchronous task. This field is not returned if there is no failure information. You can use the taskId and requestId for troubleshooting.
+   * 
+   * @example
+   * The identity provider synchronization job failed.
+   */
+  failureReason?: string;
+  /**
+   * @remarks
+   * The status of the synchronization task. Valid values:
+   * - PENDING: The task is pending execution.
+   * - RUNNING: The task is running.
+   * - PAUSED: The task is paused.
+   * - SUCCESS: The task is successful.
+   * - FAILED: The task failed.
+   * - CANCELED: The task is canceled.
+   * The first three values are non-terminal states, and the last three values are terminal states. Query the task until it reaches a terminal state to determine the result.
+   * 
+   * @example
+   * SUCCESS
+   */
+  status?: string;
+  /**
+   * @remarks
+   * The number of user entries that have been locally read and written or updated, including existing users. This value does not represent the number of newly added users or the synchronization percentage. This field is not returned when no statistics are available.
+   * 
+   * @example
+   * 12
+   */
+  syncedUserCount?: number;
+  /**
+   * @remarks
+   * The downstream synchronization task ID of AgentIdentity. This field is not returned if the task has not been created. It cannot replace the taskId to call GetIdentityProviderSyncJob.
+   * 
+   * @example
+   * syncjob_0123456789abcdef0123456789abcdef
+   */
+  synchronizationJobId?: string;
+  /**
+   * @remarks
+   * The local task ID of AgentCore returned by CreateIdentityProviderSyncJob. It is not the synchronizationJobId of AgentIdentity. The same workspace and identity provider must be used for the query.
+   * 
+   * @example
+   * 12345678-1234-4234-8234-123456789abc
+   */
+  taskId?: string;
+  static names(): { [key: string]: string } {
+    return {
+      currentStep: 'currentStep',
+      failureReason: 'failureReason',
+      status: 'status',
+      syncedUserCount: 'syncedUserCount',
+      synchronizationJobId: 'synchronizationJobId',
+      taskId: 'taskId',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      currentStep: 'string',
+      failureReason: 'string',
+      status: 'string',
+      syncedUserCount: 'number',
+      synchronizationJobId: 'string',
+      taskId: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetIdentityProviderSyncJobResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The business status code of the API request. SUCCESS indicates that the request is successful, but does not indicate that the asynchronous synchronization task is completed.
+   * 
+   * @example
+   * SUCCESS
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The business data returned by the request.
+   * 
+   * @example
+   * {"taskId":"12345678-1234-4234-8234-123456789abc","status":"SUCCESS","currentStep":"SYNC","synchronizationJobId":"syncjob_0123456789abcdef0123456789abcdef","syncedUserCount":12}
+   */
+  data?: GetIdentityProviderSyncJobResponseBodyData;
+  /**
+   * @remarks
+   * The HTTP status code of the API request. It does not indicate the execution result of the asynchronous task.
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message of the API request.
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The unique identifier of the request. Provide this value when you troubleshoot issues.
+   * 
+   * @example
+   * 01234567-89AB-CDEF-0123-456789ABCDEF
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the API request is successful. To determine whether the asynchronous task is completed, query the task status.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      data: 'data',
+      httpStatusCode: 'httpStatusCode',
+      message: 'message',
+      requestId: 'requestId',
+      success: 'success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: GetIdentityProviderSyncJobResponseBodyData,
+      httpStatusCode: 'number',
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetIdentityProviderSyncScopeRequest.ts

@@ -0,0 +1,24 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetIdentityProviderSyncScopeRequest extends $dara.Model {
+  static names(): { [key: string]: string } {
+    return {
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/GetIdentityProviderSyncScopeResponse.ts

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

@@ -0,0 +1,256 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class GetIdentityProviderSyncScopeResponseBodyDataSelectedDepartments extends $dara.Model {
+  /**
+   * @remarks
+   * Indicates whether the selected department still exists. A value of false indicates that the selection is invalid and the synchronization scope must be reconfirmed.
+   * 
+   * @example
+   * true
+   */
+  exists?: boolean;
+  /**
+   * @remarks
+   * The unique identifier of the department returned by the identity provider. When querying the sub-departments of this node, use this value as parentDepartmentId.
+   * 
+   * @example
+   * 10001
+   */
+  id?: string;
+  /**
+   * @remarks
+   * The name of the department returned by the identity provider.
+   * 
+   * @example
+   * R&D Department
+   */
+  name?: string;
+  static names(): { [key: string]: string } {
+    return {
+      exists: 'exists',
+      id: 'id',
+      name: 'name',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      exists: 'boolean',
+      id: 'string',
+      name: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetIdentityProviderSyncScopeResponseBodyDataSyncScope extends $dara.Model {
+  /**
+   * @remarks
+   * When the mode is SelectedDepartments, this parameter contains at least one non-empty department ID, which should be obtained from ListIdentityProviderDepartments. When the mode is AllAuthorized, pass an empty array or omit this parameter.
+   * 
+   * @example
+   * ["10001"]
+   */
+  departmentIds?: string[];
+  /**
+   * @remarks
+   * The scope mode. Valid values: AllAuthorized (the entire authorized scope, limited by the application\\"s address book authorization) and SelectedDepartments (the selected departments and all their sub-departments). When explicitly submitting syncScope, a valid mode must be provided and verified by the backend.
+   * 
+   * @example
+   * SelectedDepartments
+   */
+  mode?: string;
+  static names(): { [key: string]: string } {
+    return {
+      departmentIds: 'departmentIds',
+      mode: 'mode',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      departmentIds: { 'type': 'array', 'itemType': 'string' },
+      mode: 'string',
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.departmentIds)) {
+      $dara.Model.validateArray(this.departmentIds);
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetIdentityProviderSyncScopeResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * The estimation status of the user count for the synchronization scope. The count is available only when the status is Ready. A missing count in other states cannot be considered as 0.
+   * 
+   * @example
+   * Ready
+   */
+  estimateStatus?: string;
+  /**
+   * @remarks
+   * The estimated number of users in the saved synchronization scope. This parameter is returned only when estimateStatus is Ready and the downstream system provides the value. It does not represent the number of users that have been synchronized.
+   * 
+   * @example
+   * 12
+   */
+  estimatedUserCount?: number;
+  /**
+   * @remarks
+   * The estimated number of departments including sub-departments. This parameter is returned only when estimateStatus is Ready and the downstream system provides the value.
+   * 
+   * @example
+   * 2
+   */
+  expandedDepartmentCount?: number;
+  /**
+   * @remarks
+   * The names and validity of the saved selected departments. This parameter can be an empty array when the mode is AllAuthorized. An empty array does not indicate that the organization has no departments.
+   * 
+   * @example
+   * [{"id":"10001","name":"R&D Department","exists":true}]
+   */
+  selectedDepartments?: GetIdentityProviderSyncScopeResponseBodyDataSelectedDepartments[];
+  /**
+   * @remarks
+   * The saved synchronization scope downstream. AllAuthorized indicates the address book scope authorized for the application.
+   * 
+   * @example
+   * {"mode":"SelectedDepartments","departmentIds":["10001"]}
+   */
+  syncScope?: GetIdentityProviderSyncScopeResponseBodyDataSyncScope;
+  static names(): { [key: string]: string } {
+    return {
+      estimateStatus: 'estimateStatus',
+      estimatedUserCount: 'estimatedUserCount',
+      expandedDepartmentCount: 'expandedDepartmentCount',
+      selectedDepartments: 'selectedDepartments',
+      syncScope: 'syncScope',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      estimateStatus: 'string',
+      estimatedUserCount: 'number',
+      expandedDepartmentCount: 'number',
+      selectedDepartments: { 'type': 'array', 'itemType': GetIdentityProviderSyncScopeResponseBodyDataSelectedDepartments },
+      syncScope: GetIdentityProviderSyncScopeResponseBodyDataSyncScope,
+    };
+  }
+
+  validate() {
+    if(Array.isArray(this.selectedDepartments)) {
+      $dara.Model.validateArray(this.selectedDepartments);
+    }
+    if(this.syncScope && typeof (this.syncScope as any).validate === 'function') {
+      (this.syncScope as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class GetIdentityProviderSyncScopeResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * The business status code of the API request. SUCCESS indicates that the request is successful, but does not indicate that the asynchronous synchronization task is completed.
+   * 
+   * @example
+   * SUCCESS
+   */
+  code?: string;
+  /**
+   * @remarks
+   * The business data returned by the request.
+   * 
+   * @example
+   * {"syncScope":{"mode":"SelectedDepartments","departmentIds":["10001"]},"selectedDepartments":[{"id":"10001","name":"R&D Department","exists":true}],"estimateStatus":"Ready","expandedDepartmentCount":2,"estimatedUserCount":12}
+   */
+  data?: GetIdentityProviderSyncScopeResponseBodyData;
+  /**
+   * @remarks
+   * The HTTP status code of the API request. It does not indicate the execution result of the asynchronous task.
+   * 
+   * @example
+   * 200
+   */
+  httpStatusCode?: number;
+  /**
+   * @remarks
+   * The response message of the API request.
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * The unique identifier of the request. Provide this value when troubleshooting issues.
+   * 
+   * @example
+   * 01234567-89AB-CDEF-0123-456789ABCDEF
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Indicates whether the API request is successful. To check whether the asynchronous task is completed, query the task status.
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'code',
+      data: 'data',
+      httpStatusCode: 'httpStatusCode',
+      message: 'message',
+      requestId: 'requestId',
+      success: 'success',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      data: GetIdentityProviderSyncScopeResponseBodyData,
+      httpStatusCode: 'number',
+      message: 'string',
+      requestId: 'string',
+      success: 'boolean',
+    };
+  }
+
+  validate() {
+    if(this.data && typeof (this.data as any).validate === 'function') {
+      (this.data as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+