@alicloud/cloudsso20210515 1.0.2 → 1.2.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.js CHANGED
@@ -603,6 +603,74 @@ class CreateUserResponse extends $tea.Model {
603
603
  }
604
604
  }
605
605
  exports.CreateUserResponse = CreateUserResponse;
606
+ class CreateUserProvisioningRequest extends $tea.Model {
607
+ constructor(map) {
608
+ super(map);
609
+ }
610
+ static names() {
611
+ return {
612
+ deletionStrategy: 'DeletionStrategy',
613
+ description: 'Description',
614
+ directoryId: 'DirectoryId',
615
+ duplicationStrategy: 'DuplicationStrategy',
616
+ principalId: 'PrincipalId',
617
+ principalType: 'PrincipalType',
618
+ targetId: 'TargetId',
619
+ targetType: 'TargetType',
620
+ };
621
+ }
622
+ static types() {
623
+ return {
624
+ deletionStrategy: 'string',
625
+ description: 'string',
626
+ directoryId: 'string',
627
+ duplicationStrategy: 'string',
628
+ principalId: 'string',
629
+ principalType: 'string',
630
+ targetId: 'string',
631
+ targetType: 'string',
632
+ };
633
+ }
634
+ }
635
+ exports.CreateUserProvisioningRequest = CreateUserProvisioningRequest;
636
+ class CreateUserProvisioningResponseBody extends $tea.Model {
637
+ constructor(map) {
638
+ super(map);
639
+ }
640
+ static names() {
641
+ return {
642
+ requestId: 'RequestId',
643
+ userProvisioning: 'UserProvisioning',
644
+ };
645
+ }
646
+ static types() {
647
+ return {
648
+ requestId: 'string',
649
+ userProvisioning: CreateUserProvisioningResponseBodyUserProvisioning,
650
+ };
651
+ }
652
+ }
653
+ exports.CreateUserProvisioningResponseBody = CreateUserProvisioningResponseBody;
654
+ class CreateUserProvisioningResponse extends $tea.Model {
655
+ constructor(map) {
656
+ super(map);
657
+ }
658
+ static names() {
659
+ return {
660
+ headers: 'headers',
661
+ statusCode: 'statusCode',
662
+ body: 'body',
663
+ };
664
+ }
665
+ static types() {
666
+ return {
667
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
668
+ statusCode: 'number',
669
+ body: CreateUserProvisioningResponseBody,
670
+ };
671
+ }
672
+ }
673
+ exports.CreateUserProvisioningResponse = CreateUserProvisioningResponse;
606
674
  class DeleteAccessAssignmentRequest extends $tea.Model {
607
675
  constructor(map) {
608
676
  super(map);
@@ -995,6 +1063,62 @@ class DeleteUserResponse extends $tea.Model {
995
1063
  }
996
1064
  }
997
1065
  exports.DeleteUserResponse = DeleteUserResponse;
1066
+ class DeleteUserProvisioningRequest extends $tea.Model {
1067
+ constructor(map) {
1068
+ super(map);
1069
+ }
1070
+ static names() {
1071
+ return {
1072
+ deletionStrategy: 'DeletionStrategy',
1073
+ directoryId: 'DirectoryId',
1074
+ userProvisioningId: 'UserProvisioningId',
1075
+ };
1076
+ }
1077
+ static types() {
1078
+ return {
1079
+ deletionStrategy: 'string',
1080
+ directoryId: 'string',
1081
+ userProvisioningId: 'string',
1082
+ };
1083
+ }
1084
+ }
1085
+ exports.DeleteUserProvisioningRequest = DeleteUserProvisioningRequest;
1086
+ class DeleteUserProvisioningResponseBody extends $tea.Model {
1087
+ constructor(map) {
1088
+ super(map);
1089
+ }
1090
+ static names() {
1091
+ return {
1092
+ requestId: 'RequestId',
1093
+ };
1094
+ }
1095
+ static types() {
1096
+ return {
1097
+ requestId: 'string',
1098
+ };
1099
+ }
1100
+ }
1101
+ exports.DeleteUserProvisioningResponseBody = DeleteUserProvisioningResponseBody;
1102
+ class DeleteUserProvisioningResponse extends $tea.Model {
1103
+ constructor(map) {
1104
+ super(map);
1105
+ }
1106
+ static names() {
1107
+ return {
1108
+ headers: 'headers',
1109
+ statusCode: 'statusCode',
1110
+ body: 'body',
1111
+ };
1112
+ }
1113
+ static types() {
1114
+ return {
1115
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
1116
+ statusCode: 'number',
1117
+ body: DeleteUserProvisioningResponseBody,
1118
+ };
1119
+ }
1120
+ }
1121
+ exports.DeleteUserProvisioningResponse = DeleteUserProvisioningResponse;
998
1122
  class DeprovisionAccessConfigurationRequest extends $tea.Model {
999
1123
  constructor(map) {
1000
1124
  super(map);
@@ -1455,6 +1579,60 @@ class GetGroupResponse extends $tea.Model {
1455
1579
  }
1456
1580
  }
1457
1581
  exports.GetGroupResponse = GetGroupResponse;
1582
+ class GetMFAAuthenticationSettingInfoRequest extends $tea.Model {
1583
+ constructor(map) {
1584
+ super(map);
1585
+ }
1586
+ static names() {
1587
+ return {
1588
+ directoryId: 'DirectoryId',
1589
+ };
1590
+ }
1591
+ static types() {
1592
+ return {
1593
+ directoryId: 'string',
1594
+ };
1595
+ }
1596
+ }
1597
+ exports.GetMFAAuthenticationSettingInfoRequest = GetMFAAuthenticationSettingInfoRequest;
1598
+ class GetMFAAuthenticationSettingInfoResponseBody extends $tea.Model {
1599
+ constructor(map) {
1600
+ super(map);
1601
+ }
1602
+ static names() {
1603
+ return {
1604
+ MFAAuthenticationSettingInfo: 'MFAAuthenticationSettingInfo',
1605
+ requestId: 'RequestId',
1606
+ };
1607
+ }
1608
+ static types() {
1609
+ return {
1610
+ MFAAuthenticationSettingInfo: GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo,
1611
+ requestId: 'string',
1612
+ };
1613
+ }
1614
+ }
1615
+ exports.GetMFAAuthenticationSettingInfoResponseBody = GetMFAAuthenticationSettingInfoResponseBody;
1616
+ class GetMFAAuthenticationSettingInfoResponse extends $tea.Model {
1617
+ constructor(map) {
1618
+ super(map);
1619
+ }
1620
+ static names() {
1621
+ return {
1622
+ headers: 'headers',
1623
+ statusCode: 'statusCode',
1624
+ body: 'body',
1625
+ };
1626
+ }
1627
+ static types() {
1628
+ return {
1629
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
1630
+ statusCode: 'number',
1631
+ body: GetMFAAuthenticationSettingInfoResponseBody,
1632
+ };
1633
+ }
1634
+ }
1635
+ exports.GetMFAAuthenticationSettingInfoResponse = GetMFAAuthenticationSettingInfoResponse;
1458
1636
  class GetMFAAuthenticationSettingsRequest extends $tea.Model {
1459
1637
  constructor(map) {
1460
1638
  super(map);
@@ -1879,6 +2057,62 @@ class GetUserMFAAuthenticationSettingsResponse extends $tea.Model {
1879
2057
  }
1880
2058
  }
1881
2059
  exports.GetUserMFAAuthenticationSettingsResponse = GetUserMFAAuthenticationSettingsResponse;
2060
+ class GetUserProvisioningRequest extends $tea.Model {
2061
+ constructor(map) {
2062
+ super(map);
2063
+ }
2064
+ static names() {
2065
+ return {
2066
+ directoryId: 'DirectoryId',
2067
+ userProvisioningId: 'UserProvisioningId',
2068
+ };
2069
+ }
2070
+ static types() {
2071
+ return {
2072
+ directoryId: 'string',
2073
+ userProvisioningId: 'string',
2074
+ };
2075
+ }
2076
+ }
2077
+ exports.GetUserProvisioningRequest = GetUserProvisioningRequest;
2078
+ class GetUserProvisioningResponseBody extends $tea.Model {
2079
+ constructor(map) {
2080
+ super(map);
2081
+ }
2082
+ static names() {
2083
+ return {
2084
+ requestId: 'RequestId',
2085
+ userProvisioning: 'UserProvisioning',
2086
+ };
2087
+ }
2088
+ static types() {
2089
+ return {
2090
+ requestId: 'string',
2091
+ userProvisioning: GetUserProvisioningResponseBodyUserProvisioning,
2092
+ };
2093
+ }
2094
+ }
2095
+ exports.GetUserProvisioningResponseBody = GetUserProvisioningResponseBody;
2096
+ class GetUserProvisioningResponse extends $tea.Model {
2097
+ constructor(map) {
2098
+ super(map);
2099
+ }
2100
+ static names() {
2101
+ return {
2102
+ headers: 'headers',
2103
+ statusCode: 'statusCode',
2104
+ body: 'body',
2105
+ };
2106
+ }
2107
+ static types() {
2108
+ return {
2109
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
2110
+ statusCode: 'number',
2111
+ body: GetUserProvisioningResponseBody,
2112
+ };
2113
+ }
2114
+ }
2115
+ exports.GetUserProvisioningResponse = GetUserProvisioningResponse;
1882
2116
  class ListAccessAssignmentsRequest extends $tea.Model {
1883
2117
  constructor(map) {
1884
2118
  super(map);
@@ -2657,6 +2891,80 @@ class ListTasksResponse extends $tea.Model {
2657
2891
  }
2658
2892
  }
2659
2893
  exports.ListTasksResponse = ListTasksResponse;
2894
+ class ListUserProvisioningsRequest extends $tea.Model {
2895
+ constructor(map) {
2896
+ super(map);
2897
+ }
2898
+ static names() {
2899
+ return {
2900
+ directoryId: 'DirectoryId',
2901
+ maxResults: 'MaxResults',
2902
+ nextToken: 'NextToken',
2903
+ principalId: 'PrincipalId',
2904
+ principalType: 'PrincipalType',
2905
+ targetId: 'TargetId',
2906
+ targetType: 'TargetType',
2907
+ };
2908
+ }
2909
+ static types() {
2910
+ return {
2911
+ directoryId: 'string',
2912
+ maxResults: 'number',
2913
+ nextToken: 'string',
2914
+ principalId: 'string',
2915
+ principalType: 'string',
2916
+ targetId: 'string',
2917
+ targetType: 'string',
2918
+ };
2919
+ }
2920
+ }
2921
+ exports.ListUserProvisioningsRequest = ListUserProvisioningsRequest;
2922
+ class ListUserProvisioningsResponseBody extends $tea.Model {
2923
+ constructor(map) {
2924
+ super(map);
2925
+ }
2926
+ static names() {
2927
+ return {
2928
+ isTruncated: 'IsTruncated',
2929
+ maxResults: 'MaxResults',
2930
+ nextToken: 'NextToken',
2931
+ requestId: 'RequestId',
2932
+ totalCounts: 'TotalCounts',
2933
+ userProvisionings: 'UserProvisionings',
2934
+ };
2935
+ }
2936
+ static types() {
2937
+ return {
2938
+ isTruncated: 'boolean',
2939
+ maxResults: 'number',
2940
+ nextToken: 'string',
2941
+ requestId: 'string',
2942
+ totalCounts: 'number',
2943
+ userProvisionings: { 'type': 'array', 'itemType': ListUserProvisioningsResponseBodyUserProvisionings },
2944
+ };
2945
+ }
2946
+ }
2947
+ exports.ListUserProvisioningsResponseBody = ListUserProvisioningsResponseBody;
2948
+ class ListUserProvisioningsResponse extends $tea.Model {
2949
+ constructor(map) {
2950
+ super(map);
2951
+ }
2952
+ static names() {
2953
+ return {
2954
+ headers: 'headers',
2955
+ statusCode: 'statusCode',
2956
+ body: 'body',
2957
+ };
2958
+ }
2959
+ static types() {
2960
+ return {
2961
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
2962
+ statusCode: 'number',
2963
+ body: ListUserProvisioningsResponseBody,
2964
+ };
2965
+ }
2966
+ }
2967
+ exports.ListUserProvisioningsResponse = ListUserProvisioningsResponse;
2660
2968
  class ListUsersRequest extends $tea.Model {
2661
2969
  constructor(map) {
2662
2970
  super(map);
@@ -3665,7 +3973,69 @@ class UpdateUserMFAAuthenticationSettingsResponse extends $tea.Model {
3665
3973
  }
3666
3974
  }
3667
3975
  exports.UpdateUserMFAAuthenticationSettingsResponse = UpdateUserMFAAuthenticationSettingsResponse;
3668
- class UpdateUserStatusRequest extends $tea.Model {
3976
+ class UpdateUserProvisioningRequest extends $tea.Model {
3977
+ constructor(map) {
3978
+ super(map);
3979
+ }
3980
+ static names() {
3981
+ return {
3982
+ directoryId: 'DirectoryId',
3983
+ newDeletionStrategy: 'NewDeletionStrategy',
3984
+ newDescription: 'NewDescription',
3985
+ newDuplicationStrategy: 'NewDuplicationStrategy',
3986
+ userProvisioningId: 'UserProvisioningId',
3987
+ };
3988
+ }
3989
+ static types() {
3990
+ return {
3991
+ directoryId: 'string',
3992
+ newDeletionStrategy: 'string',
3993
+ newDescription: 'string',
3994
+ newDuplicationStrategy: 'string',
3995
+ userProvisioningId: 'string',
3996
+ };
3997
+ }
3998
+ }
3999
+ exports.UpdateUserProvisioningRequest = UpdateUserProvisioningRequest;
4000
+ class UpdateUserProvisioningResponseBody extends $tea.Model {
4001
+ constructor(map) {
4002
+ super(map);
4003
+ }
4004
+ static names() {
4005
+ return {
4006
+ requestId: 'RequestId',
4007
+ userProvisioning: 'UserProvisioning',
4008
+ };
4009
+ }
4010
+ static types() {
4011
+ return {
4012
+ requestId: 'string',
4013
+ userProvisioning: UpdateUserProvisioningResponseBodyUserProvisioning,
4014
+ };
4015
+ }
4016
+ }
4017
+ exports.UpdateUserProvisioningResponseBody = UpdateUserProvisioningResponseBody;
4018
+ class UpdateUserProvisioningResponse extends $tea.Model {
4019
+ constructor(map) {
4020
+ super(map);
4021
+ }
4022
+ static names() {
4023
+ return {
4024
+ headers: 'headers',
4025
+ statusCode: 'statusCode',
4026
+ body: 'body',
4027
+ };
4028
+ }
4029
+ static types() {
4030
+ return {
4031
+ headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
4032
+ statusCode: 'number',
4033
+ body: UpdateUserProvisioningResponseBody,
4034
+ };
4035
+ }
4036
+ }
4037
+ exports.UpdateUserProvisioningResponse = UpdateUserProvisioningResponse;
4038
+ class UpdateUserStatusRequest extends $tea.Model {
3669
4039
  constructor(map) {
3670
4040
  super(map);
3671
4041
  }
@@ -3905,6 +4275,52 @@ class CreateUserResponseBodyUser extends $tea.Model {
3905
4275
  }
3906
4276
  }
3907
4277
  exports.CreateUserResponseBodyUser = CreateUserResponseBodyUser;
4278
+ class CreateUserProvisioningResponseBodyUserProvisioning extends $tea.Model {
4279
+ constructor(map) {
4280
+ super(map);
4281
+ }
4282
+ static names() {
4283
+ return {
4284
+ createTime: 'CreateTime',
4285
+ deletionStrategy: 'DeletionStrategy',
4286
+ description: 'Description',
4287
+ directoryId: 'DirectoryId',
4288
+ duplicationStrategy: 'DuplicationStrategy',
4289
+ ownerPk: 'OwnerPk',
4290
+ principalId: 'PrincipalId',
4291
+ principalName: 'PrincipalName',
4292
+ principalType: 'PrincipalType',
4293
+ status: 'Status',
4294
+ targetId: 'TargetId',
4295
+ targetName: 'TargetName',
4296
+ targetPath: 'TargetPath',
4297
+ targetType: 'TargetType',
4298
+ updateTime: 'UpdateTime',
4299
+ userProvisioningId: 'UserProvisioningId',
4300
+ };
4301
+ }
4302
+ static types() {
4303
+ return {
4304
+ createTime: 'string',
4305
+ deletionStrategy: 'string',
4306
+ description: 'string',
4307
+ directoryId: 'string',
4308
+ duplicationStrategy: 'string',
4309
+ ownerPk: 'string',
4310
+ principalId: 'string',
4311
+ principalName: 'string',
4312
+ principalType: 'string',
4313
+ status: 'string',
4314
+ targetId: 'string',
4315
+ targetName: 'string',
4316
+ targetPath: 'string',
4317
+ targetType: 'string',
4318
+ updateTime: 'string',
4319
+ userProvisioningId: 'string',
4320
+ };
4321
+ }
4322
+ }
4323
+ exports.CreateUserProvisioningResponseBodyUserProvisioning = CreateUserProvisioningResponseBodyUserProvisioning;
3908
4324
  class DeleteAccessAssignmentResponseBodyTask extends $tea.Model {
3909
4325
  constructor(map) {
3910
4326
  super(map);
@@ -4073,6 +4489,7 @@ class GetDirectoryStatisticsResponseBodyDirectoryStatistics extends $tea.Model {
4073
4489
  SCIMServerCredentialCount: 'SCIMServerCredentialCount',
4074
4490
  SCIMSyncEnabled: 'SCIMSyncEnabled',
4075
4491
  SSOEnabled: 'SSOEnabled',
4492
+ systemPolicyPerAccessConfigurationQuota: 'SystemPolicyPerAccessConfigurationQuota',
4076
4493
  userCount: 'UserCount',
4077
4494
  userQuota: 'UserQuota',
4078
4495
  };
@@ -4091,6 +4508,7 @@ class GetDirectoryStatisticsResponseBodyDirectoryStatistics extends $tea.Model {
4091
4508
  SCIMServerCredentialCount: 'number',
4092
4509
  SCIMSyncEnabled: 'boolean',
4093
4510
  SSOEnabled: 'boolean',
4511
+ systemPolicyPerAccessConfigurationQuota: 'number',
4094
4512
  userCount: 'number',
4095
4513
  userQuota: 'number',
4096
4514
  };
@@ -4155,6 +4573,24 @@ class GetGroupResponseBodyGroup extends $tea.Model {
4155
4573
  }
4156
4574
  }
4157
4575
  exports.GetGroupResponseBodyGroup = GetGroupResponseBodyGroup;
4576
+ class GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo extends $tea.Model {
4577
+ constructor(map) {
4578
+ super(map);
4579
+ }
4580
+ static names() {
4581
+ return {
4582
+ mfaAuthenticationAdvanceSettings: 'MfaAuthenticationAdvanceSettings',
4583
+ operationForRiskLogin: 'OperationForRiskLogin',
4584
+ };
4585
+ }
4586
+ static types() {
4587
+ return {
4588
+ mfaAuthenticationAdvanceSettings: 'string',
4589
+ operationForRiskLogin: 'string',
4590
+ };
4591
+ }
4592
+ }
4593
+ exports.GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo = GetMFAAuthenticationSettingInfoResponseBodyMFAAuthenticationSettingInfo;
4158
4594
  class GetServiceStatusResponseBodyServiceStatus extends $tea.Model {
4159
4595
  constructor(map) {
4160
4596
  super(map);
@@ -4285,6 +4721,52 @@ class GetUserResponseBodyUser extends $tea.Model {
4285
4721
  }
4286
4722
  }
4287
4723
  exports.GetUserResponseBodyUser = GetUserResponseBodyUser;
4724
+ class GetUserProvisioningResponseBodyUserProvisioning extends $tea.Model {
4725
+ constructor(map) {
4726
+ super(map);
4727
+ }
4728
+ static names() {
4729
+ return {
4730
+ createTime: 'CreateTime',
4731
+ deletionStrategy: 'DeletionStrategy',
4732
+ description: 'Description',
4733
+ directoryId: 'DirectoryId',
4734
+ duplicationStrategy: 'DuplicationStrategy',
4735
+ ownerPk: 'OwnerPk',
4736
+ principalId: 'PrincipalId',
4737
+ principalName: 'PrincipalName',
4738
+ principalType: 'PrincipalType',
4739
+ status: 'Status',
4740
+ targetId: 'TargetId',
4741
+ targetName: 'TargetName',
4742
+ targetPath: 'TargetPath',
4743
+ targetType: 'TargetType',
4744
+ updateTime: 'UpdateTime',
4745
+ userProvisioningId: 'UserProvisioningId',
4746
+ };
4747
+ }
4748
+ static types() {
4749
+ return {
4750
+ createTime: 'string',
4751
+ deletionStrategy: 'string',
4752
+ description: 'string',
4753
+ directoryId: 'string',
4754
+ duplicationStrategy: 'string',
4755
+ ownerPk: 'string',
4756
+ principalId: 'string',
4757
+ principalName: 'string',
4758
+ principalType: 'string',
4759
+ status: 'string',
4760
+ targetId: 'string',
4761
+ targetName: 'string',
4762
+ targetPath: 'string',
4763
+ targetType: 'string',
4764
+ updateTime: 'string',
4765
+ userProvisioningId: 'string',
4766
+ };
4767
+ }
4768
+ }
4769
+ exports.GetUserProvisioningResponseBodyUserProvisioning = GetUserProvisioningResponseBodyUserProvisioning;
4288
4770
  class ListAccessAssignmentsResponseBodyAccessAssignments extends $tea.Model {
4289
4771
  constructor(map) {
4290
4772
  super(map);
@@ -4651,6 +5133,52 @@ class ListTasksResponseBodyTasks extends $tea.Model {
4651
5133
  }
4652
5134
  }
4653
5135
  exports.ListTasksResponseBodyTasks = ListTasksResponseBodyTasks;
5136
+ class ListUserProvisioningsResponseBodyUserProvisionings extends $tea.Model {
5137
+ constructor(map) {
5138
+ super(map);
5139
+ }
5140
+ static names() {
5141
+ return {
5142
+ createTime: 'CreateTime',
5143
+ deletionStrategy: 'DeletionStrategy',
5144
+ description: 'Description',
5145
+ directoryId: 'DirectoryId',
5146
+ duplicationStrategy: 'DuplicationStrategy',
5147
+ ownerPk: 'OwnerPk',
5148
+ principalId: 'PrincipalId',
5149
+ principalName: 'PrincipalName',
5150
+ principalType: 'PrincipalType',
5151
+ status: 'Status',
5152
+ targetId: 'TargetId',
5153
+ targetName: 'TargetName',
5154
+ targetPath: 'TargetPath',
5155
+ targetType: 'TargetType',
5156
+ updateTime: 'UpdateTime',
5157
+ userProvisioningId: 'UserProvisioningId',
5158
+ };
5159
+ }
5160
+ static types() {
5161
+ return {
5162
+ createTime: 'string',
5163
+ deletionStrategy: 'string',
5164
+ description: 'string',
5165
+ directoryId: 'string',
5166
+ duplicationStrategy: 'string',
5167
+ ownerPk: 'string',
5168
+ principalId: 'string',
5169
+ principalName: 'string',
5170
+ principalType: 'string',
5171
+ status: 'string',
5172
+ targetId: 'string',
5173
+ targetName: 'string',
5174
+ targetPath: 'string',
5175
+ targetType: 'string',
5176
+ updateTime: 'string',
5177
+ userProvisioningId: 'string',
5178
+ };
5179
+ }
5180
+ }
5181
+ exports.ListUserProvisioningsResponseBodyUserProvisionings = ListUserProvisioningsResponseBodyUserProvisionings;
4654
5182
  class ListUsersResponseBodyUsers extends $tea.Model {
4655
5183
  constructor(map) {
4656
5184
  super(map);
@@ -4895,6 +5423,52 @@ class UpdateUserResponseBodyUser extends $tea.Model {
4895
5423
  }
4896
5424
  }
4897
5425
  exports.UpdateUserResponseBodyUser = UpdateUserResponseBodyUser;
5426
+ class UpdateUserProvisioningResponseBodyUserProvisioning extends $tea.Model {
5427
+ constructor(map) {
5428
+ super(map);
5429
+ }
5430
+ static names() {
5431
+ return {
5432
+ createTime: 'CreateTime',
5433
+ deletionStrategy: 'DeletionStrategy',
5434
+ description: 'Description',
5435
+ directoryId: 'DirectoryId',
5436
+ duplicationStrategy: 'DuplicationStrategy',
5437
+ ownerPk: 'OwnerPk',
5438
+ principalId: 'PrincipalId',
5439
+ principalName: 'PrincipalName',
5440
+ principalType: 'PrincipalType',
5441
+ status: 'Status',
5442
+ targetId: 'TargetId',
5443
+ targetName: 'TargetName',
5444
+ targetPath: 'TargetPath',
5445
+ targetType: 'TargetType',
5446
+ updateTime: 'UpdateTime',
5447
+ userProvisioningId: 'UserProvisioningId',
5448
+ };
5449
+ }
5450
+ static types() {
5451
+ return {
5452
+ createTime: 'string',
5453
+ deletionStrategy: 'string',
5454
+ description: 'string',
5455
+ directoryId: 'string',
5456
+ duplicationStrategy: 'string',
5457
+ ownerPk: 'string',
5458
+ principalId: 'string',
5459
+ principalName: 'string',
5460
+ principalType: 'string',
5461
+ status: 'string',
5462
+ targetId: 'string',
5463
+ targetName: 'string',
5464
+ targetPath: 'string',
5465
+ targetType: 'string',
5466
+ updateTime: 'string',
5467
+ userProvisioningId: 'string',
5468
+ };
5469
+ }
5470
+ }
5471
+ exports.UpdateUserProvisioningResponseBodyUserProvisioning = UpdateUserProvisioningResponseBodyUserProvisioning;
4898
5472
  class Client extends openapi_client_1.default {
4899
5473
  constructor(config) {
4900
5474
  super(config);
@@ -4911,6 +5485,14 @@ class Client extends openapi_client_1.default {
4911
5485
  }
4912
5486
  return endpoint_util_1.default.getEndpointRules(productId, regionId, endpointRule, network, suffix);
4913
5487
  }
5488
+ /**
5489
+ * You can add up to two SAML signing certificates.
5490
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
5491
+ *
5492
+ * @param request AddExternalSAMLIdPCertificateRequest
5493
+ * @param runtime runtime options for this request RuntimeOptions
5494
+ * @return AddExternalSAMLIdPCertificateResponse
5495
+ */
4914
5496
  async addExternalSAMLIdPCertificateWithOptions(request, runtime) {
4915
5497
  tea_util_1.default.validateModel(request);
4916
5498
  let query = {};
@@ -4936,10 +5518,24 @@ class Client extends openapi_client_1.default {
4936
5518
  });
4937
5519
  return $tea.cast(await this.callApi(params, req, runtime), new AddExternalSAMLIdPCertificateResponse({}));
4938
5520
  }
5521
+ /**
5522
+ * You can add up to two SAML signing certificates.
5523
+ * This topic provides an example on how to add a SAML signing certificate to the directory `d-00fc2p61****`.
5524
+ *
5525
+ * @param request AddExternalSAMLIdPCertificateRequest
5526
+ * @return AddExternalSAMLIdPCertificateResponse
5527
+ */
4939
5528
  async addExternalSAMLIdPCertificate(request) {
4940
5529
  let runtime = new $Util.RuntimeOptions({});
4941
5530
  return await this.addExternalSAMLIdPCertificateWithOptions(request, runtime);
4942
5531
  }
5532
+ /**
5533
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
5534
+ *
5535
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
5536
+ * @param runtime runtime options for this request RuntimeOptions
5537
+ * @return AddPermissionPolicyToAccessConfigurationResponse
5538
+ */
4943
5539
  async addPermissionPolicyToAccessConfigurationWithOptions(request, runtime) {
4944
5540
  tea_util_1.default.validateModel(request);
4945
5541
  let query = {};
@@ -4974,10 +5570,24 @@ class Client extends openapi_client_1.default {
4974
5570
  });
4975
5571
  return $tea.cast(await this.callApi(params, req, runtime), new AddPermissionPolicyToAccessConfigurationResponse({}));
4976
5572
  }
5573
+ /**
5574
+ * This topic provides an example on how to add the system policy `AliyunECSFullAccess` to the access configuration `ac-00jhtfl8thteu6uj****`.
5575
+ *
5576
+ * @param request AddPermissionPolicyToAccessConfigurationRequest
5577
+ * @return AddPermissionPolicyToAccessConfigurationResponse
5578
+ */
4977
5579
  async addPermissionPolicyToAccessConfiguration(request) {
4978
5580
  let runtime = new $Util.RuntimeOptions({});
4979
5581
  return await this.addPermissionPolicyToAccessConfigurationWithOptions(request, runtime);
4980
5582
  }
5583
+ /**
5584
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
5585
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
5586
+ *
5587
+ * @param request AddUserToGroupRequest
5588
+ * @param runtime runtime options for this request RuntimeOptions
5589
+ * @return AddUserToGroupResponse
5590
+ */
4981
5591
  async addUserToGroupWithOptions(request, runtime) {
4982
5592
  tea_util_1.default.validateModel(request);
4983
5593
  let query = {};
@@ -5006,10 +5616,25 @@ class Client extends openapi_client_1.default {
5006
5616
  });
5007
5617
  return $tea.cast(await this.callApi(params, req, runtime), new AddUserToGroupResponse({}));
5008
5618
  }
5619
+ /**
5620
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot add a user to a group that is synchronized by using SCIM.
5621
+ * This topic provides an example of how to add the user `u-00q8wbq42wiltcrk****` to the group `g-00jqzghi2n3o5hkh****`.
5622
+ *
5623
+ * @param request AddUserToGroupRequest
5624
+ * @return AddUserToGroupResponse
5625
+ */
5009
5626
  async addUserToGroup(request) {
5010
5627
  let runtime = new $Util.RuntimeOptions({});
5011
5628
  return await this.addUserToGroupWithOptions(request, runtime);
5012
5629
  }
5630
+ /**
5631
+ * If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
5632
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
5633
+ *
5634
+ * @param request ClearExternalSAMLIdentityProviderRequest
5635
+ * @param runtime runtime options for this request RuntimeOptions
5636
+ * @return ClearExternalSAMLIdentityProviderResponse
5637
+ */
5013
5638
  async clearExternalSAMLIdentityProviderWithOptions(request, runtime) {
5014
5639
  tea_util_1.default.validateModel(request);
5015
5640
  let query = {};
@@ -5032,10 +5657,26 @@ class Client extends openapi_client_1.default {
5032
5657
  });
5033
5658
  return $tea.cast(await this.callApi(params, req, runtime), new ClearExternalSAMLIdentityProviderResponse({}));
5034
5659
  }
5660
+ /**
5661
+ * If single sign-on (SSO) logon is disabled, you can clear the configurations of a SAML IdP. If SSO logon is enabled, you cannot clear the configurations.
5662
+ * This topic provides an example on how to clear the configurations of the SAML IdP within the directory `d-00fc2p61****`.
5663
+ *
5664
+ * @param request ClearExternalSAMLIdentityProviderRequest
5665
+ * @return ClearExternalSAMLIdentityProviderResponse
5666
+ */
5035
5667
  async clearExternalSAMLIdentityProvider(request) {
5036
5668
  let runtime = new $Util.RuntimeOptions({});
5037
5669
  return await this.clearExternalSAMLIdentityProviderWithOptions(request, runtime);
5038
5670
  }
5671
+ /**
5672
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of task execution by using the value of the `TaskId` response parameter.
5673
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
5674
+ * This topic provides an example on how to assign access permissions on the account `114240524784****` in your resource directory to the CloudSSO user `u-00q8wbq42wiltcrk****` by using the access configuration `ac-00jhtfl8thteu6uj****`. After the call is successful, the CloudSSO user can access resources within the account in the resource directory.
5675
+ *
5676
+ * @param request CreateAccessAssignmentRequest
5677
+ * @param runtime runtime options for this request RuntimeOptions
5678
+ * @return CreateAccessAssignmentResponse
5679
+ */
5039
5680
  async createAccessAssignmentWithOptions(request, runtime) {
5040
5681
  tea_util_1.default.validateModel(request);
5041
5682
  let query = {};
@@ -5073,10 +5714,26 @@ class Client extends openapi_client_1.default {
5073
5714
  });
5074
5715
  return $tea.cast(await this.callApi(params, req, runtime), new CreateAccessAssignmentResponse({}));
5075
5716
  }
5717
+ /**
5718
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of task execution by using the value of the `TaskId` response parameter.
5719
+ * For more information about how to assign permissions on an account in your resource directory, see [Overview of multi-account authorization](~~266726~~).
5720
+ * This topic provides an example on how to assign access permissions on the account `114240524784****` in your resource directory to the CloudSSO user `u-00q8wbq42wiltcrk****` by using the access configuration `ac-00jhtfl8thteu6uj****`. After the call is successful, the CloudSSO user can access resources within the account in the resource directory.
5721
+ *
5722
+ * @param request CreateAccessAssignmentRequest
5723
+ * @return CreateAccessAssignmentResponse
5724
+ */
5076
5725
  async createAccessAssignment(request) {
5077
5726
  let runtime = new $Util.RuntimeOptions({});
5078
5727
  return await this.createAccessAssignmentWithOptions(request, runtime);
5079
5728
  }
5729
+ /**
5730
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
5731
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
5732
+ *
5733
+ * @param request CreateAccessConfigurationRequest
5734
+ * @param runtime runtime options for this request RuntimeOptions
5735
+ * @return CreateAccessConfigurationResponse
5736
+ */
5080
5737
  async createAccessConfigurationWithOptions(request, runtime) {
5081
5738
  tea_util_1.default.validateModel(request);
5082
5739
  let query = {};
@@ -5111,10 +5768,29 @@ class Client extends openapi_client_1.default {
5111
5768
  });
5112
5769
  return $tea.cast(await this.callApi(params, req, runtime), new CreateAccessConfigurationResponse({}));
5113
5770
  }
5771
+ /**
5772
+ * For more information about access configurations, see [Overview of access configurations](~~266737~~).
5773
+ * This topic provides an example on how to create an access configuration named `ECS-Admin`.
5774
+ *
5775
+ * @param request CreateAccessConfigurationRequest
5776
+ * @return CreateAccessConfigurationResponse
5777
+ */
5114
5778
  async createAccessConfiguration(request) {
5115
5779
  let runtime = new $Util.RuntimeOptions({});
5116
5780
  return await this.createAccessConfigurationWithOptions(request, runtime);
5117
5781
  }
5782
+ /**
5783
+ * A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
5784
+ * To create a directory, you must select a region. Alibaba Cloud stores data in the directory only in the region that you select. However, you can deploy Alibaba Cloud resources including Elastic Compute Service (ECS) instances and ApsaraDB RDS instances in other regions. You can also use your cloud account for logons and access the Alibaba Cloud resources in other regions. You can select a region to create a directory based on your security compliance requirements and the geographic location of specific users. If you do not have strict security compliance requirements, we recommend that you select a region that is the closest to the geographical location of the specific users. This way, access to cloud resources is accelerated. You can create the CloudSSO directory in the China (Shanghai), China (Hong Kong), US (Silicon Valley), or Germany (Frankfurt) region.
5785
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
5786
+ * ## Limits
5787
+ * - You can create only one directory for a management account.
5788
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
5789
+ *
5790
+ * @param request CreateDirectoryRequest
5791
+ * @param runtime runtime options for this request RuntimeOptions
5792
+ * @return CreateDirectoryResponse
5793
+ */
5118
5794
  async createDirectoryWithOptions(request, runtime) {
5119
5795
  tea_util_1.default.validateModel(request);
5120
5796
  let query = {};
@@ -5137,10 +5813,28 @@ class Client extends openapi_client_1.default {
5137
5813
  });
5138
5814
  return $tea.cast(await this.callApi(params, req, runtime), new CreateDirectoryResponse({}));
5139
5815
  }
5816
+ /**
5817
+ * A directory is a CloudSSO instance. Before you can use CloudSSO, you must create a directory. The directory is used to manage all CloudSSO resources.
5818
+ * To create a directory, you must select a region. Alibaba Cloud stores data in the directory only in the region that you select. However, you can deploy Alibaba Cloud resources including Elastic Compute Service (ECS) instances and ApsaraDB RDS instances in other regions. You can also use your cloud account for logons and access the Alibaba Cloud resources in other regions. You can select a region to create a directory based on your security compliance requirements and the geographic location of specific users. If you do not have strict security compliance requirements, we recommend that you select a region that is the closest to the geographical location of the specific users. This way, access to cloud resources is accelerated. You can create the CloudSSO directory in the China (Shanghai), China (Hong Kong), US (Silicon Valley), or Germany (Frankfurt) region.
5819
+ * This topic provides an example on how to create a directory named `example` in the China (Shanghai) region.
5820
+ * ## Limits
5821
+ * - You can create only one directory for a management account.
5822
+ * - If you want to change the region of a directory, you must delete the directory and then create a directory in a different region.
5823
+ *
5824
+ * @param request CreateDirectoryRequest
5825
+ * @return CreateDirectoryResponse
5826
+ */
5140
5827
  async createDirectory(request) {
5141
5828
  let runtime = new $Util.RuntimeOptions({});
5142
5829
  return await this.createDirectoryWithOptions(request, runtime);
5143
5830
  }
5831
+ /**
5832
+ * This topic provides an example on how to create a group named `TestGroup`.
5833
+ *
5834
+ * @param request CreateGroupRequest
5835
+ * @param runtime runtime options for this request RuntimeOptions
5836
+ * @return CreateGroupResponse
5837
+ */
5144
5838
  async createGroupWithOptions(request, runtime) {
5145
5839
  tea_util_1.default.validateModel(request);
5146
5840
  let query = {};
@@ -5169,10 +5863,24 @@ class Client extends openapi_client_1.default {
5169
5863
  });
5170
5864
  return $tea.cast(await this.callApi(params, req, runtime), new CreateGroupResponse({}));
5171
5865
  }
5866
+ /**
5867
+ * This topic provides an example on how to create a group named `TestGroup`.
5868
+ *
5869
+ * @param request CreateGroupRequest
5870
+ * @return CreateGroupResponse
5871
+ */
5172
5872
  async createGroup(request) {
5173
5873
  let runtime = new $Util.RuntimeOptions({});
5174
5874
  return await this.createGroupWithOptions(request, runtime);
5175
5875
  }
5876
+ /**
5877
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
5878
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
5879
+ *
5880
+ * @param request CreateSCIMServerCredentialRequest
5881
+ * @param runtime runtime options for this request RuntimeOptions
5882
+ * @return CreateSCIMServerCredentialResponse
5883
+ */
5176
5884
  async createSCIMServerCredentialWithOptions(request, runtime) {
5177
5885
  tea_util_1.default.validateModel(request);
5178
5886
  let query = {};
@@ -5195,10 +5903,24 @@ class Client extends openapi_client_1.default {
5195
5903
  });
5196
5904
  return $tea.cast(await this.callApi(params, req, runtime), new CreateSCIMServerCredentialResponse({}));
5197
5905
  }
5906
+ /**
5907
+ * SCIM credentials are required for SCIM synchronization. You can create up to two SCIM credentials.
5908
+ * This topic provides an example on how to create a SCIM credential within the directory `d-00fc2p61****`.
5909
+ *
5910
+ * @param request CreateSCIMServerCredentialRequest
5911
+ * @return CreateSCIMServerCredentialResponse
5912
+ */
5198
5913
  async createSCIMServerCredential(request) {
5199
5914
  let runtime = new $Util.RuntimeOptions({});
5200
5915
  return await this.createSCIMServerCredentialWithOptions(request, runtime);
5201
5916
  }
5917
+ /**
5918
+ * This topic provides an example on how to create a user named `Alice`.
5919
+ *
5920
+ * @param request CreateUserRequest
5921
+ * @param runtime runtime options for this request RuntimeOptions
5922
+ * @return CreateUserResponse
5923
+ */
5202
5924
  async createUserWithOptions(request, runtime) {
5203
5925
  tea_util_1.default.validateModel(request);
5204
5926
  let query = {};
@@ -5242,10 +5964,71 @@ class Client extends openapi_client_1.default {
5242
5964
  });
5243
5965
  return $tea.cast(await this.callApi(params, req, runtime), new CreateUserResponse({}));
5244
5966
  }
5967
+ /**
5968
+ * This topic provides an example on how to create a user named `Alice`.
5969
+ *
5970
+ * @param request CreateUserRequest
5971
+ * @return CreateUserResponse
5972
+ */
5245
5973
  async createUser(request) {
5246
5974
  let runtime = new $Util.RuntimeOptions({});
5247
5975
  return await this.createUserWithOptions(request, runtime);
5248
5976
  }
5977
+ async createUserProvisioningWithOptions(request, runtime) {
5978
+ tea_util_1.default.validateModel(request);
5979
+ let query = {};
5980
+ if (!tea_util_1.default.isUnset(request.deletionStrategy)) {
5981
+ query["DeletionStrategy"] = request.deletionStrategy;
5982
+ }
5983
+ if (!tea_util_1.default.isUnset(request.description)) {
5984
+ query["Description"] = request.description;
5985
+ }
5986
+ if (!tea_util_1.default.isUnset(request.directoryId)) {
5987
+ query["DirectoryId"] = request.directoryId;
5988
+ }
5989
+ if (!tea_util_1.default.isUnset(request.duplicationStrategy)) {
5990
+ query["DuplicationStrategy"] = request.duplicationStrategy;
5991
+ }
5992
+ if (!tea_util_1.default.isUnset(request.principalId)) {
5993
+ query["PrincipalId"] = request.principalId;
5994
+ }
5995
+ if (!tea_util_1.default.isUnset(request.principalType)) {
5996
+ query["PrincipalType"] = request.principalType;
5997
+ }
5998
+ if (!tea_util_1.default.isUnset(request.targetId)) {
5999
+ query["TargetId"] = request.targetId;
6000
+ }
6001
+ if (!tea_util_1.default.isUnset(request.targetType)) {
6002
+ query["TargetType"] = request.targetType;
6003
+ }
6004
+ let req = new $OpenApi.OpenApiRequest({
6005
+ query: openapi_util_1.default.query(query),
6006
+ });
6007
+ let params = new $OpenApi.Params({
6008
+ action: "CreateUserProvisioning",
6009
+ version: "2021-05-15",
6010
+ protocol: "HTTPS",
6011
+ pathname: "/",
6012
+ method: "POST",
6013
+ authType: "AK",
6014
+ style: "RPC",
6015
+ reqBodyType: "formData",
6016
+ bodyType: "json",
6017
+ });
6018
+ return $tea.cast(await this.callApi(params, req, runtime), new CreateUserProvisioningResponse({}));
6019
+ }
6020
+ async createUserProvisioning(request) {
6021
+ let runtime = new $Util.RuntimeOptions({});
6022
+ return await this.createUserProvisioningWithOptions(request, runtime);
6023
+ }
6024
+ /**
6025
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
6026
+ * This topic provides an example on how to remove the access permissions on the account `114240524784****` in the resource directory from the CloudSSO user `u-00q8wbq42wiltcrk****`. The access permissions are assigned by using the access configuration `ac-00jhtfl8thteu6uj****`.
6027
+ *
6028
+ * @param request DeleteAccessAssignmentRequest
6029
+ * @param runtime runtime options for this request RuntimeOptions
6030
+ * @return DeleteAccessAssignmentResponse
6031
+ */
5249
6032
  async deleteAccessAssignmentWithOptions(request, runtime) {
5250
6033
  tea_util_1.default.validateModel(request);
5251
6034
  let query = {};
@@ -5286,10 +6069,26 @@ class Client extends openapi_client_1.default {
5286
6069
  });
5287
6070
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteAccessAssignmentResponse({}));
5288
6071
  }
