Skip to content

feat(iam): add LockUser and UnlockUser method #1552

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
Nov 4, 2024
+47 −0
Merged

feat(iam): add LockUser and UnlockUser method #1552

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
7512eb4
feat: update generated APIs
scaleway-bot Oct 31, 2024
6574031
Merge branch 'main' into v1.5693.0
Laure-di Nov 4, 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
37 changes: 37 additions & 0 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 @@ -104,6 +104,7 @@ import type {
ListSSHKeysResponse,
ListUsersRequest,
ListUsersResponse,
LockUserRequest,
Log,
Policy,
Quotum,
Expand All @@ -112,6 +113,7 @@ import type {
SetGroupMembersRequest,
SetRulesRequest,
SetRulesResponse,
UnlockUserRequest,
UpdateAPIKeyRequest,
UpdateApplicationRequest,
UpdateGroupRequest,
Expand Down Expand Up @@ -358,6 +360,41 @@ export class API extends ParentAPI {
unmarshalUser,
)

/**
* Lock a user. Lock a user. Note that a locked user cannot log in or use API
* keys until the locked status is removed.
*
* @param request - The request {@link LockUserRequest}
* @returns A Promise of User
*/
lockUser = (request: Readonly<LockUserRequest>) =>
this.client.fetch<User>(
{
body: '{}',
headers: jsonContentHeaders,
method: 'POST',
path: `/iam/v1alpha1/users/${validatePathParam('userId', request.userId)}/lock`,
},
unmarshalUser,
)

/**
* Unlock a user.
*
* @param request - The request {@link UnlockUserRequest}
* @returns A Promise of User
*/
unlockUser = (request: Readonly<UnlockUserRequest>) =>
this.client.fetch<User>(
{
body: '{}',
headers: jsonContentHeaders,
method: 'POST',
path: `/iam/v1alpha1/users/${validatePathParam('userId', request.userId)}/unlock`,
},
unmarshalUser,
)

protected pageOfListApplications = (
request: Readonly<ListApplicationsRequest> = {},
) =>
Expand Down
2 changes: 2 additions & 0 deletions packages/clients/src/api/iam/v1alpha1/index.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ export type {
ListUsersRequest,
ListUsersRequestOrderBy,
ListUsersResponse,
LockUserRequest,
Log,
LogAction,
LogResourceType,
Expand All @@ -81,6 +82,7 @@ export type {
SetGroupMembersRequest,
SetRulesRequest,
SetRulesResponse,
UnlockUserRequest,
UpdateAPIKeyRequest,
UpdateApplicationRequest,
UpdateGroupRequest,
Expand Down
8 changes: 8 additions & 0 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 @@ -954,6 +954,10 @@ export interface ListUsersResponse {
totalCount: number
}

export type LockUserRequest = {
userId: string
}

export type RemoveGroupMemberRequest = {
/** ID of the group. */
groupId: string
Expand Down Expand Up @@ -989,6 +993,10 @@ export interface SetRulesResponse {
rules: Rule[]
}

export type UnlockUserRequest = {
userId: string
}

export type UpdateAPIKeyRequest = {
/** Access key to update. */
accessKey: string
Expand Down