Skip to content

Commit 56c0717

Browse files
docs(iam): improve and add private beta disclosure to IAM members features (#1635)
Co-authored-by: Jonathan R. <[email protected]>
1 parent b003e17 commit 56c0717

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

packages/clients/src/api/iam/v1alpha1/api.gen.ts

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -351,7 +351,8 @@ export class API extends ParentAPI {
351351
)
352352

353353
/**
354-
* Update an user's password.
354+
* Update an user's password. Private Beta feature.. Update an user's
355+
* password. Private Beta feature.
355356
*
356357
* @param request - The request {@link UpdateUserPasswordRequest}
357358
* @returns A Promise of User
@@ -370,8 +371,8 @@ export class API extends ParentAPI {
370371
)
371372

372373
/**
373-
* Lock a user. Lock a user. Note that a locked user cannot log in or use API
374-
* keys until the locked status is removed.
374+
* Lock a member. Lock a member. A locked member cannot log in or use API keys
375+
* until the locked status is removed. Private Beta feature.
375376
*
376377
* @param request - The request {@link LockUserRequest}
377378
* @returns A Promise of User
@@ -388,7 +389,7 @@ export class API extends ParentAPI {
388389
)
389390

390391
/**
391-
* Unlock a user.
392+
* Unlock a member. Unlock a member. Private Beta feature.
392393
*
393394
* @param request - The request {@link UnlockUserRequest}
394395
* @returns A Promise of User
@@ -405,7 +406,8 @@ export class API extends ParentAPI {
405406
)
406407

407408
/**
408-
* List grace periods of a user. List the grace periods of a user.
409+
* List grace periods of a member. List the grace periods of a member. Private
410+
* Beta feature.
409411
*
410412
* @param request - The request {@link ListGracePeriodsRequest}
411413
* @returns A Promise of ListGracePeriodsResponse
@@ -1016,9 +1018,9 @@ export class API extends ParentAPI {
10161018
/**
10171019
* Create an API key. Create an API key. You must specify the `application_id`
10181020
* or the `user_id` and the description. You can also specify the
1019-
* `default_project_id` which is the Project ID of your preferred Project, to
1021+
* `default_project_id`, which is the Project ID of your preferred Project, to
10201022
* use with Object Storage. The `access_key` and `secret_key` values are
1021-
* returned in the response. Note that he secret key is only showed once. Make
1023+
* returned in the response. Note that the secret key is only shown once. Make
10221024
* sure that you copy and store both keys somewhere safe.
10231025
*
10241026
* @param request - The request {@link CreateAPIKeyRequest}

packages/clients/src/api/iam/v1alpha1/types.gen.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,7 @@ export type CreateUserRequest = {
596596
/** Tags associated with the user. */
597597
tags?: string[]
598598
/**
599-
* A new IAM Member to create.
599+
* Details of IAM member. Private Beta feature.
600600
*
601601
* One-of ('type'): at most one of 'email', 'member' could be set.
602602
*/
@@ -1126,6 +1126,6 @@ export type UpdateUserRequest = {
11261126
userId: string
11271127
/** New tags for the user (maximum of 10 tags). */
11281128
tags?: string[]
1129-
/** New email for the user (only available on Members). */
1129+
/** IAM member email. */
11301130
email?: string
11311131
}

0 commit comments

Comments
 (0)