6072
+ /**
6073
+ * When you call this operation, an asynchronous task is created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
6074
+ * This topic provides an example on how to remove the access permissions on the account `114240524784****` in the resource directory from the CloudSSO user `u-00q8wbq42wiltcrk****`. The access permissions are assigned by using the access configuration `ac-00jhtfl8thteu6uj****`.
6075
+ *
6076
+ * @param request DeleteAccessAssignmentRequest
6077
+ * @return DeleteAccessAssignmentResponse
6078
+ */
5289
6079
  async deleteAccessAssignment(request) {
5290
6080
  let runtime = new $Util.RuntimeOptions({});
5291
6081
  return await this.deleteAccessAssignmentWithOptions(request, runtime);
5292
6082
  }
6083
+ /**
6084
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
6085
+ * ## Prerequisites
6086
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
6087
+ *
6088
+ * @param request DeleteAccessConfigurationRequest
6089
+ * @param runtime runtime options for this request RuntimeOptions
6090
+ * @return DeleteAccessConfigurationResponse
6091
+ */
5293
6092
  async deleteAccessConfigurationWithOptions(request, runtime) {
5294
6093
  tea_util_1.default.validateModel(request);
5295
6094
  let query = {};
@@ -5318,10 +6117,33 @@ class Client extends openapi_client_1.default {
5318
6117
  });
