@@ -18,14 +18,26 @@ static AsyncClient create() {
1818 return builder ().build ();
1919 }
2020
21+ /**
22+ * This topic provides an example on how to add the client ID `598469743454717****` to the OIDC IdP named `TestOIDCProvider`.
23+ *
24+ */
2125 CompletableFuture <AddClientIdToOIDCProviderResponse > addClientIdToOIDCProvider (AddClientIdToOIDCProviderRequest request );
2226
27+ /**
28+ * This topic provides an example on how to add the fingerprint `902ef2deeb3c5b13ea4c3d5193629309e231****` to the OIDC IdP named `TestOIDCProvider`.
29+ *
30+ */
2331 CompletableFuture <AddFingerprintToOIDCProviderResponse > addFingerprintToOIDCProvider (AddFingerprintToOIDCProviderRequest request );
2432
2533 CompletableFuture <AddUserToGroupResponse > addUserToGroup (AddUserToGroupRequest request );
2634
2735 CompletableFuture <BindMFADeviceResponse > bindMFADevice (BindMFADeviceRequest request );
2836
37+ /**
38+ * > This operation is available only for RAM users. Before you call this operation, make sure that `AllowUserToChangePassword` in [SetSecurityPreference](~~43765~~) is set to `True`. The value True indicates that RAM users can change their passwords.
39+ *
40+ */
2941 CompletableFuture <ChangePasswordResponse > changePassword (ChangePasswordRequest request );
3042
3143 CompletableFuture <CreateAccessKeyResponse > createAccessKey (CreateAccessKeyRequest request );
@@ -38,10 +50,24 @@ static AsyncClient create() {
3850
3951 CompletableFuture <CreateLoginProfileResponse > createLoginProfile (CreateLoginProfileRequest request );
4052
53+ /**
54+ * This topic provides an example on how to create an IdP named `TestOIDCProvider` to configure a trust relationship between the external IdP Okta and Alibaba Cloud.
55+ * ## Prerequisites
56+ * Before you call this operation, make sure that the information such as the URL of the issuer, the fingerprints of HTTPS certificates, and the client IDs are obtained from an external IdP, such as Google G Suite or Okta.
57+ * ## Limits
58+ * - You can create a maximum of 100 OIDC IdPs in an Alibaba Cloud account.
59+ * - You can add a maximum of 20 client IDs to an OIDC IdP.
60+ * - You can add a maximum of five fingerprints to an OIDC IdP.
61+ *
62+ */
4163 CompletableFuture <CreateOIDCProviderResponse > createOIDCProvider (CreateOIDCProviderRequest request );
4264
4365 CompletableFuture <CreateSAMLProviderResponse > createSAMLProvider (CreateSAMLProviderRequest request );
4466
67+ /**
68+ * This topic provides an example on how to create a RAM user named `test`.
69+ *
70+ */
4571 CompletableFuture <CreateUserResponse > createUser (CreateUserRequest request );
4672
4773 CompletableFuture <CreateVirtualMFADeviceResponse > createVirtualMFADevice (CreateVirtualMFADeviceRequest request );
@@ -52,10 +78,18 @@ static AsyncClient create() {
5278
5379 CompletableFuture <DeleteApplicationResponse > deleteApplication (DeleteApplicationRequest request );
5480
81+ /**
82+ * Before you delete a RAM user group, make sure that no policies are attached to the group and no RAM users are included in the group.
83+ *
84+ */
5585 CompletableFuture <DeleteGroupResponse > deleteGroup (DeleteGroupRequest request );
5686
5787 CompletableFuture <DeleteLoginProfileResponse > deleteLoginProfile (DeleteLoginProfileRequest request );
5888
89+ /**
90+ * This topic provides an example on how to remove the OIDC IdP named `TestOIDCProvider`.
91+ *
92+ */
5993 CompletableFuture <DeleteOIDCProviderResponse > deleteOIDCProvider (DeleteOIDCProviderRequest request );
6094
6195 CompletableFuture <DeleteSAMLProviderResponse > deleteSAMLProvider (DeleteSAMLProviderRequest request );
@@ -88,6 +122,10 @@ static AsyncClient create() {
88122
89123 CompletableFuture <GetLoginProfileResponse > getLoginProfile (GetLoginProfileRequest request );
90124
125+ /**
126+ * This topic provides an example on how to query the information about an OIDC IdP named `TestOIDCProvider`.
127+ *
128+ */
91129 CompletableFuture <GetOIDCProviderResponse > getOIDCProvider (GetOIDCProviderRequest request );
92130
93131 CompletableFuture <GetPasswordPolicyResponse > getPasswordPolicy (GetPasswordPolicyRequest request );
@@ -96,6 +134,10 @@ static AsyncClient create() {
96134
97135 CompletableFuture <GetSecurityPreferenceResponse > getSecurityPreference (GetSecurityPreferenceRequest request );
98136
137+ /**
138+ * This topic provides an example to show how to query the information about a RAM user named `test@example.onaliyun.com`.
139+ *
140+ */
99141 CompletableFuture <GetUserResponse > getUser (GetUserRequest request );
100142
101143 CompletableFuture <GetUserMFAInfoResponse > getUserMFAInfo (GetUserMFAInfoRequest request );
@@ -112,24 +154,55 @@ static AsyncClient create() {
112154
113155 CompletableFuture <ListGroupsForUserResponse > listGroupsForUser (ListGroupsForUserRequest request );
114156
157+ /**
158+ * This topic provides an example on how to query all OIDC IdPs within your Alibaba Cloud account. The response shows that your Alibaba Cloud account has only one OIDC IdP named `TestOIDCProvider`.
159+ *
160+ */
115161 CompletableFuture <ListOIDCProvidersResponse > listOIDCProviders (ListOIDCProvidersRequest request );
116162
117163 CompletableFuture <ListPredefinedScopesResponse > listPredefinedScopes (ListPredefinedScopesRequest request );
118164
119165 CompletableFuture <ListSAMLProvidersResponse > listSAMLProviders (ListSAMLProvidersRequest request );
120166
167+ /**
168+ * You must specify at least one of the following parameters or parameter pairs in a request to determine a query object:
169+ * * `ResourceId.N`
170+ * * `Tag.N.Key`
171+ * * `Tag.N.Key` and `Tag.N.Value`
172+ *
173+ */
121174 CompletableFuture <ListTagResourcesResponse > listTagResources (ListTagResourcesRequest request );
122175
176+ /**
177+ * You can call the following API operations to query the information about all RAM users:
178+ * * ListUsers: queries the details of all RAM users.
179+ * * ListUserBasicInfos: queries the basic information about all RAM users. The basic information includes only the logon names (`UserPrincipalName`), display names (`DisplayName`), and user IDs (`UserId`).
180+ *
181+ */
123182 CompletableFuture <ListUserBasicInfosResponse > listUserBasicInfos (ListUserBasicInfosRequest request );
124183
184+ /**
185+ * You can call the following API operations to query the information about all RAM users:
186+ * * ListUsers: queries the details of all RAM users.
187+ * * ListUserBasicInfos: queries the basic information about all RAM users. The basic information includes only the logon names (`UserPrincipalName`), display names (`DisplayName`), and user IDs (`UserId`).
188+ *
189+ */
125190 CompletableFuture <ListUsersResponse > listUsers (ListUsersRequest request );
126191
127192 CompletableFuture <ListUsersForGroupResponse > listUsersForGroup (ListUsersForGroupRequest request );
128193
129194 CompletableFuture <ListVirtualMFADevicesResponse > listVirtualMFADevices (ListVirtualMFADevicesRequest request );
130195
196+ /**
197+ * This topic provides an example on how to remove the client ID `498469743454717****` from the OIDC IdP named `TestOIDCProvider`.
198+ *
199+ */
131200 CompletableFuture <RemoveClientIdFromOIDCProviderResponse > removeClientIdFromOIDCProvider (RemoveClientIdFromOIDCProviderRequest request );
132201
202+ /**
203+ * This topic provides an example on how to remove the fingerprint `6938fd4d98bab03faadb97b34396831e3780****` from the OIDC IdP named `TestOIDCProvider`.
204+ *
205+ */
133206 CompletableFuture <RemoveFingerprintFromOIDCProviderResponse > removeFingerprintFromOIDCProvider (RemoveFingerprintFromOIDCProviderRequest request );
134207
135208 CompletableFuture <RemoveUserFromGroupResponse > removeUserFromGroup (RemoveUserFromGroupRequest request );
@@ -138,6 +211,10 @@ static AsyncClient create() {
138211
139212 CompletableFuture <SetPasswordPolicyResponse > setPasswordPolicy (SetPasswordPolicyRequest request );
140213
214+ /**
215+ * This topic provides an example on how to enable multi-factor authentication (MFA) only for RAM users who initiated unusual logons.
216+ *
217+ */
141218 CompletableFuture <SetSecurityPreferenceResponse > setSecurityPreference (SetSecurityPreferenceRequest request );
142219
143220 CompletableFuture <SetUserSsoSettingsResponse > setUserSsoSettings (SetUserSsoSettingsRequest request );
@@ -156,10 +233,22 @@ static AsyncClient create() {
156233
157234 CompletableFuture <UpdateLoginProfileResponse > updateLoginProfile (UpdateLoginProfileRequest request );
158235
236+ /**
237+ * This topic provides an example on how to change the description of the OIDC IdP named `TestOIDCProvider` to `This is a new OIDC Provider.`
238+ *
239+ */
159240 CompletableFuture <UpdateOIDCProviderResponse > updateOIDCProvider (UpdateOIDCProviderRequest request );
160241
242+ /**
243+ * This topic provides an example on how to change the description of an IdP named `test-provider` to `This is a new provider.`
244+ *
245+ */
161246 CompletableFuture <UpdateSAMLProviderResponse > updateSAMLProvider (UpdateSAMLProviderRequest request );
162247
248+ /**
249+ * This topic provides an example to show how to modify the name of a RAM user from `test@example.onaliyun.com` to `new@example.onaliyun.com`.
250+ *
251+ */
163252 CompletableFuture <UpdateUserResponse > updateUser (UpdateUserRequest request );
164253
165254}
0 commit comments