Skip to content

docs(iam): improve and add private beta disclosure to IAM members features #1635

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 9, 2024
Merged

docs(iam): improve and add private beta disclosure to IAM members features #1635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a453cf9
feat: update generated APIs
scaleway-bot Dec 6, 2024
149ae9c
Merge branch 'main' into v1.5854.0
jremy42 Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions packages/clients/src/api/iam/v1alpha1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,8 @@ export class API extends ParentAPI {
)

/**
* Update an user's password.
* Update an user's password. Private Beta feature.. Update an user's
* password. Private Beta feature.
*
* @param request - The request {@link UpdateUserPasswordRequest}
* @returns A Promise of User
Expand All @@ -370,8 +371,8 @@ export class API extends ParentAPI {
)

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

/**
* Unlock a user.
* Unlock a member. Unlock a member. Private Beta feature.
*
* @param request - The request {@link UnlockUserRequest}
* @returns A Promise of User
Expand All @@ -405,7 +406,8 @@ export class API extends ParentAPI {
)

/**
* List grace periods of a user. List the grace periods of a user.
* List grace periods of a member. List the grace periods of a member. Private
* Beta feature.
*
* @param request - The request {@link ListGracePeriodsRequest}
* @returns A Promise of ListGracePeriodsResponse
Expand Down Expand Up @@ -1016,9 +1018,9 @@ export class API extends ParentAPI {
/**
* Create an API key. Create an API key. You must specify the `application_id`
* or the `user_id` and the description. You can also specify the
* `default_project_id` which is the Project ID of your preferred Project, to
* `default_project_id`, which is the Project ID of your preferred Project, to
* use with Object Storage. The `access_key` and `secret_key` values are
* returned in the response. Note that he secret key is only showed once. Make
* returned in the response. Note that the secret key is only shown once. Make
* sure that you copy and store both keys somewhere safe.
*
* @param request - The request {@link CreateAPIKeyRequest}
Expand Down
4 changes: 2 additions & 2 deletions packages/clients/src/api/iam/v1alpha1/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ export type CreateUserRequest = {
/** Tags associated with the user. */
tags?: string[]
/**
* A new IAM Member to create.
* Details of IAM member. Private Beta feature.
*
* One-of ('type'): at most one of 'email', 'member' could be set.
*/
Expand Down Expand Up @@ -1126,6 +1126,6 @@ export type UpdateUserRequest = {
userId: string
/** New tags for the user (maximum of 10 tags). */
tags?: string[]
/** New email for the user (only available on Members). */
/** IAM member email. */
email?: string
}
Loading