5319
6118
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteAccessConfigurationResponse({}));
5320
6119
  }
6120
+ /**
6121
+ * This topic provides an example on how to delete the access configuration whose ID is `ac-001j9mcm3k7335bc****`.
6122
+ * ## Prerequisites
6123
+ * The access configuration that you want to delete is de-provisioned from the accounts in your resource directory. For more information, see [DeprovisionAccessConfiguration](~~338352~~).
6124
+ *
6125
+ * @param request DeleteAccessConfigurationRequest
6126
+ * @return DeleteAccessConfigurationResponse
6127
+ */
5321
6128
  async deleteAccessConfiguration(request) {
5322
6129
  let runtime = new $Util.RuntimeOptions({});
5323
6130
  return await this.deleteAccessConfigurationWithOptions(request, runtime);
5324
6131
  }
6132
+ /**
6133
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
6134
+ * ## Prerequisites
6135
+ * No resources are contained in the directory that you want to delete.
6136
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
6137
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
6138
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
6139
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
6140
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
6141
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
6142
+ *
6143
+ * @param request DeleteDirectoryRequest
6144
+ * @param runtime runtime options for this request RuntimeOptions
6145
+ * @return DeleteDirectoryResponse
6146
+ */
5325
6147
  async deleteDirectoryWithOptions(request, runtime) {
5326
6148
  tea_util_1.default.validateModel(request);
5327
6149
  let query = {};
@@ -5344,10 +6166,35 @@ class Client extends openapi_client_1.default {
5344
6166
  });
