@alicloud/eiam20211201 1.4.0 → 1.5.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 CHANGED
@@ -1775,6 +1775,72 @@ export declare class DeleteOrganizationalUnitResponse extends $tea.Model {
1775
1775
  [key: string]: any;
1776
1776
  });
1777
1777
  }
1778
+ export declare class DeleteOrganizationalUnitChildrenRequest extends $tea.Model {
1779
+ /**
1780
+ * @remarks
1781
+ * Instance ID.
1782
+ *
1783
+ * This parameter is required.
1784
+ *
1785
+ * @example
1786
+ * idaas_ue2jvisn35ea5lmthk267xxxxx
1787
+ */
1788
+ instanceId?: string;
1789
+ /**
1790
+ * @remarks
1791
+ * Organizational Unit ID.
1792
+ *
1793
+ * This parameter is required.
1794
+ *
1795
+ * @example
1796
+ * ou_wovwffm62xifdziem7an7xxxxx
1797
+ */
1798
+ organizationalUnitId?: string;
1799
+ static names(): {
1800
+ [key: string]: string;
1801
+ };
1802
+ static types(): {
1803
+ [key: string]: any;
1804
+ };
1805
+ constructor(map?: {
1806
+ [key: string]: any;
1807
+ });
1808
+ }
1809
+ export declare class DeleteOrganizationalUnitChildrenResponseBody extends $tea.Model {
1810
+ /**
1811
+ * @remarks
1812
+ * Request ID.
1813
+ *
1814
+ * @example
1815
+ * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
1816
+ */
1817
+ requestId?: string;
1818
+ static names(): {
1819
+ [key: string]: string;
1820
+ };
1821
+ static types(): {
1822
+ [key: string]: any;
1823
+ };
1824
+ constructor(map?: {
1825
+ [key: string]: any;
1826
+ });
1827
+ }
1828
+ export declare class DeleteOrganizationalUnitChildrenResponse extends $tea.Model {
1829
+ headers?: {
1830
+ [key: string]: string;
1831
+ };
1832
+ statusCode?: number;
1833
+ body?: DeleteOrganizationalUnitChildrenResponseBody;
1834
+ static names(): {
1835
+ [key: string]: string;
1836
+ };
1837
+ static types(): {
1838
+ [key: string]: any;
1839
+ };
1840
+ constructor(map?: {
1841
+ [key: string]: any;
1842
+ });
1843
+ }
1778
1844
  export declare class DeleteUserRequest extends $tea.Model {
1779
1845
  /**
1780
1846
  * @remarks
@@ -5523,7 +5589,7 @@ export declare class ListOrganizationalUnitsRequest extends $tea.Model {
5523
5589
  instanceId?: string;
5524
5590
  /**
5525
5591
  * @remarks
5526
- * 组织ID列表。size限制最大100。
5592
+ * The IDs of organizational units.
5527
5593
  *
5528
5594
  * @example
5529
5595
  * [ou_wovwffm62xifdziem7an7xxxxx]
@@ -5539,7 +5605,7 @@ export declare class ListOrganizationalUnitsRequest extends $tea.Model {
5539
5605
  organizationalUnitName?: string;
5540
5606
  /**
5541
5607
  * @remarks
5542
- * 组织名称,左匹配
5608
+ * Organization name, matching left
5543
5609
  *
5544
5610
  * @example
5545
5611
  * name
@@ -5920,7 +5986,7 @@ export declare class ListSynchronizationJobsResponse extends $tea.Model {
5920
5986
  export declare class ListUsersRequest extends $tea.Model {
5921
5987
  /**
5922
5988
  * @remarks
5923
- * 账户展示名,模糊匹配
5989
+ * Displayname
5924
5990
  *
5925
5991
  * @example
5926
5992
  * name_001
@@ -6007,7 +6073,7 @@ export declare class ListUsersRequest extends $tea.Model {
6007
6073
  userExternalId?: string;
6008
6074
  /**
6009
6075
  * @remarks
6010
- * 账户的ID集合
6076
+ * User ID set
6011
6077
  */
6012
6078
  userIds?: string[];
6013
6079
  /**
@@ -6035,7 +6101,7 @@ export declare class ListUsersRequest extends $tea.Model {
6035
6101
  userSourceType?: string;
6036
6102
  /**
6037
6103
  * @remarks
6038
- * 账户名,左模糊匹配
6104
+ * Username
6039
6105
  *
6040
6106
  * @example
6041
6107
  * name_001
@@ -7099,7 +7165,7 @@ export declare class SetApplicationProvisioningScopeRequest extends $tea.Model {
7099
7165
  applicationId?: string;
7100
7166
  /**
7101
7167
  * @remarks
7102
- * 授权同步出的组列表
7168
+ * List of groups that are authorized to be synchronized from
7103
7169
  */
7104
7170
  groupIds?: string[];
7105
7171
  /**
@@ -7194,7 +7260,7 @@ export declare class SetApplicationSsoConfigRequest extends $tea.Model {
7194
7260
  initLoginUrl?: string;
7195
7261
  /**
7196
7262
  * @remarks
7197
- * The ID of the instance.
7263
+ * The instance ID.
7198
7264
  *
7199
7265
  * This parameter is required.
7200
7266
  *
@@ -7209,7 +7275,7 @@ export declare class SetApplicationSsoConfigRequest extends $tea.Model {
7209
7275
  oidcSsoConfig?: SetApplicationSsoConfigRequestOidcSsoConfig;
7210
7276
  /**
7211
7277
  * @remarks
7212
- * The Security Assertion Markup Language (SAML)-based SSO configuration attributes of the application.
7278
+ * The Security Assertion Markup Language (SAML)-based single sign-on (SSO) configuration attributes of the application.
7213
7279
  */
7214
7280
  samlSsoConfig?: SetApplicationSsoConfigRequestSamlSsoConfig;
7215
7281
  static names(): {
@@ -7225,7 +7291,7 @@ export declare class SetApplicationSsoConfigRequest extends $tea.Model {
7225
7291
  export declare class SetApplicationSsoConfigResponseBody extends $tea.Model {
7226
7292
  /**
7227
7293
  * @remarks
7228
- * The ID of the request.
7294
+ * The request ID.
7229
7295
  *
7230
7296
  * @example
7231
7297
  * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
@@ -7323,7 +7389,7 @@ export declare class SetDefaultDomainResponse extends $tea.Model {
7323
7389
  export declare class SetForgetPasswordConfigurationRequest extends $tea.Model {
7324
7390
  /**
7325
7391
  * @remarks
7326
- * 身份认证渠道。枚举取值:email(邮件)、sms(短信)
7392
+ * The authentication channels. Valid values: email and sms.
7327
7393
  *
7328
7394
  * @example
7329
7395
  * email
@@ -7331,7 +7397,7 @@ export declare class SetForgetPasswordConfigurationRequest extends $tea.Model {
7331
7397
  authenticationChannels?: string[];
7332
7398
  /**
7333
7399
  * @remarks
7334
- * 忘记密码配置状态。枚举取值:enabled(开启)、disabled(禁用)
7400
+ * The status of the forgot password feature. Valid values: enabled and disabled.
7335
7401
  *
7336
7402
  * This parameter is required.
7337
7403
  *
@@ -7843,7 +7909,7 @@ export declare class SetUserPrimaryOrganizationalUnitResponse extends $tea.Model
7843
7909
  export declare class UnlockUserRequest extends $tea.Model {
7844
7910
  /**
7845
7911
  * @remarks
7846
- * The instance ID.
7912
+ * IDaaS EIAM实例的ID
7847
7913
  *
7848
7914
  * This parameter is required.
7849
7915
  *
@@ -7853,12 +7919,12 @@ export declare class UnlockUserRequest extends $tea.Model {
7853
7919
  instanceId?: string;
7854
7920
  /**
7855
7921
  * @remarks
7856
- * The account ID.
7922
+ * 账户ID
7857
7923
  *
7858
7924
  * This parameter is required.
7859
7925
  *
7860
7926
  * @example
7861
- * user_d6sbsuumeta4h66ec3il7yxxxx
7927
+ * u_001
7862
7928
  */
7863
7929
  userId?: string;
7864
7930
  static names(): {
@@ -7873,9 +7939,6 @@ export declare class UnlockUserRequest extends $tea.Model {
7873
7939
  }
7874
7940
  export declare class UnlockUserResponseBody extends $tea.Model {
7875
7941
  /**
7876
- * @remarks
7877
- * The request ID.
7878
- *
7879
7942
  * @example
7880
7943
  * 0441BD79-92F3-53AA-8657-F8CE4A2B912A
7881
7944
  */
@@ -8144,7 +8207,7 @@ export declare class UpdateGroupResponse extends $tea.Model {
8144
8207
  export declare class UpdateGroupDescriptionRequest extends $tea.Model {
8145
8208
  /**
8146
8209
  * @remarks
8147
- * The description of the account group. The value can be up to 256 characters in length.
8210
+ * The description of the account group.
8148
8211
  *
8149
8212
  * @example
8150
8213
  * group_d6sbsuumeta4h66ec3il7yxxxx
@@ -8375,7 +8438,7 @@ export declare class UpdateOrganizationalUnitRequest extends $tea.Model {
8375
8438
  organizationalUnitId?: string;
8376
8439
  /**
8377
8440
  * @remarks
8378
- * The name of the organization. The name can be up to 64 characters in length and must be unique in the same parent organization.
8441
+ * The name of the organization. The name can be up to 128 characters in length and must be unique in the same parent organization.
8379
8442
  *
8380
8443
  * @example
8381
8444
  * ou_name
@@ -9051,6 +9114,7 @@ export declare class GetApplicationResponseBodyApplication extends $tea.Model {
9051
9114
  * apt_rpa_tdsxxx
9052
9115
  */
9053
9116
  applicationTemplateId?: string;
9117
+ applicationVisibility?: string[];
9054
9118
  /**
9055
9119
  * @remarks
9056
9120
  * The authorization type of the EIAM application. Valid values:
@@ -9455,12 +9519,15 @@ export declare class GetApplicationProvisioningConfigResponseBodyApplicationProv
9455
9519
  export declare class GetApplicationProvisioningScopeResponseBodyApplicationProvisioningScope extends $tea.Model {
9456
9520
  /**
9457
9521
  * @remarks
9458
- * 同步授权的组列表
9522
+ * Synchronize the list of authorized groups
9459
9523
  */
9460
9524
  groupIds?: string[];
9461
9525
  /**
9462
9526
  * @remarks
9463
- * 租户最大授权主体quota数量
9527
+ * Instance Indicates the maximum quota number of authorized agents
9528
+ *
9529
+ * @example
9530
+ * 20
9464
9531
  */
9465
9532
  maxQuota?: number;
9466
9533
  /**
@@ -9470,7 +9537,10 @@ export declare class GetApplicationProvisioningScopeResponseBodyApplicationProvi
9470
9537
  organizationalUnitIds?: string[];
9471
9538
  /**
9472
9539
  * @remarks
9473
- * 已使用授权主体quota数量
9540
+ * Indicates the quota number of used authorized agents
9541
+ *
9542
+ * @example
9543
+ * 10
9474
9544
  */
9475
9545
  usedQuota?: number;
9476
9546
  static names(): {
@@ -9772,6 +9842,7 @@ export declare class GetApplicationSsoConfigResponseBodyApplicationSsoConfigSaml
9772
9842
  * https://home.console.aliyun.com
9773
9843
  */
9774
9844
  defaultRelayState?: string;
9845
+ idPEntityId?: string;
9775
9846
  /**
9776
9847
  * @remarks
9777
9848
  * The Format attribute of the NameID element in the SAML assertion. Valid values:
@@ -12315,6 +12386,9 @@ export declare class GetUserResponseBodyUser extends $tea.Model {
12315
12386
  */
12316
12387
  phoneRegion?: string;
12317
12388
  /**
12389
+ * @remarks
12390
+ * Preferred language
12391
+ *
12318
12392
  * @example
12319
12393
  * en-US
12320
12394
  */
@@ -13081,7 +13155,21 @@ export declare class ListGroupsForUserResponseBodyGroups extends $tea.Model {
13081
13155
  * group_d6sbsuumeta4h66ec3il7yxxxx
13082
13156
  */
13083
13157
  groupId?: string;
13158
+ /**
13159
+ * @remarks
13160
+ * Account membership source ID
13161
+ *
13162
+ * @example
13163
+ * idaas_ue2jvisn35ea5lmthk267xxxxx
13164
+ */
13084
13165
  groupMemberRelationSourceId?: string;
13166
+ /**
13167
+ * @remarks
13168
+ * Account membership source type
13169
+ *
13170
+ * @example
13171
+ * build_in
13172
+ */
13085
13173
  groupMemberRelationSourceType?: string;
13086
13174
  static names(): {
13087
13175
  [key: string]: string;
@@ -15125,7 +15213,21 @@ export declare class ListUsersForApplicationResponseBodyUsers extends $tea.Model
15125
15213
  });
15126
15214
  }
15127
15215
  export declare class ListUsersForGroupResponseBodyUsers extends $tea.Model {
15216
+ /**
15217
+ * @remarks
15218
+ * Account membership source id
15219
+ *
15220
+ * @example
15221
+ * idaas_ue2jvisn35ea5lmthk267xxxxx
15222
+ */
15128
15223
  groupMemberRelationSourceId?: string;
15224
+ /**
15225
+ * @remarks
15226
+ * Account membership source type
15227
+ *
15228
+ * @example
15229
+ * build_in
15230
+ */
15129
15231
  groupMemberRelationSourceType?: string;
15130
15232
  /**
15131
15233
  * @remarks
@@ -15646,7 +15748,10 @@ export declare class SetApplicationSsoConfigRequestSamlSsoConfigAttributeStateme
15646
15748
  export declare class SetApplicationSsoConfigRequestSamlSsoConfig extends $tea.Model {
15647
15749
  /**
15648
15750
  * @remarks
15649
- * assertion是否签名
15751
+ * Specifies whether to calculate the signature for the assertion. You cannot set ResponseSigned and AssertionSigned to false at the same time.
15752
+ *
15753
+ * * true
15754
+ * * false
15650
15755
  *
15651
15756
  * @example
15652
15757
  * true
@@ -15665,6 +15770,7 @@ export declare class SetApplicationSsoConfigRequestSamlSsoConfig extends $tea.Mo
15665
15770
  * https://home.console.aliyun.com
15666
15771
  */
15667
15772
  defaultRelayState?: string;
15773
+ idPEntityId?: string;
15668
15774
  /**
15669
15775
  * @remarks
15670
15776
  * The Format attribute of the NameID element in the SAML assertion. Valid values:
@@ -15688,7 +15794,10 @@ export declare class SetApplicationSsoConfigRequestSamlSsoConfig extends $tea.Mo
15688
15794
  nameIdValueExpression?: string;
15689
15795
  /**
15690
15796
  * @remarks
15691
- * response是否签名
15797
+ * Specifies whether to calculate the signature for the response. You cannot set ResponseSigned and AssertionSigned to false at the same time.
15798
+ *
15799
+ * * true
15800
+ * * false
15692
15801
  *
15693
15802
  * @example
15694
15803
  * true
@@ -15698,13 +15807,29 @@ export declare class SetApplicationSsoConfigRequestSamlSsoConfig extends $tea.Mo
15698
15807
  * @remarks
15699
15808
  * The algorithm that is used to calculate the signature for the SAML assertion.
15700
15809
  *
15810
+ * Enumeration value:
15811
+ *
15812
+ * * RSA-SHA256
15813
+ *
15814
+ * <!-- -->
15815
+ *
15816
+ * :
15817
+ *
15818
+ * <!-- -->
15819
+ *
15820
+ * the Rivest-Shamir-Adleman (RSA)-Secure Hash Algorithm 256 (SHA-256) algorithm
15821
+ *
15822
+ * <!-- -->
15823
+ *
15824
+ * .
15825
+ *
15701
15826
  * @example
15702
15827
  * RSA-SHA256
15703
15828
  */
15704
15829
  signatureAlgorithm?: string;
15705
15830
  /**
15706
15831
  * @remarks
15707
- * The entity ID of the application in SAML. The application assumes the role of service provider.
15832
+ * The entity ID of the application in SAML.
15708
15833
  *
15709
15834
  * @example
15710
15835
  * urn:alibaba:cloudcomputing
@@ -15712,7 +15837,7 @@ export declare class SetApplicationSsoConfigRequestSamlSsoConfig extends $tea.Mo
15712
15837
  spEntityId?: string;
15713
15838
  /**
15714
15839
  * @remarks
15715
- * The Assertion Consumer Service (ACS) URL of the application in SAML. The application assumes the role of service provider.
15840
+ * The Assertion Consumer Service (ACS) URL of the application in SAML.
15716
15841
  *
15717
15842
  * @example
15718
15843
  * https://signin.aliyun.com/saml-role/sso
@@ -16148,6 +16273,21 @@ export default class Client extends OpenApi {
16148
16273
  * @returns DeleteOrganizationalUnitResponse
16149
16274
  */
16150
16275
  deleteOrganizationalUnit(request: DeleteOrganizationalUnitRequest): Promise<DeleteOrganizationalUnitResponse>;
16276
+ /**
16277
+ * Delete organizational unit information, forcibly deleting all accounts and sub-organizations beneath it
16278
+ *
16279
+ * @param request - DeleteOrganizationalUnitChildrenRequest
16280
+ * @param runtime - runtime options for this request RuntimeOptions
16281
+ * @returns DeleteOrganizationalUnitChildrenResponse
16282
+ */
16283
+ deleteOrganizationalUnitChildrenWithOptions(request: DeleteOrganizationalUnitChildrenRequest, runtime: $Util.RuntimeOptions): Promise<DeleteOrganizationalUnitChildrenResponse>;
16284
+ /**
16285
+ * Delete organizational unit information, forcibly deleting all accounts and sub-organizations beneath it
16286
+ *
16287
+ * @param request - DeleteOrganizationalUnitChildrenRequest
16288
+ * @returns DeleteOrganizationalUnitChildrenResponse
16289
+ */
16290
+ deleteOrganizationalUnitChildren(request: DeleteOrganizationalUnitChildrenRequest): Promise<DeleteOrganizationalUnitChildrenResponse>;
16151
16291
  /**
16152
16292
  * Deletes an Employee Identity and Access Management (EIAM) account of Identity as a Service (IDaaS). The information related to the account is cleared.
16153
16293
  *
@@ -17346,7 +17486,7 @@ export default class Client extends OpenApi {
17346
17486
  */
17347
17487
  setUserPrimaryOrganizationalUnit(request: SetUserPrimaryOrganizationalUnitRequest): Promise<SetUserPrimaryOrganizationalUnitResponse>;
17348
17488
  /**
17349
- * Unlocks an Employee Identity and Access Management (EIAM) account of Identity as a Service (IDaaS) that is locked.
17489
+ * 解锁账户
17350
17490
  *
17351
17491
  * @param request - UnlockUserRequest
17352
17492
  * @param runtime - runtime options for this request RuntimeOptions
@@ -17354,7 +17494,7 @@ export default class Client extends OpenApi {
17354
17494
  */
17355
17495
  unlockUserWithOptions(request: UnlockUserRequest, runtime: $Util.RuntimeOptions): Promise<UnlockUserResponse>;
17356
17496
  /**
17357
- * Unlocks an Employee Identity and Access Management (EIAM) account of Identity as a Service (IDaaS) that is locked.
17497
+ * 解锁账户
17358
17498
  *
17359
17499
  * @param request - UnlockUserRequest
17360
17500
  * @returns UnlockUserResponse