5345
6167
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteDirectoryResponse({}));
5346
6168
  }
6169
+ /**
6170
+ * This topic provides an example on how to delete a directory whose ID is `d-00fc2p61****`.
6171
+ * ## Prerequisites
6172
+ * No resources are contained in the directory that you want to delete.
6173
+ * * Access permissions on the accounts in your resource directory are removed from all users and groups. For more information, see [DeleteAccessAssignment](~~338350~~).
6174
+ * * Users are deleted. For more information, see [DeleteUser](~~341671~~).
6175
+ * * Groups are deleted. For more information, see [DeleteGroup](~~341821~~).
6176
+ * * Access configurations are deleted. For more information, see [DeleteAccessConfiguration](~~336907~~).
6177
+ * * System for Cross-domain Identity Management (SCIM) credentials are deleted. For more information, see [DeleteSCIMServerCredential](~~341842~~).
6178
+ * * SSO logon configurations are deleted. For more information, see [ClearExternalSAMLIdentityProvider](~~341573~~).
6179
+ *
6180
+ * @param request DeleteDirectoryRequest
6181
+ * @return DeleteDirectoryResponse
6182
+ */
5347
6183
  async deleteDirectory(request) {
5348
6184
  let runtime = new $Util.RuntimeOptions({});
5349
6185
  return await this.deleteDirectoryWithOptions(request, runtime);
5350
6186
  }
6187
+ /**
6188
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
6189
+ * ## Prerequisites
6190
+ * The group that you want to delete is not associated with the following resources. If the group is associated with the resources, the deletion fails.
6191
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
6192
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
6193
+ *
6194
+ * @param request DeleteGroupRequest
6195
+ * @param runtime runtime options for this request RuntimeOptions
6196
+ * @return DeleteGroupResponse
6197
+ */
5351
6198
  async deleteGroupWithOptions(request, runtime) {
5352
6199
  tea_util_1.default.validateModel(request);
5353
6200
  let query = {};
@@ -5373,10 +6220,27 @@ class Client extends openapi_client_1.default {
5373
6220
  });
5374
6221
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteGroupResponse({}));
5375
6222
  }
6223
+ /**
6224
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a group that is synchronized by using SCIM.
6225
+ * ## Prerequisites
6226
+ * The group that you want to delete is not associated with the following resources. If the group is associated with the resources, the deletion fails.
6227
+ * * Users: You must remove users from the group. For more information, see [RemoveUserFromGroup](~~335116~~).
6228
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the group. For more information, see [DeleteAccessAssignment](~~338350~~).
6229
+ *
6230
+ * @param request DeleteGroupRequest
6231
+ * @return DeleteGroupResponse
6232
+ */
5376
6233
  async deleteGroup(request) {
5377
6234
  let runtime = new $Util.RuntimeOptions({});
5378
6235
  return await this.deleteGroupWithOptions(request, runtime);
5379
6236
  }
6237
+ /**
6238
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
6239
+ *
6240
+ * @param request DeleteMFADeviceForUserRequest
6241
+ * @param runtime runtime options for this request RuntimeOptions
6242
+ * @return DeleteMFADeviceForUserResponse
6243
+ */
5380
6244
  async deleteMFADeviceForUserWithOptions(request, runtime) {
5381
6245
  tea_util_1.default.validateModel(request);
5382
6246
  let query = {};
@@ -5405,10 +6269,24 @@ class Client extends openapi_client_1.default {
5405
6269
  });
5406
6270
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteMFADeviceForUserResponse({}));
5407
6271
  }
6272
+ /**
6273
+ * This topic provides an example on how to unbind the MFA device `mfa-00ujhet8pycljj7j****` from the user `u-00q8wbq42wiltcrk****`.
6274
+ *
6275
+ * @param request DeleteMFADeviceForUserRequest
6276
+ * @return DeleteMFADeviceForUserResponse
6277
+ */
5408
6278
  async deleteMFADeviceForUser(request) {
5409
6279
  let runtime = new $Util.RuntimeOptions({});
5410
6280
  return await this.deleteMFADeviceForUserWithOptions(request, runtime);
5411
6281
  }
6282
+ /**
6283
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
6284
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
6285
+ *
6286
+ * @param request DeleteSCIMServerCredentialRequest
6287
+ * @param runtime runtime options for this request RuntimeOptions
6288
+ * @return DeleteSCIMServerCredentialResponse
6289
+ */
5412
6290
  async deleteSCIMServerCredentialWithOptions(request, runtime) {
5413
6291
  tea_util_1.default.validateModel(request);
5414
6292
  let query = {};
@@ -5434,10 +6312,29 @@ class Client extends openapi_client_1.default {
5434
6312
  });
5435
6313
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteSCIMServerCredentialResponse({}));
5436
6314
  }
6315
+ /**
6316
+ * After a SCIM credential is deleted, the synchronization task that uses the SCIM credential fails.
6317
+ * This topic provides an example on how to delete the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`.
6318
+ *
6319
+ * @param request DeleteSCIMServerCredentialRequest
6320
+ * @return DeleteSCIMServerCredentialResponse
6321
+ */
5437
6322
  async deleteSCIMServerCredential(request) {
5438
6323
  let runtime = new $Util.RuntimeOptions({});
5439
6324
  return await this.deleteSCIMServerCredentialWithOptions(request, runtime);
5440
6325
  }
6326
+ /**
6327
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
6328
+ * ## Prerequisites
6329
+ * The user that you want to delete is not associated with the following resources. If the user is associated with the resources, the deletion fails.
6330
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
6331
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
6332
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
6333
+ *
6334
+ * @param request DeleteUserRequest
6335
+ * @param runtime runtime options for this request RuntimeOptions
6336
+ * @return DeleteUserResponse
6337
+ */
5441
6338
  async deleteUserWithOptions(request, runtime) {
5442
6339
  tea_util_1.default.validateModel(request);
5443
6340
  let query = {};
@@ -5463,10 +6360,61 @@ class Client extends openapi_client_1.default {
5463
6360
  });
5464
6361
  return $tea.cast(await this.callApi(params, req, runtime), new DeleteUserResponse({}));
5465
6362
  }
6363
+ /**
6364
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot delete a user that is synchronized by using SCIM.
6365
+ * ## Prerequisites
6366
+ * The user that you want to delete is not associated with the following resources. If the user is associated with the resources, the deletion fails.
6367
+ * * Multi-factor authentication (MFA) devices: You must unbind the MFA devices from the user. For more information, see [DeleteMFADeviceForUser](~~341675~~).
6368
+ * * Access permissions: You must remove the access permissions on the accounts in your resource directory from the user. For more information, see [DeleteAccessAssignment](~~338350~~).
6369
+ * * Groups: You must remove the user from groups. For more information, see [RemoveUserFromGroup](~~335116~~).
6370
+ *
6371
+ * @param request DeleteUserRequest
6372
+ * @return DeleteUserResponse
6373
+ */
5466
6374
  async deleteUser(request) {
5467
6375
  let runtime = new $Util.RuntimeOptions({});
5468
6376
  return await this.deleteUserWithOptions(request, runtime);
5469
6377
  }
6378
+ async deleteUserProvisioningWithOptions(request, runtime) {
6379
+ tea_util_1.default.validateModel(request);
6380
+ let query = {};
6381
+ if (!tea_util_1.default.isUnset(request.deletionStrategy)) {
6382
+ query["DeletionStrategy"] = request.deletionStrategy;
6383
+ }
6384
+ if (!tea_util_1.default.isUnset(request.directoryId)) {
6385
+ query["DirectoryId"] = request.directoryId;
6386
+ }
6387
+ if (!tea_util_1.default.isUnset(request.userProvisioningId)) {
6388
+ query["UserProvisioningId"] = request.userProvisioningId;
6389
+ }
6390
+ let req = new $OpenApi.OpenApiRequest({
6391
+ query: openapi_util_1.default.query(query),
6392
+ });
6393
+ let params = new $OpenApi.Params({
6394
+ action: "DeleteUserProvisioning",
6395
+ version: "2021-05-15",
6396
+ protocol: "HTTPS",
6397
+ pathname: "/",
6398
+ method: "POST",
6399
+ authType: "AK",
6400
+ style: "RPC",
6401
+ reqBodyType: "formData",
6402
+ bodyType: "json",
6403
+ });
6404
+ return $tea.cast(await this.callApi(params, req, runtime), new DeleteUserProvisioningResponse({}));
6405
+ }
6406
+ async deleteUserProvisioning(request) {
6407
+ let runtime = new $Util.RuntimeOptions({});
6408
+ return await this.deleteUserProvisioningWithOptions(request, runtime);
6409
+ }
6410
+ /**
6411
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
6412
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
6413
+ *
6414
+ * @param request DeprovisionAccessConfigurationRequest
6415
+ * @param runtime runtime options for this request RuntimeOptions
6416
+ * @return DeprovisionAccessConfigurationResponse
6417
+ */
5470
6418
  async deprovisionAccessConfigurationWithOptions(request, runtime) {
5471
6419
  tea_util_1.default.validateModel(request);
5472
6420
  let query = {};
@@ -5498,10 +6446,24 @@ class Client extends openapi_client_1.default {
5498
6446
  });
5499
6447
  return $tea.cast(await this.callApi(params, req, runtime), new DeprovisionAccessConfigurationResponse({}));
5500
6448
  }
6449
+ /**
6450
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
6451
+ * This topic provides an example on how to de-provision the access configuration `ac-00jhtfl8thteu6uj****` from the account `114240524784****` in your resource directory.
6452
+ *
6453
+ * @param request DeprovisionAccessConfigurationRequest
6454
+ * @return DeprovisionAccessConfigurationResponse
6455
+ */
5501
6456
  async deprovisionAccessConfiguration(request) {
5502
6457
  let runtime = new $Util.RuntimeOptions({});
5503
6458
  return await this.deprovisionAccessConfigurationWithOptions(request, runtime);
5504
6459
  }
6460
+ /**
6461
+ * If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
6462
+ *
6463
+ * @param request DisableServiceRequest
6464
+ * @param runtime runtime options for this request RuntimeOptions
6465
+ * @return DisableServiceResponse
6466
+ */
5505
6467
  async disableServiceWithOptions(runtime) {
5506
6468
  let req = new $OpenApi.OpenApiRequest({});
5507
6469
  let params = new $OpenApi.Params({
@@ -5517,10 +6479,23 @@ class Client extends openapi_client_1.default {
5517
6479
  });
5518
6480
  return $tea.cast(await this.callApi(params, req, runtime), new DisableServiceResponse({}));
5519
6481
  }
6482
+ /**
6483
+ * If your CloudSSO has no directory, you can disable CloudSSO based on your business requirements. After you disable CloudSSO, you can enable it at any time.
6484
+ *
6485
+ * @return DisableServiceResponse
6486
+ */
5520
6487
  async disableService() {
5521
6488
  let runtime = new $Util.RuntimeOptions({});
5522
6489
  return await this.disableServiceWithOptions(runtime);
5523
6490
  }
6491
+ /**
6492
+ * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](~~262819~~).
6493
+ * If you call this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
6494
+ *
6495
+ * @param request EnableServiceRequest
6496
+ * @param runtime runtime options for this request RuntimeOptions
6497
+ * @return EnableServiceResponse
6498
+ */
5524
6499
  async enableServiceWithOptions(runtime) {
5525
6500
  let req = new $OpenApi.OpenApiRequest({});
5526
6501
  let params = new $OpenApi.Params({
@@ -5536,10 +6511,23 @@ class Client extends openapi_client_1.default {
5536
6511
  });
5537
6512
  return $tea.cast(await this.callApi(params, req, runtime), new EnableServiceResponse({}));
5538
6513
  }
6514
+ /**
6515
+ * You can call this operation only if your account belongs to the management account that is used to enable a resource directory and has permissions to enable CloudSSO. For more information, see [Enable CloudSSO](~~262819~~).
6516
+ * If you call this operation, you agree to the [Alibaba Cloud International Website Product Terms of Service](https://www.alibabacloud.com/help/doc-detail/42416.htm).
6517
+ *
6518
+ * @return EnableServiceResponse
6519
+ */
5539
6520
  async enableService() {
5540
6521
  let runtime = new $Util.RuntimeOptions({});
5541
6522
  return await this.enableServiceWithOptions(runtime);
5542
6523
  }
6524
+ /**
6525
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
6526
+ *
6527
+ * @param request GetAccessConfigurationRequest
6528
+ * @param runtime runtime options for this request RuntimeOptions
6529
+ * @return GetAccessConfigurationResponse
6530
+ */
5543
6531
  async getAccessConfigurationWithOptions(request, runtime) {
5544
6532
  tea_util_1.default.validateModel(request);
5545
6533
  let query = {};
@@ -5565,10 +6553,23 @@ class Client extends openapi_client_1.default {
5565
6553
  });
5566
6554
  return $tea.cast(await this.callApi(params, req, runtime), new GetAccessConfigurationResponse({}));
5567
6555
  }
6556
+ /**
6557
+ * This topic provides an example on how to query the information about the access configuration whose ID is `ac-00ccule7tadaijxc****`.
6558
+ *
6559
+ * @param request GetAccessConfigurationRequest
6560
+ * @return GetAccessConfigurationResponse
6561
+ */
5568
6562
  async getAccessConfiguration(request) {
5569
6563
  let runtime = new $Util.RuntimeOptions({});
5570
6564
  return await this.getAccessConfigurationWithOptions(request, runtime);
5571
6565
  }
6566
+ /**
6567
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
6568
+ *
6569
+ * @param request GetDirectoryRequest
6570
+ * @param runtime runtime options for this request RuntimeOptions
6571
+ * @return GetDirectoryResponse
6572
+ */
5572
6573
  async getDirectoryWithOptions(request, runtime) {
5573
6574
  tea_util_1.default.validateModel(request);
5574
6575
  let query = {};
@@ -5591,10 +6592,24 @@ class Client extends openapi_client_1.default {
5591
6592
  });
5592
6593
  return $tea.cast(await this.callApi(params, req, runtime), new GetDirectoryResponse({}));
5593
6594
  }
6595
+ /**
6596
+ * This topic provides an example on how to query information about the directory whose ID is `d-00fc2p61****`.
6597
+ *
6598
+ * @param request GetDirectoryRequest
6599
+ * @return GetDirectoryResponse
6600
+ */
5594
6601
  async getDirectory(request) {
5595
6602
  let runtime = new $Util.RuntimeOptions({});
5596
6603
  return await this.getDirectoryWithOptions(request, runtime);
5597
6604
  }
6605
+ /**
6606
+ * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
6607
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
6608
+ *
6609
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
6610
+ * @param runtime runtime options for this request RuntimeOptions
6611
+ * @return GetDirectorySAMLServiceProviderInfoResponse
6612
+ */
5598
6613
  async getDirectorySAMLServiceProviderInfoWithOptions(request, runtime) {
5599
6614
  tea_util_1.default.validateModel(request);
5600
6615
  let query = {};
@@ -5617,10 +6632,27 @@ class Client extends openapi_client_1.default {
5617
6632
  });
5618
6633
  return $tea.cast(await this.callApi(params, req, runtime), new GetDirectorySAMLServiceProviderInfoResponse({}));
5619
6634
  }
6635
+ /**
6636
+ * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an identity provider (IdP).
6637
+ * This topic provides an example on how to query the information about the SP within the directory `d-00fc2p61****`.
6638
+ *
6639
+ * @param request GetDirectorySAMLServiceProviderInfoRequest
6640
+ * @return GetDirectorySAMLServiceProviderInfoResponse
6641
+ */
5620
6642
  async getDirectorySAMLServiceProviderInfo(request) {
5621
6643
  let runtime = new $Util.RuntimeOptions({});
5622
6644
  return await this.getDirectorySAMLServiceProviderInfoWithOptions(request, runtime);
5623
6645
  }
6646
+ /**
6647
+ * ### [](#)
6648
+ * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
6649
+ * ### [](#qps)Limit
6650
+ * You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.
6651
+ *
6652
+ * @param request GetDirectoryStatisticsRequest
6653
+ * @param runtime runtime options for this request RuntimeOptions
6654
+ * @return GetDirectoryStatisticsResponse
6655
+ */
5624
6656
  async getDirectoryStatisticsWithOptions(request, runtime) {
5625
6657
  tea_util_1.default.validateModel(request);
5626
6658
  let query = {};
@@ -5643,10 +6675,26 @@ class Client extends openapi_client_1.default {
5643
6675
  });
5644
6676
  return $tea.cast(await this.callApi(params, req, runtime), new GetDirectoryStatisticsResponse({}));
5645
6677
  }
6678
+ /**
6679
+ * ### [](#)
6680
+ * This topic provides an example on how to query the statistics of a directory whose ID is `d-00fc2p61****`. The statistics include the number of users, quota for users, number of groups, quota for groups, number of access configurations, quota for access configurations, quota for system policies that can be configured for an access configuration, number of access permissions that are assigned, number of System for Cross-domain Identity Management (SCIM) credentials, number of asynchronous tasks, status of single sign-on (SSO), and status of SCIM synchronization.
6681
+ * ### [](#qps)Limit
6682
+ * You can call this operation up to 100 times per second per account. This operation is globally limited to 100 times per second across all accounts. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.
6683
+ *
6684
+ * @param request GetDirectoryStatisticsRequest
6685
+ * @return GetDirectoryStatisticsResponse
6686
+ */
5646
6687
  async getDirectoryStatistics(request) {
5647
6688
  let runtime = new $Util.RuntimeOptions({});
5648
6689
  return await this.getDirectoryStatisticsWithOptions(request, runtime);
5649
6690
  }
6691
+ /**
6692
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
6693
+ *
6694
+ * @param request GetExternalSAMLIdentityProviderRequest
6695
+ * @param runtime runtime options for this request RuntimeOptions
6696
+ * @return GetExternalSAMLIdentityProviderResponse
6697
+ */
5650
6698
  async getExternalSAMLIdentityProviderWithOptions(request, runtime) {
5651
6699
  tea_util_1.default.validateModel(request);
5652
6700
  let query = {};
@@ -5669,10 +6717,23 @@ class Client extends openapi_client_1.default {
5669
6717
  });
5670
6718
  return $tea.cast(await this.callApi(params, req, runtime), new GetExternalSAMLIdentityProviderResponse({}));
5671
6719
  }
6720
+ /**
6721
+ * This topic provides an example on how to query the configurations of the SAML IdP within the directory `d-00fc2p61****`.
6722
+ *
6723
+ * @param request GetExternalSAMLIdentityProviderRequest
6724
+ * @return GetExternalSAMLIdentityProviderResponse
6725
+ */
5672
6726
  async getExternalSAMLIdentityProvider(request) {
5673
6727
  let runtime = new $Util.RuntimeOptions({});
5674
6728
  return await this.getExternalSAMLIdentityProviderWithOptions(request, runtime);
5675
6729
  }
6730
+ /**
6731
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
6732
+ *
6733
+ * @param request GetGroupRequest
6734
+ * @param runtime runtime options for this request RuntimeOptions
6735
+ * @return GetGroupResponse
6736
+ */
5676
6737
  async getGroupWithOptions(request, runtime) {
5677
6738
  tea_util_1.default.validateModel(request);
5678
6739
  let query = {};
@@ -5698,10 +6759,65 @@ class Client extends openapi_client_1.default {
5698
6759
  });
5699
6760
  return $tea.cast(await this.callApi(params, req, runtime), new GetGroupResponse({}));
5700
6761
  }
6762
+ /**
6763
+ * This topic provides an example on how to query the information about the group `g-00jqzghi2n3o5hkh****` in the directory `d-00fc2p61****`.
6764
+ *
6765
+ * @param request GetGroupRequest
6766
+ * @return GetGroupResponse
6767
+ */
5701
6768
  async getGroup(request) {
5702
6769
  let runtime = new $Util.RuntimeOptions({});
5703
6770
  return await this.getGroupWithOptions(request, runtime);
5704
6771
  }
6772
+ /**
6773
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
6774
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
6775
+ *
6776
+ * @param request GetMFAAuthenticationSettingInfoRequest
6777
+ * @param runtime runtime options for this request RuntimeOptions
6778
+ * @return GetMFAAuthenticationSettingInfoResponse
6779
+ */
6780
+ async getMFAAuthenticationSettingInfoWithOptions(request, runtime) {
6781
+ tea_util_1.default.validateModel(request);
6782
+ let query = {};
6783
+ if (!tea_util_1.default.isUnset(request.directoryId)) {
6784
+ query["DirectoryId"] = request.directoryId;
6785
+ }
6786
+ let req = new $OpenApi.OpenApiRequest({
6787
+ query: openapi_util_1.default.query(query),
6788
+ });
6789
+ let params = new $OpenApi.Params({
6790
+ action: "GetMFAAuthenticationSettingInfo",
6791
+ version: "2021-05-15",
6792
+ protocol: "HTTPS",
6793
+ pathname: "/",
6794
+ method: "POST",
6795
+ authType: "AK",
6796
+ style: "RPC",
6797
+ reqBodyType: "formData",
6798
+ bodyType: "json",
6799
+ });
6800
+ return $tea.cast(await this.callApi(params, req, runtime), new GetMFAAuthenticationSettingInfoResponse({}));
6801
+ }
6802
+ /**
6803
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
6804
+ * This topic provides an example on how to query the MFA setting of all CloudSSO users that belong to the directory named `00q8wbq42wiltcrk****`.
6805
+ *
6806
+ * @param request GetMFAAuthenticationSettingInfoRequest
6807
+ * @return GetMFAAuthenticationSettingInfoResponse
6808
+ */
6809
+ async getMFAAuthenticationSettingInfo(request) {
6810
+ let runtime = new $Util.RuntimeOptions({});
6811
+ return await this.getMFAAuthenticationSettingInfoWithOptions(request, runtime);
6812
+ }
6813
+ /**
6814
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
6815
+ * This topic provides an example on how to query the MFA setting of the users that belong to the directory named `d-00fc2p61****`. The returned result shows that MFA is enabled for all the users.
6816
+ *
6817
+ * @param request GetMFAAuthenticationSettingsRequest
6818
+ * @param runtime runtime options for this request RuntimeOptions
6819
+ * @return GetMFAAuthenticationSettingsResponse
6820
+ */
5705
6821
  async getMFAAuthenticationSettingsWithOptions(request, runtime) {
5706
6822
  tea_util_1.default.validateModel(request);
5707
6823
  let query = {};
@@ -5724,10 +6840,24 @@ class Client extends openapi_client_1.default {
5724
6840
  });
5725
6841
  return $tea.cast(await this.callApi(params, req, runtime), new GetMFAAuthenticationSettingsResponse({}));
5726
6842
  }
6843
+ /**
6844
+ * > This operation is no longer maintained and updated. You can call the [GetMFAAuthenticationSettingInfo](~~611286~~) operation to query more detailed information.
6845
+ * This topic provides an example on how to query the MFA setting of the users that belong to the directory named `d-00fc2p61****`. The returned result shows that MFA is enabled for all the users.
6846
+ *
6847
+ * @param request GetMFAAuthenticationSettingsRequest
6848
+ * @return GetMFAAuthenticationSettingsResponse
6849
+ */
5727
6850
  async getMFAAuthenticationSettings(request) {
5728
6851
  let runtime = new $Util.RuntimeOptions({});
5729
6852
  return await this.getMFAAuthenticationSettingsWithOptions(request, runtime);
5730
6853
  }
6854
+ /**
6855
+ * This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
6856
+ *
6857
+ * @param request GetMFAAuthenticationStatusRequest
6858
+ * @param runtime runtime options for this request RuntimeOptions
6859
+ * @return GetMFAAuthenticationStatusResponse
6860
+ */
5731
6861
  async getMFAAuthenticationStatusWithOptions(request, runtime) {
5732
6862
  tea_util_1.default.validateModel(request);
5733
6863
  let query = {};
@@ -5750,10 +6880,23 @@ class Client extends openapi_client_1.default {
5750
6880
  });
5751
6881
  return $tea.cast(await this.callApi(params, req, runtime), new GetMFAAuthenticationStatusResponse({}));
5752
6882
  }
6883
+ /**
6884
+ * This topic provides an example on how to check whether MFA is enabled for users in the directory whose ID is `00fc2p61****`. The returned result shows that MFA is in the Enabled state.
6885
+ *
6886
+ * @param request GetMFAAuthenticationStatusRequest
6887
+ * @return GetMFAAuthenticationStatusResponse
6888
+ */
5753
6889
  async getMFAAuthenticationStatus(request) {
5754
6890
  let runtime = new $Util.RuntimeOptions({});
5755
6891
  return await this.getMFAAuthenticationStatusWithOptions(request, runtime);
5756
6892
  }
6893
+ /**
6894
+ * This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
6895
+ *
6896
+ * @param request GetSCIMSynchronizationStatusRequest
6897
+ * @param runtime runtime options for this request RuntimeOptions
6898
+ * @return GetSCIMSynchronizationStatusResponse
6899
+ */
5757
6900
  async getSCIMSynchronizationStatusWithOptions(request, runtime) {
5758
6901
  tea_util_1.default.validateModel(request);
5759
6902
  let query = {};
@@ -5776,6 +6919,12 @@ class Client extends openapi_client_1.default {
5776
6919
  });
5777
6920
  return $tea.cast(await this.callApi(params, req, runtime), new GetSCIMSynchronizationStatusResponse({}));
5778
6921
  }
6922
+ /**
6923
+ * This topic provides an example on how to query the status of SCIM synchronization within the directory `d-00fc2p61****`. The returned result shows that SCIM synchronization is in the Enabled state.
6924
+ *
6925
+ * @param request GetSCIMSynchronizationStatusRequest
6926
+ * @return GetSCIMSynchronizationStatusResponse
6927
+ */
5779
6928
  async getSCIMSynchronizationStatus(request) {
5780
6929
  let runtime = new $Util.RuntimeOptions({});
5781
6930
  return await this.getSCIMSynchronizationStatusWithOptions(request, runtime);
@@ -5799,6 +6948,13 @@ class Client extends openapi_client_1.default {
5799
6948
  let runtime = new $Util.RuntimeOptions({});
5800
6949
  return await this.getServiceStatusWithOptions(runtime);
5801
6950
  }
6951
+ /**
6952
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
6953
+ *
6954
+ * @param request GetTaskRequest
6955
+ * @param runtime runtime options for this request RuntimeOptions
6956
+ * @return GetTaskResponse
6957
+ */
5802
6958
  async getTaskWithOptions(request, runtime) {
5803
6959
  tea_util_1.default.validateModel(request);
5804
6960
  let query = {};
@@ -5824,10 +6980,24 @@ class Client extends openapi_client_1.default {
5824
6980
  });
5825
6981
  return $tea.cast(await this.callApi(params, req, runtime), new GetTaskResponse({}));
5826
6982
  }
6983
+ /**
6984
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
6985
+ *
6986
+ * @param request GetTaskRequest
6987
+ * @return GetTaskResponse
6988
+ */
5827
6989
  async getTask(request) {
5828
6990
  let runtime = new $Util.RuntimeOptions({});
5829
6991
  return await this.getTaskWithOptions(request, runtime);
5830
6992
  }
6993
+ /**
6994
+ * You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, you can call the [GetTask](~~340670~~) operation.
6995
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
6996
+ *
6997
+ * @param request GetTaskStatusRequest
6998
+ * @param runtime runtime options for this request RuntimeOptions
6999
+ * @return GetTaskStatusResponse
7000
+ */
5831
7001
  async getTaskStatusWithOptions(request, runtime) {
5832
7002
  tea_util_1.default.validateModel(request);
5833
7003
  let query = {};
@@ -5853,10 +7023,24 @@ class Client extends openapi_client_1.default {
5853
7023
  });
5854
7024
  return $tea.cast(await this.callApi(params, req, runtime), new GetTaskStatusResponse({}));
5855
7025
  }
7026
+ /**
7027
+ * You can call the GetTaskStatus operation to query the status of an asynchronous task. If you want to query more information about an asynchronous task, you can call the [GetTask](~~340670~~) operation.
7028
+ * This topic provides an example on how to query the information about the task whose ID is `t-shfqw1u1edszvxw5****`.
7029
+ *
7030
+ * @param request GetTaskStatusRequest
7031
+ * @return GetTaskStatusResponse
7032
+ */
5856
7033
  async getTaskStatus(request) {
5857
7034
  let runtime = new $Util.RuntimeOptions({});
5858
7035
  return await this.getTaskStatusWithOptions(request, runtime);
5859
7036
  }
7037
+ /**
7038
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
7039
+ *
7040
+ * @param request GetUserRequest
7041
+ * @param runtime runtime options for this request RuntimeOptions
7042
+ * @return GetUserResponse
7043
+ */
5860
7044
  async getUserWithOptions(request, runtime) {
5861
7045
  tea_util_1.default.validateModel(request);
5862
7046
  let query = {};
@@ -5882,10 +7066,23 @@ class Client extends openapi_client_1.default {
5882
7066
  });
5883
7067
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserResponse({}));
5884
7068
  }
7069
+ /**
7070
+ * This topic provides an example on how to query information about the user whose ID is `u-00q8wbq42wiltcrk****` in the `d-00fc2p61****` directory.
7071
+ *
7072
+ * @param request GetUserRequest
7073
+ * @return GetUserResponse
7074
+ */
5885
7075
  async getUser(request) {
5886
7076
  let runtime = new $Util.RuntimeOptions({});
5887
7077
  return await this.getUserWithOptions(request, runtime);
5888
7078
  }
7079
+ /**
7080
+ * This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
7081
+ *
7082
+ * @param request GetUserMFAAuthenticationSettingsRequest
7083
+ * @param runtime runtime options for this request RuntimeOptions
7084
+ * @return GetUserMFAAuthenticationSettingsResponse
7085
+ */
5889
7086
  async getUserMFAAuthenticationSettingsWithOptions(request, runtime) {
5890
7087
  tea_util_1.default.validateModel(request);
5891
7088
  let query = {};
@@ -5911,10 +7108,52 @@ class Client extends openapi_client_1.default {
5911
7108
  });
5912
7109
  return $tea.cast(await this.callApi(params, req, runtime), new GetUserMFAAuthenticationSettingsResponse({}));
5913
7110
  }
7111
+ /**
7112
+ * This topic provides an example on how to query the MFA setting of the user named `u-00q8wbq42wiltcrk****`. The returned result shows that MFA is enabled for the user.
7113
+ *
7114
+ * @param request GetUserMFAAuthenticationSettingsRequest
7115
+ * @return GetUserMFAAuthenticationSettingsResponse
7116
+ */
5914
7117
  async getUserMFAAuthenticationSettings(request) {
5915
7118
  let runtime = new $Util.RuntimeOptions({});
5916
7119
  return await this.getUserMFAAuthenticationSettingsWithOptions(request, runtime);
5917
7120
  }
7121
+ async getUserProvisioningWithOptions(request, runtime) {
7122
+ tea_util_1.default.validateModel(request);
7123
+ let query = {};
7124
+ if (!tea_util_1.default.isUnset(request.directoryId)) {
7125
+ query["DirectoryId"] = request.directoryId;
7126
+ }
7127
+ if (!tea_util_1.default.isUnset(request.userProvisioningId)) {
7128
+ query["UserProvisioningId"] = request.userProvisioningId;
7129
+ }
7130
+ let req = new $OpenApi.OpenApiRequest({
7131
+ query: openapi_util_1.default.query(query),
7132
+ });
7133
+ let params = new $OpenApi.Params({
7134
+ action: "GetUserProvisioning",
7135
+ version: "2021-05-15",
7136
+ protocol: "HTTPS",
7137
+ pathname: "/",
7138
+ method: "POST",
7139
+ authType: "AK",
7140
+ style: "RPC",
7141
+ reqBodyType: "formData",
7142
+ bodyType: "json",
7143
+ });
7144
+ return $tea.cast(await this.callApi(params, req, runtime), new GetUserProvisioningResponse({}));
7145
+ }
7146
+ async getUserProvisioning(request) {
7147
+ let runtime = new $Util.RuntimeOptions({});
7148
+ return await this.getUserProvisioningWithOptions(request, runtime);
7149
+ }
7150
+ /**
7151
+ * This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
7152
+ *
7153
+ * @param request ListAccessAssignmentsRequest
7154
+ * @param runtime runtime options for this request RuntimeOptions
7155
+ * @return ListAccessAssignmentsResponse
7156
+ */
5918
7157
  async listAccessAssignmentsWithOptions(request, runtime) {
5919
7158
  tea_util_1.default.validateModel(request);
5920
7159
  let query = {};
@@ -5958,10 +7197,23 @@ class Client extends openapi_client_1.default {
5958
7197
  });
5959
7198
  return $tea.cast(await this.callApi(params, req, runtime), new ListAccessAssignmentsResponse({}));
5960
7199
  }
7200
+ /**
7201
+ * This topic provides an example on how to query the assigned access permissions on the account `114240524784****` in your resource directory. The returned result shows that access permissions on the account in your resource directory is assigned to one user.
7202
+ *
7203
+ * @param request ListAccessAssignmentsRequest
7204
+ * @return ListAccessAssignmentsResponse
7205
+ */
5961
7206
  async listAccessAssignments(request) {
5962
7207
  let runtime = new $Util.RuntimeOptions({});
5963
7208
  return await this.listAccessAssignmentsWithOptions(request, runtime);
5964
7209
  }
7210
+ /**
7211
+ * This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
7212
+ *
7213
+ * @param request ListAccessConfigurationProvisioningsRequest
7214
+ * @param runtime runtime options for this request RuntimeOptions
7215
+ * @return ListAccessConfigurationProvisioningsResponse
7216
+ */
5965
7217
  async listAccessConfigurationProvisioningsWithOptions(request, runtime) {
5966
7218
  tea_util_1.default.validateModel(request);
5967
7219
  let query = {};
@@ -6002,10 +7254,23 @@ class Client extends openapi_client_1.default {
6002
7254
  });
6003
7255
  return $tea.cast(await this.callApi(params, req, runtime), new ListAccessConfigurationProvisioningsResponse({}));
6004
7256
  }
7257
+ /**
7258
+ * This topic provides an example on how to query the accounts for which the access permission `ac-00ccule7tadaijxc****` is provisioned. The returned result shows that the access configuration is provisioned for two accounts in your resource directory.
7259
+ *
7260
+ * @param request ListAccessConfigurationProvisioningsRequest
7261
+ * @return ListAccessConfigurationProvisioningsResponse
7262
+ */
6005
7263
  async listAccessConfigurationProvisionings(request) {
6006
7264
  let runtime = new $Util.RuntimeOptions({});
6007
7265
  return await this.listAccessConfigurationProvisioningsWithOptions(request, runtime);
6008
7266
  }
7267
+ /**
7268
+ * This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
7269
+ *
7270
+ * @param request ListAccessConfigurationsRequest
7271
+ * @param runtime runtime options for this request RuntimeOptions
7272
+ * @return ListAccessConfigurationsResponse
7273
+ */
6009
7274
  async listAccessConfigurationsWithOptions(request, runtime) {
6010
7275
  tea_util_1.default.validateModel(request);
6011
7276
  let query = {};
@@ -6040,10 +7305,23 @@ class Client extends openapi_client_1.default {
6040
7305
  });
6041
7306
  return $tea.cast(await this.callApi(params, req, runtime), new ListAccessConfigurationsResponse({}));
6042
7307
  }
7308
+ /**
7309
+ * This topic provides an example on how to query the access configurations within the directory `d-00fc2p61****`. The returned result shows that the directory contains the `VPC-Admin` and `ECS-Admin` access configurations.
7310
+ *
7311
+ * @param request ListAccessConfigurationsRequest
7312
+ * @return ListAccessConfigurationsResponse
7313
+ */
6043
7314
  async listAccessConfigurations(request) {
6044
7315
  let runtime = new $Util.RuntimeOptions({});
6045
7316
  return await this.listAccessConfigurationsWithOptions(request, runtime);
6046
7317
  }
7318
+ /**
7319
+ * This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
7320
+ *
7321
+ * @param request ListDirectoriesRequest
7322
+ * @param runtime runtime options for this request RuntimeOptions
7323
+ * @return ListDirectoriesResponse
7324
+ */
6047
7325
  async listDirectoriesWithOptions(runtime) {
6048
7326
  let req = new $OpenApi.OpenApiRequest({});
6049
7327
  let params = new $OpenApi.Params({
@@ -6059,10 +7337,22 @@ class Client extends openapi_client_1.default {
6059
7337
  });
6060
7338
  return $tea.cast(await this.callApi(params, req, runtime), new ListDirectoriesResponse({}));
6061
7339
  }
7340
+ /**
7341
+ * This topic provides an example on how to query the directories within your Alibaba Cloud account. The returned result shows that only one directory with the ID `d-00fc2p61****` is created within your Alibaba Cloud account.
7342
+ *
7343
+ * @return ListDirectoriesResponse
7344
+ */
6062
7345
  async listDirectories() {
6063
7346
  let runtime = new $Util.RuntimeOptions({});
6064
7347
  return await this.listDirectoriesWithOptions(runtime);
6065
7348
  }
7349
+ /**
7350
+ * This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
7351
+ *
7352
+ * @param request ListExternalSAMLIdPCertificatesRequest
7353
+ * @param runtime runtime options for this request RuntimeOptions
7354
+ * @return ListExternalSAMLIdPCertificatesResponse
7355
+ */
6066
7356
  async listExternalSAMLIdPCertificatesWithOptions(request, runtime) {
6067
7357
  tea_util_1.default.validateModel(request);
6068
7358
  let query = {};
@@ -6085,10 +7375,23 @@ class Client extends openapi_client_1.default {
6085
7375
  });
6086
7376
  return $tea.cast(await this.callApi(params, req, runtime), new ListExternalSAMLIdPCertificatesResponse({}));
6087
7377
  }
7378
+ /**
7379
+ * This topic provides an example on how to query the SAML signing certificates within the directory `d-00fc2p61****`. The returned result shows that the directory contains one SAML signing certificate.
7380
+ *
7381
+ * @param request ListExternalSAMLIdPCertificatesRequest
7382
+ * @return ListExternalSAMLIdPCertificatesResponse
7383
+ */
6088
7384
  async listExternalSAMLIdPCertificates(request) {
6089
7385
  let runtime = new $Util.RuntimeOptions({});
6090
7386
  return await this.listExternalSAMLIdPCertificatesWithOptions(request, runtime);
6091
7387
  }
7388
+ /**
7389
+ * This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
7390
+ *
7391
+ * @param request ListGroupMembersRequest
7392
+ * @param runtime runtime options for this request RuntimeOptions
7393
+ * @return ListGroupMembersResponse
7394
+ */
6092
7395
  async listGroupMembersWithOptions(request, runtime) {
6093
7396
  tea_util_1.default.validateModel(request);
6094
7397
  let query = {};
@@ -6120,10 +7423,23 @@ class Client extends openapi_client_1.default {
6120
7423
  });
6121
7424
  return $tea.cast(await this.callApi(params, req, runtime), new ListGroupMembersResponse({}));
6122
7425
  }
7426
+ /**
7427
+ * This topic provides an example on how to query the users in the group `g-00jqzghi2n3o5hkh****`. The returned result shows that the group contains the user `Alice` and the user `user1`.
7428
+ *
7429
+ * @param request ListGroupMembersRequest
7430
+ * @return ListGroupMembersResponse
7431
+ */
6123
7432
  async listGroupMembers(request) {
6124
7433
  let runtime = new $Util.RuntimeOptions({});
6125
7434
  return await this.listGroupMembersWithOptions(request, runtime);
6126
7435
  }
7436
+ /**
7437
+ * This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
7438
+ *
7439
+ * @param request ListGroupsRequest
7440
+ * @param runtime runtime options for this request RuntimeOptions
7441
+ * @return ListGroupsResponse
7442
+ */
6127
7443
  async listGroupsWithOptions(request, runtime) {
6128
7444
  tea_util_1.default.validateModel(request);
6129
7445
  let query = {};
@@ -6158,10 +7474,23 @@ class Client extends openapi_client_1.default {
6158
7474
  });
6159
7475
  return $tea.cast(await this.callApi(params, req, runtime), new ListGroupsResponse({}));
6160
7476
  }
7477
+ /**
7478
+ * This topic provides an example on how to query the groups in the directory `d-00fc2p61****`. The returned result shows that the directory contains three groups. The groups `group1` and `group2` are synchronized from an external identity provider (IdP). The group `TestGroup` is manually created in CloudSSO.
7479
+ *
7480
+ * @param request ListGroupsRequest
7481
+ * @return ListGroupsResponse
7482
+ */
6161
7483
  async listGroups(request) {
6162
7484
  let runtime = new $Util.RuntimeOptions({});
6163
7485
  return await this.listGroupsWithOptions(request, runtime);
6164
7486
  }
7487
+ /**
7488
+ * This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
7489
+ *
7490
+ * @param request ListJoinedGroupsForUserRequest
7491
+ * @param runtime runtime options for this request RuntimeOptions
7492
+ * @return ListJoinedGroupsForUserResponse
7493
+ */
6165
7494
  async listJoinedGroupsForUserWithOptions(request, runtime) {
6166
7495
  tea_util_1.default.validateModel(request);
6167
7496
  let query = {};
@@ -6193,10 +7522,23 @@ class Client extends openapi_client_1.default {
6193
7522
  });
6194
7523
  return $tea.cast(await this.callApi(params, req, runtime), new ListJoinedGroupsForUserResponse({}));
6195
7524
  }
7525
+ /**
7526
+ * This topic provides an example on how to query the groups to which the user `u-00q8wbq42wiltcrk****` is added. The returned result shows that the user is added to both the `TestGroup` and the `group1` groups.
7527
+ *
7528
+ * @param request ListJoinedGroupsForUserRequest
7529
+ * @return ListJoinedGroupsForUserResponse
7530
+ */
6196
7531
  async listJoinedGroupsForUser(request) {
6197
7532
  let runtime = new $Util.RuntimeOptions({});
6198
7533
  return await this.listJoinedGroupsForUserWithOptions(request, runtime);
6199
7534
  }
7535
+ /**
7536
+ * This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
7537
+ *
7538
+ * @param request ListMFADevicesForUserRequest
7539
+ * @param runtime runtime options for this request RuntimeOptions
7540
+ * @return ListMFADevicesForUserResponse
7541
+ */
6200
7542
  async listMFADevicesForUserWithOptions(request, runtime) {
6201
7543
  tea_util_1.default.validateModel(request);
6202
7544
  let query = {};
@@ -6222,10 +7564,23 @@ class Client extends openapi_client_1.default {
6222
7564
  });
6223
7565
  return $tea.cast(await this.callApi(params, req, runtime), new ListMFADevicesForUserResponse({}));
6224
7566
  }
7567
+ /**
7568
+ * This topic provides an example on how to query the MFA devices that are bound to the user `u-00q8wbq42wiltcrk****`. The returned result shows that the MFA device named `Alice-MFA1` is bound to the user.
7569
+ *
7570
+ * @param request ListMFADevicesForUserRequest
7571
+ * @return ListMFADevicesForUserResponse
7572
+ */
6225
7573
  async listMFADevicesForUser(request) {
6226
7574
  let runtime = new $Util.RuntimeOptions({});
6227
7575
  return await this.listMFADevicesForUserWithOptions(request, runtime);
6228
7576
  }
7577
+ /**
7578
+ * This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
7579
+ *
7580
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
7581
+ * @param runtime runtime options for this request RuntimeOptions
7582
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
7583
+ */
6229
7584
  async listPermissionPoliciesInAccessConfigurationWithOptions(request, runtime) {
6230
7585
  tea_util_1.default.validateModel(request);
6231
7586
  let query = {};
@@ -6254,10 +7609,23 @@ class Client extends openapi_client_1.default {
6254
7609
  });
6255
7610
  return $tea.cast(await this.callApi(params, req, runtime), new ListPermissionPoliciesInAccessConfigurationResponse({}));
6256
7611
  }
7612
+ /**
7613
+ * This topic provides an example on how to query the policies that are created for the access configuration `ac-00jhtfl8thteu6uj****`. The returned result shows that the access configuration contains one system policy and one inline policy.
7614
+ *
7615
+ * @param request ListPermissionPoliciesInAccessConfigurationRequest
7616
+ * @return ListPermissionPoliciesInAccessConfigurationResponse
7617
+ */
6257
7618
  async listPermissionPoliciesInAccessConfiguration(request) {
6258
7619
  let runtime = new $Util.RuntimeOptions({});
6259
7620
  return await this.listPermissionPoliciesInAccessConfigurationWithOptions(request, runtime);
6260
7621
  }
7622
+ /**
7623
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
7624
+ *
7625
+ * @param request ListSCIMServerCredentialsRequest
7626
+ * @param runtime runtime options for this request RuntimeOptions
7627
+ * @return ListSCIMServerCredentialsResponse
7628
+ */
6261
7629
  async listSCIMServerCredentialsWithOptions(request, runtime) {
6262
7630
  tea_util_1.default.validateModel(request);
6263
7631
  let query = {};
@@ -6280,10 +7648,24 @@ class Client extends openapi_client_1.default {
6280
7648
  });
6281
7649
  return $tea.cast(await this.callApi(params, req, runtime), new ListSCIMServerCredentialsResponse({}));
6282
7650
  }
7651
+ /**
7652
+ * This topic provides an example on how to query the SCIM credentials within the `d-00fc2p61****` directory.
7653
+ *
7654
+ * @param request ListSCIMServerCredentialsRequest
7655
+ * @return ListSCIMServerCredentialsResponse
7656
+ */
6283
7657
  async listSCIMServerCredentials(request) {
6284
7658
  let runtime = new $Util.RuntimeOptions({});
6285
7659
  return await this.listSCIMServerCredentialsWithOptions(request, runtime);
6286
7660
  }
7661
+ /**
7662
+ * By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
7663
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
7664
+ *
7665
+ * @param request ListTasksRequest
7666
+ * @param runtime runtime options for this request RuntimeOptions
7667
+ * @return ListTasksResponse
7668
+ */
6287
7669
  async listTasksWithOptions(request, runtime) {
6288
7670
  tea_util_1.default.validateModel(request);
6289
7671
  let query = {};
@@ -6336,10 +7718,68 @@ class Client extends openapi_client_1.default {
6336
7718
  });
6337
7719
  return $tea.cast(await this.callApi(params, req, runtime), new ListTasksResponse({}));
6338
7720
  }
7721
+ /**
7722
+ * By default, this operation queries the tasks within the previous 24 hours. This operation allows you to query the tasks within a maximum of 7 days. You can specify the start time of the query by using `Filter`.
7723
+ * This topic provides an example on how to query the tasks within the previous 24 hours.
7724
+ *
7725
+ * @param request ListTasksRequest
7726
+ * @return ListTasksResponse
7727
+ */
6339
7728
  async listTasks(request) {
6340
7729
  let runtime = new $Util.RuntimeOptions({});
6341
7730
  return await this.listTasksWithOptions(request, runtime);
6342
7731
  }
7732
+ async listUserProvisioningsWithOptions(request, runtime) {
7733
+ tea_util_1.default.validateModel(request);
7734
+ let query = {};
7735
+ if (!tea_util_1.default.isUnset(request.directoryId)) {
7736
+ query["DirectoryId"] = request.directoryId;
7737
+ }
7738
+ if (!tea_util_1.default.isUnset(request.maxResults)) {
7739
+ query["MaxResults"] = request.maxResults;
7740
+ }
7741
+ if (!tea_util_1.default.isUnset(request.nextToken)) {
7742
+ query["NextToken"] = request.nextToken;
7743
+ }
7744
+ if (!tea_util_1.default.isUnset(request.principalId)) {
7745
+ query["PrincipalId"] = request.principalId;
7746
+ }
7747
+ if (!tea_util_1.default.isUnset(request.principalType)) {
7748
+ query["PrincipalType"] = request.principalType;
7749
+ }
7750
+ if (!tea_util_1.default.isUnset(request.targetId)) {
7751
+ query["TargetId"] = request.targetId;
7752
+ }
7753
+ if (!tea_util_1.default.isUnset(request.targetType)) {
7754
+ query["TargetType"] = request.targetType;
7755
+ }
7756
+ let req = new $OpenApi.OpenApiRequest({
7757
+ query: openapi_util_1.default.query(query),
7758
+ });
7759
+ let params = new $OpenApi.Params({
7760
+ action: "ListUserProvisionings",
7761
+ version: "2021-05-15",
7762
+ protocol: "HTTPS",
7763
+ pathname: "/",
7764
+ method: "POST",
7765
+ authType: "AK",
7766
+ style: "RPC",
7767
+ reqBodyType: "formData",
7768
+ bodyType: "json",
7769
+ });
7770
+ return $tea.cast(await this.callApi(params, req, runtime), new ListUserProvisioningsResponse({}));
7771
+ }
7772
+ async listUserProvisionings(request) {
7773
+ let runtime = new $Util.RuntimeOptions({});
7774
+ return await this.listUserProvisioningsWithOptions(request, runtime);
7775
+ }
7776
+ /**
7777
+ * This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
7778
+ *
7779
+ * @param request ListUsersRequest
7780
+ * @param runtime runtime options for this request RuntimeOptions
7781
+ * @return ListUsersResponse
7782
+ */
6343
7783
  async listUsersWithOptions(request, runtime) {
6344
7784
  tea_util_1.default.validateModel(request);
6345
7785
  let query = {};
@@ -6377,10 +7817,24 @@ class Client extends openapi_client_1.default {
6377
7817
  });
6378
7818
  return $tea.cast(await this.callApi(params, req, runtime), new ListUsersResponse({}));
6379
7819
  }
7820
+ /**
7821
+ * This topic provides an example on how to query users in the `d-00fc2p61****` directory. The returned result shows that the directory contains two users. The user `AliceLee` is synchronized from an external identity provider (IdP). The user `user1` is manually created within CloudSSO.
7822
+ *
7823
+ * @param request ListUsersRequest
7824
+ * @return ListUsersResponse
7825
+ */
6380
7826
  async listUsers(request) {
6381
7827
  let runtime = new $Util.RuntimeOptions({});
6382
7828
  return await this.listUsersWithOptions(request, runtime);
6383
7829
  }
7830
+ /**
7831
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7832
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
7833
+ *
7834
+ * @param request ProvisionAccessConfigurationRequest
7835
+ * @param runtime runtime options for this request RuntimeOptions
7836
+ * @return ProvisionAccessConfigurationResponse
7837
+ */
6384
7838
  async provisionAccessConfigurationWithOptions(request, runtime) {
6385
7839
  tea_util_1.default.validateModel(request);
6386
7840
  let query = {};
@@ -6412,10 +7866,24 @@ class Client extends openapi_client_1.default {
6412
7866
  });
6413
7867
  return $tea.cast(await this.callApi(params, req, runtime), new ProvisionAccessConfigurationResponse({}));
6414
7868
  }
7869
+ /**
7870
+ * When you call this operation, an asynchronous task is automatically created. You can call the [GetTask](~~340670~~) operation to query the progress of the task based on the value of the `TaskId` response parameter.
7871
+ * This topic provides an example on how to provision the access configuration `ac-00jhtfl8thteu6uj****` for the account `114240524784****` in your resource directory.
7872
+ *
7873
+ * @param request ProvisionAccessConfigurationRequest
7874
+ * @return ProvisionAccessConfigurationResponse
7875
+ */
6415
7876
  async provisionAccessConfiguration(request) {
6416
7877
  let runtime = new $Util.RuntimeOptions({});
6417
7878
  return await this.provisionAccessConfigurationWithOptions(request, runtime);
6418
7879
  }
7880
+ /**
7881
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
7882
+ *
7883
+ * @param request RemoveExternalSAMLIdPCertificateRequest
7884
+ * @param runtime runtime options for this request RuntimeOptions
7885
+ * @return RemoveExternalSAMLIdPCertificateResponse
7886
+ */
6419
7887
  async removeExternalSAMLIdPCertificateWithOptions(request, runtime) {
6420
7888
  tea_util_1.default.validateModel(request);
6421
7889
  let query = {};
@@ -6441,10 +7909,24 @@ class Client extends openapi_client_1.default {
6441
7909
  });
6442
7910
  return $tea.cast(await this.callApi(params, req, runtime), new RemoveExternalSAMLIdPCertificateResponse({}));
6443
7911
  }
7912
+ /**
7913
+ * This topic provides an example on how to remove the SAML signing certificate whose ID is `idp-c-00dt9gnl7fmjaw9c****`.
7914
+ *
7915
+ * @param request RemoveExternalSAMLIdPCertificateRequest
7916
+ * @return RemoveExternalSAMLIdPCertificateResponse
7917
+ */
6444
7918
  async removeExternalSAMLIdPCertificate(request) {
6445
7919
  let runtime = new $Util.RuntimeOptions({});
6446
7920
  return await this.removeExternalSAMLIdPCertificateWithOptions(request, runtime);
6447
7921
  }
7922
+ /**
7923
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
7924
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
7925
+ *
7926
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
7927
+ * @param runtime runtime options for this request RuntimeOptions
7928
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
7929
+ */
6448
7930
  async removePermissionPolicyFromAccessConfigurationWithOptions(request, runtime) {
6449
7931
  tea_util_1.default.validateModel(request);
6450
7932
  let query = {};
@@ -6476,10 +7958,25 @@ class Client extends openapi_client_1.default {
6476
7958
  });
6477
7959
  return $tea.cast(await this.callApi(params, req, runtime), new RemovePermissionPolicyFromAccessConfigurationResponse({}));
6478
7960
  }
7961
+ /**
7962
+ * After you remove an inline policy from an access configuration, the policy cannot be restored.
7963
+ * This topic provides an example on how to remove the system policy `AliyunECSFullAccess` from the access configuration `ac-00jhtfl8thteu6uj****`.
7964
+ *
7965
+ * @param request RemovePermissionPolicyFromAccessConfigurationRequest
7966
+ * @return RemovePermissionPolicyFromAccessConfigurationResponse
7967
+ */
6479
7968
  async removePermissionPolicyFromAccessConfiguration(request) {
6480
7969
  let runtime = new $Util.RuntimeOptions({});
6481
7970
  return await this.removePermissionPolicyFromAccessConfigurationWithOptions(request, runtime);
6482
7971
  }
7972
+ /**
7973
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
7974
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
7975
+ *
7976
+ * @param request RemoveUserFromGroupRequest
7977
+ * @param runtime runtime options for this request RuntimeOptions
7978
+ * @return RemoveUserFromGroupResponse
7979
+ */
6483
7980
  async removeUserFromGroupWithOptions(request, runtime) {
6484
7981
  tea_util_1.default.validateModel(request);
6485
7982
  let query = {};
@@ -6508,10 +8005,26 @@ class Client extends openapi_client_1.default {
6508
8005
  });
6509
8006
  return $tea.cast(await this.callApi(params, req, runtime), new RemoveUserFromGroupResponse({}));
6510
8007
  }
8008
+ /**
8009
+ * If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot remove a user from a group that is synchronized by using SCIM.
8010
+ * This topic provides an example on how to remove the user `u-00q8wbq42wiltcrk****` from the group `g-00jqzghi2n3o5hkh****`.
8011
+ *
8012
+ * @param request RemoveUserFromGroupRequest
8013
+ * @return RemoveUserFromGroupResponse
8014
+ */
6511
8015
  async removeUserFromGroup(request) {
6512
8016
  let runtime = new $Util.RuntimeOptions({});
6513
8017
  return await this.removeUserFromGroupWithOptions(request, runtime);
6514
8018
  }
8019
+ /**
8020
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
8021
+ * > After you enable SSO logon, your password cannot be reset.
8022
+ * This topic provides an example on how to reset the password of the user `u-00q8wbq42wiltcrk****`. The new password is automatically generated by the system.
8023
+ *
8024
+ * @param request ResetUserPasswordRequest
8025
+ * @param runtime runtime options for this request RuntimeOptions
8026
+ * @return ResetUserPasswordResponse
8027
+ */
6515
8028
  async resetUserPasswordWithOptions(request, runtime) {
6516
8029
  tea_util_1.default.validateModel(request);
6517
8030
  let query = {};
@@ -6546,10 +8059,33 @@ class Client extends openapi_client_1.default {
6546
8059
  });
6547
8060
  return $tea.cast(await this.callApi(params, req, runtime), new ResetUserPasswordResponse({}));
6548
8061
  }
8062
+ /**
8063
+ * If you forget your password or your password expires or is at risk, you must contact a CloudSSO administrator to reset your password.
8064
+ * > After you enable SSO logon, your password cannot be reset.
8065
+ * This topic provides an example on how to reset the password of the user `u-00q8wbq42wiltcrk****`. The new password is automatically generated by the system.
8066
+ *
8067
+ * @param request ResetUserPasswordRequest
8068
+ * @return ResetUserPasswordResponse
8069
+ */
6549
8070
  async resetUserPassword(request) {
6550
8071
  let runtime = new $Util.RuntimeOptions({});
6551
8072
  return await this.resetUserPasswordWithOptions(request, runtime);
6552
8073
  }
8074
+ /**
8075
+ * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
8076
+ * You can use one of the following methods to configure a SAML IdP. You can obtain the required metadata file or parameter values from your IdP.
8077
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
8078
+ * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
8079
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
8080
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
8081
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
8082
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
8083
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
8084
+ *
8085
+ * @param request SetExternalSAMLIdentityProviderRequest
8086
+ * @param runtime runtime options for this request RuntimeOptions
8087
+ * @return SetExternalSAMLIdentityProviderResponse
8088
+ */
6553
8089
  async setExternalSAMLIdentityProviderWithOptions(request, runtime) {
6554
8090
  tea_util_1.default.validateModel(request);
6555
8091
  let query = {};
@@ -6590,10 +8126,32 @@ class Client extends openapi_client_1.default {
6590
8126
  });
6591
8127
  return $tea.cast(await this.callApi(params, req, runtime), new SetExternalSAMLIdentityProviderResponse({}));
6592
8128
  }
8129
+ /**
8130
+ * During SAML 2.0-based single sign-on (SSO) logon, CloudSSO is an SP, and the identity management system of an enterprise is an IdP.
8131
+ * You can use one of the following methods to configure a SAML IdP. You can obtain the required metadata file or parameter values from your IdP.
8132
+ * * Use the metadata file. You can specify the `EncodedMetadataDocument` parameter to upload the metadata file.
8133
+ * * Manually configure the IdP. You can manually specify the following parameters for your IdP: `EntityId`, `LoginUrl`, `WantRequestSigned`, and `X509Certificate`.
8134
+ * If you have configured a SAML IdP, the existing configurations are replaced after you call this operation.
8135
+ * * If the IdP is configured by using the metadata file, all existing configurations are replaced with new configurations.
8136
+ * * If the IdP is manually configured, the original parameter values that are different from the new parameter values are replaced.
8137
+ * > If SSO logon is enabled, new configurations immediately take effect. Take note of the impacts on the production environment.
8138
+ * This topic provides an example on how to configure an IdP by using the metadata file within the directory `d-00fc2p61****`.
8139
+ *
8140
+ * @param request SetExternalSAMLIdentityProviderRequest
8141
+ * @return SetExternalSAMLIdentityProviderResponse
8142
+ */
6593
8143
  async setExternalSAMLIdentityProvider(request) {
6594
8144
  let runtime = new $Util.RuntimeOptions({});
6595
8145
  return await this.setExternalSAMLIdentityProviderWithOptions(request, runtime);
6596
8146
  }
8147
+ /**
8148
+ * If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
8149
+ * This topic provides an example on how to enable MFA for users.
8150
+ *
8151
+ * @param request SetMFAAuthenticationStatusRequest
8152
+ * @param runtime runtime options for this request RuntimeOptions
8153
+ * @return SetMFAAuthenticationStatusResponse
8154
+ */
6597
8155
  async setMFAAuthenticationStatusWithOptions(request, runtime) {
6598
8156
  tea_util_1.default.validateModel(request);
6599
8157
  let query = {};
@@ -6619,10 +8177,27 @@ class Client extends openapi_client_1.default {
6619
8177
  });
6620
8178
  return $tea.cast(await this.callApi(params, req, runtime), new SetMFAAuthenticationStatusResponse({}));
6621
8179
  }
8180
+ /**
8181
+ * If a CloudSSO administrator enables username-password logon for users, CloudSSO automatically enables MFA to improve security. The administrator can call this operation to enable or disable MFA based on the business requirements.
8182
+ * This topic provides an example on how to enable MFA for users.
8183
+ *
8184
+ * @param request SetMFAAuthenticationStatusRequest
8185
+ * @return SetMFAAuthenticationStatusResponse
8186
+ */
6622
8187
  async setMFAAuthenticationStatus(request) {
6623
8188
  let runtime = new $Util.RuntimeOptions({});
6624
8189
  return await this.setMFAAuthenticationStatusWithOptions(request, runtime);
6625
8190
  }
8191
+ /**
8192
+ * You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
8193
+ * * After you enable SCIM synchronization, you cannot modify or delete the users or groups that are synchronized to CloudSSO by using SCIM. In addition, you cannot add users to or remove users from the groups. However, you can change the passwords of the users and enable or disable the logon of the users.
8194
+ * * After you disable SCIM synchronization, you can modify and delete the users and groups that are synchronized to CloudSSO by using SCIM. You can also add users to or remove users from the groups.
8195
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
8196
+ *
8197
+ * @param request SetSCIMSynchronizationStatusRequest
8198
+ * @param runtime runtime options for this request RuntimeOptions
8199
+ * @return SetSCIMSynchronizationStatusResponse
8200
+ */
6626
8201
  async setSCIMSynchronizationStatusWithOptions(request, runtime) {
6627
8202
  tea_util_1.default.validateModel(request);
6628
8203
  let query = {};
@@ -6648,10 +8223,27 @@ class Client extends openapi_client_1.default {
6648
8223
  });
6649
8224
  return $tea.cast(await this.callApi(params, req, runtime), new SetSCIMSynchronizationStatusResponse({}));
6650
8225
  }
8226
+ /**
8227
+ * You can synchronize users or groups from an external identity provider (IdP) that supports SCIM 2.0 to CloudSSO only after SCIM synchronization is enabled. If you disable SCIM synchronization, you can no longer synchronize users or groups to CloudSSO. The following list describes the impacts after SCIM synchronization is enabled or disabled:
8228
+ * * After you enable SCIM synchronization, you cannot modify or delete the users or groups that are synchronized to CloudSSO by using SCIM. In addition, you cannot add users to or remove users from the groups. However, you can change the passwords of the users and enable or disable the logon of the users.
8229
+ * * After you disable SCIM synchronization, you can modify and delete the users and groups that are synchronized to CloudSSO by using SCIM. You can also add users to or remove users from the groups.
8230
+ * This topic provides an example on how to enable SCIM synchronization within the directory `d-00fc2p61****`.
8231
+ *
8232
+ * @param request SetSCIMSynchronizationStatusRequest
8233
+ * @return SetSCIMSynchronizationStatusResponse
8234
+ */
6651
8235
  async setSCIMSynchronizationStatus(request) {
6652
8236
  let runtime = new $Util.RuntimeOptions({});
6653
8237
  return await this.setSCIMSynchronizationStatusWithOptions(request, runtime);
6654
8238
  }
8239
+ /**
8240
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
8241
+ * This topic provides an example on how to change the initial web page in the access configuration `ac-00jhtfl8thteu6uj****` to `https://cloudsso.console.aliyun.com`.
8242
+ *
8243
+ * @param request UpdateAccessConfigurationRequest
8244
+ * @param runtime runtime options for this request RuntimeOptions
8245
+ * @return UpdateAccessConfigurationResponse
8246
+ */
6655
8247
  async updateAccessConfigurationWithOptions(request, runtime) {
6656
8248
  tea_util_1.default.validateModel(request);
6657
8249
  let query = {};
@@ -6686,10 +8278,25 @@ class Client extends openapi_client_1.default {
6686
8278
  });
6687
8279
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateAccessConfigurationResponse({}));
6688
8280
  }
8281
+ /**
8282
+ * You can modify the `Description`, `SessionDuration`, and `RelayState` parameters for an access configuration.
8283
+ * This topic provides an example on how to change the initial web page in the access configuration `ac-00jhtfl8thteu6uj****` to `https://cloudsso.console.aliyun.com`.
8284
+ *
8285
+ * @param request UpdateAccessConfigurationRequest
8286
+ * @return UpdateAccessConfigurationResponse
8287
+ */
6689
8288
  async updateAccessConfiguration(request) {
6690
8289
  let runtime = new $Util.RuntimeOptions({});
6691
8290
  return await this.updateAccessConfigurationWithOptions(request, runtime);
6692
8291
  }
8292
+ /**
8293
+ * After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
8294
+ * This topic provides an example on how to change the name of a directory to `new-example`.
8295
+ *
8296
+ * @param request UpdateDirectoryRequest
8297
+ * @param runtime runtime options for this request RuntimeOptions
8298
+ * @return UpdateDirectoryResponse
8299
+ */
6693
8300
  async updateDirectoryWithOptions(request, runtime) {
6694
8301
  tea_util_1.default.validateModel(request);
6695
8302
  let query = {};
@@ -6715,10 +8322,26 @@ class Client extends openapi_client_1.default {
6715
8322
  });
6716
8323
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateDirectoryResponse({}));
6717
8324
  }
8325
+ /**
8326
+ * After you change the name of a directory, the URL that is used to log on to the Cloud SSO user portal is changed. You must notify the Cloud SSO users of the correct URL.
8327
+ * This topic provides an example on how to change the name of a directory to `new-example`.
8328
+ *
8329
+ * @param request UpdateDirectoryRequest
8330
+ * @return UpdateDirectoryResponse
8331
+ */
6718
8332
  async updateDirectory(request) {
6719
8333
  let runtime = new $Util.RuntimeOptions({});
6720
8334
  return await this.updateDirectoryWithOptions(request, runtime);
6721
8335
  }
8336
+ /**
8337
+ * You can modify `GroupName` and `Description` for a group.
8338
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a group that is synchronized by using SCIM.
8339
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
8340
+ *
8341
+ * @param request UpdateGroupRequest
8342
+ * @param runtime runtime options for this request RuntimeOptions
8343
+ * @return UpdateGroupResponse
8344
+ */
6722
8345
  async updateGroupWithOptions(request, runtime) {
6723
8346
  tea_util_1.default.validateModel(request);
6724
8347
  let query = {};
@@ -6750,10 +8373,25 @@ class Client extends openapi_client_1.default {
6750
8373
  });
6751
8374
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateGroupResponse({}));
6752
8375
  }
8376
+ /**
8377
+ * You can modify `GroupName` and `Description` for a group.
8378
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a group that is synchronized by using SCIM.
8379
+ * This topic provides an example on how to change the name of the group `g-00jqzghi2n3o5hkh****` to `NewTestGroup`.
8380
+ *
8381
+ * @param request UpdateGroupRequest
8382
+ * @return UpdateGroupResponse
8383
+ */
6753
8384
  async updateGroup(request) {
6754
8385
  let runtime = new $Util.RuntimeOptions({});
6755
8386
  return await this.updateGroupWithOptions(request, runtime);
6756
8387
  }
8388
+ /**
8389
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
8390
+ *
8391
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
8392
+ * @param runtime runtime options for this request RuntimeOptions
8393
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
8394
+ */
6757
8395
  async updateInlinePolicyForAccessConfigurationWithOptions(request, runtime) {
6758
8396
  tea_util_1.default.validateModel(request);
6759
8397
  let query = {};
@@ -6785,10 +8423,24 @@ class Client extends openapi_client_1.default {
6785
8423
  });
6786
8424
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateInlinePolicyForAccessConfigurationResponse({}));
6787
8425
  }
8426
+ /**
8427
+ * This topic provides an example on how to modify an inline policy that is created for the access configuration `ac-00jhtfl8thteu6uj****`.
8428
+ *
8429
+ * @param request UpdateInlinePolicyForAccessConfigurationRequest
8430
+ * @return UpdateInlinePolicyForAccessConfigurationResponse
8431
+ */
6788
8432
  async updateInlinePolicyForAccessConfiguration(request) {
6789
8433
  let runtime = new $Util.RuntimeOptions({});
6790
8434
  return await this.updateInlinePolicyForAccessConfigurationWithOptions(request, runtime);
6791
8435
  }
8436
+ /**
8437
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
8438
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
8439
+ *
8440
+ * @param request UpdateMFAAuthenticationSettingsRequest
8441
+ * @param runtime runtime options for this request RuntimeOptions
8442
+ * @return UpdateMFAAuthenticationSettingsResponse
8443
+ */
6792
8444
  async updateMFAAuthenticationSettingsWithOptions(request, runtime) {
6793
8445
  tea_util_1.default.validateModel(request);
6794
8446
  let query = {};
@@ -6817,10 +8469,24 @@ class Client extends openapi_client_1.default {
6817
8469
  });
6818
8470
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateMFAAuthenticationSettingsResponse({}));
6819
8471
  }
8472
+ /**
8473
+ * If you enable username-password logon for CloudSSO users, you can also configure MFA for the users.
8474
+ * This topic provides an example on how to enable MFA for all CloudSSO users that belong to the directory named `d-00fc2p61****`.
8475
+ *
8476
+ * @param request UpdateMFAAuthenticationSettingsRequest
8477
+ * @return UpdateMFAAuthenticationSettingsResponse
8478
+ */
6820
8479
  async updateMFAAuthenticationSettings(request) {
6821
8480
  let runtime = new $Util.RuntimeOptions({});
6822
8481
  return await this.updateMFAAuthenticationSettingsWithOptions(request, runtime);
6823
8482
  }
8483
+ /**
8484
+ * This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
8485
+ *
8486
+ * @param request UpdateSCIMServerCredentialStatusRequest
8487
+ * @param runtime runtime options for this request RuntimeOptions
8488
+ * @return UpdateSCIMServerCredentialStatusResponse
8489
+ */
6824
8490
  async updateSCIMServerCredentialStatusWithOptions(request, runtime) {
6825
8491
  tea_util_1.default.validateModel(request);
6826
8492
  let query = {};
@@ -6849,10 +8515,25 @@ class Client extends openapi_client_1.default {
6849
8515
  });
6850
8516
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateSCIMServerCredentialStatusResponse({}));
6851
8517
  }
8518
+ /**
8519
+ * This topic provides an example on how to disable the SCIM credential whose ID is `scimcred-004whl0kvfwcypbi****`. After the SCIM credential is disabled, the synchronization task that uses the SCIM credential fails. You can call this operation again to enable the SCIM credential.
8520
+ *
8521
+ * @param request UpdateSCIMServerCredentialStatusRequest
8522
+ * @return UpdateSCIMServerCredentialStatusResponse
8523
+ */
6852
8524
  async updateSCIMServerCredentialStatus(request) {
6853
8525
  let runtime = new $Util.RuntimeOptions({});
6854
8526
  return await this.updateSCIMServerCredentialStatusWithOptions(request, runtime);
6855
8527
  }
8528
+ /**
8529
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
8530
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a user that is synchronized by using SCIM.
8531
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
8532
+ *
8533
+ * @param request UpdateUserRequest
8534
+ * @param runtime runtime options for this request RuntimeOptions
8535
+ * @return UpdateUserResponse
8536
+ */
6856
8537
  async updateUserWithOptions(request, runtime) {
6857
8538
  tea_util_1.default.validateModel(request);
6858
8539
  let query = {};
@@ -6893,10 +8574,27 @@ class Client extends openapi_client_1.default {
6893
8574
  });
6894
8575
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserResponse({}));
6895
8576
  }
8577
+ /**
8578
+ * You can modify `FirstName`, `LastName`, `DisplayName`, `Email`, and `Description` for a user. You cannot modify `UserName` for a user.
8579
+ * > If System for Cross-domain Identity Management (SCIM) synchronization is enabled, you cannot modify the information about a user that is synchronized by using SCIM.
8580
+ * This topic provides an example on how to change the email address of the user whose ID is `u-00q8wbq42wiltcrk****` to `AliceLee@example.com`.
8581
+ *
8582
+ * @param request UpdateUserRequest
8583
+ * @return UpdateUserResponse
8584
+ */
6896
8585
  async updateUser(request) {
6897
8586
  let runtime = new $Util.RuntimeOptions({});
6898
8587
  return await this.updateUserWithOptions(request, runtime);
6899
8588
  }
8589
+ /**
8590
+ * If you call the [UpdateMFAAuthenticationSettings](~~450134~~) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
8591
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
8592
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
8593
+ *
8594
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
8595
+ * @param runtime runtime options for this request RuntimeOptions
8596
+ * @return UpdateUserMFAAuthenticationSettingsResponse
8597
+ */
6900
8598
  async updateUserMFAAuthenticationSettingsWithOptions(request, runtime) {
6901
8599
  tea_util_1.default.validateModel(request);
6902
8600
  let query = {};
@@ -6925,10 +8623,63 @@ class Client extends openapi_client_1.default {
6925
8623
  });
6926
8624
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserMFAAuthenticationSettingsResponse({}));
6927
8625
  }
8626
+ /**
8627
+ * If you call the [UpdateMFAAuthenticationSettings](~~450134~~) operation to set the MFAAuthenticationSettings parameter to `Byuser`, user-specific settings are applied. Then, you must call the UpdateUserMFAAuthenticationSettings operation to configure MFA for each user.
8628
+ * By default, the MFAAuthenticationSettings parameter is set to `Enabled` for a new user.
8629
+ * This topic provides an example on how to enable MFA for the user named `u-00q8wbq42wiltcrk****`.
8630
+ *
8631
+ * @param request UpdateUserMFAAuthenticationSettingsRequest
8632
+ * @return UpdateUserMFAAuthenticationSettingsResponse
8633
+ */
6928
8634
  async updateUserMFAAuthenticationSettings(request) {
6929
8635
  let runtime = new $Util.RuntimeOptions({});
6930
8636
  return await this.updateUserMFAAuthenticationSettingsWithOptions(request, runtime);
6931
8637
  }
8638
+ async updateUserProvisioningWithOptions(request, runtime) {
8639
+ tea_util_1.default.validateModel(request);
8640
+ let query = {};
8641
+ if (!tea_util_1.default.isUnset(request.directoryId)) {
8642
+ query["DirectoryId"] = request.directoryId;
8643
+ }
8644
+ if (!tea_util_1.default.isUnset(request.newDeletionStrategy)) {
8645
+ query["NewDeletionStrategy"] = request.newDeletionStrategy;
8646
+ }
8647
+ if (!tea_util_1.default.isUnset(request.newDescription)) {
8648
+ query["NewDescription"] = request.newDescription;
8649
+ }
8650
+ if (!tea_util_1.default.isUnset(request.newDuplicationStrategy)) {
8651
+ query["NewDuplicationStrategy"] = request.newDuplicationStrategy;
8652
+ }
8653
+ if (!tea_util_1.default.isUnset(request.userProvisioningId)) {
8654
+ query["UserProvisioningId"] = request.userProvisioningId;
8655
+ }
8656
+ let req = new $OpenApi.OpenApiRequest({
8657
+ query: openapi_util_1.default.query(query),
8658
+ });
8659
+ let params = new $OpenApi.Params({
8660
+ action: "UpdateUserProvisioning",
8661
+ version: "2021-05-15",
8662
+ protocol: "HTTPS",
8663
+ pathname: "/",
8664
+ method: "POST",
8665
+ authType: "AK",
8666
+ style: "RPC",
8667
+ reqBodyType: "formData",
8668
+ bodyType: "json",
8669
+ });
8670
+ return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserProvisioningResponse({}));
8671
+ }
8672
+ async updateUserProvisioning(request) {
8673
+ let runtime = new $Util.RuntimeOptions({});
8674
+ return await this.updateUserProvisioningWithOptions(request, runtime);
8675
+ }
8676
+ /**
8677
+ * This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
8678
+ *
8679
+ * @param request UpdateUserStatusRequest
8680
+ * @param runtime runtime options for this request RuntimeOptions
8681
+ * @return UpdateUserStatusResponse
8682
+ */
6932
8683
  async updateUserStatusWithOptions(request, runtime) {
6933
8684
  tea_util_1.default.validateModel(request);
6934
8685
  let query = {};
@@ -6957,6 +8708,12 @@ class Client extends openapi_client_1.default {
6957
8708
  });
6958
8709
  return $tea.cast(await this.callApi(params, req, runtime), new UpdateUserStatusResponse({}));
6959
8710
  }
8711
+ /**
8712
+ * This topic provides an example on how to change the status of the user whose ID is `u-00q8wbq42wiltcrk****` to Disabled. Users in the Disabled state cannot log on to the CloudSSO user portal.
8713
+ *
8714
+ * @param request UpdateUserStatusRequest
8715
+ * @return UpdateUserStatusResponse
8716
+ */
6960
8717
  async updateUserStatus(request) {
6961
8718
  let runtime = new $Util.RuntimeOptions({});
6962
8719
  return await this.updateUserStatusWithOptions(request, runtime);