Skip to main content

Users

Manage Seqera Platform users.

Path and query parameters​

Name

Type

Location

Req/Opt

Description

name

string

query

Optional

User name to validate

userId

integer

path

Required

User identifier

Request body parameters​

Name

Type

Req/Opt

Description

UpdateUser

Update user

userName

string

Required

Unique username. Maximum 40 characters.

email

string

Required

User email address in valid email format. Maximum 255 characters.

firstName

string

Optional

User first name. Maximum 100 characters.

lastName

string

Optional

User last name. Maximum 100 characters.

organization

string

Optional

User organization name. Maximum 100 characters.

description

string

Optional

User description or bio. Maximum 1000 characters.

avatar

string

Optional

User avatar URL.

avatarId

string

Optional

User avatar identifier.

notification

boolean

Optional

If true, the user has notifications enabled.

defaultWorkspaceId

integer

Optional

Identifier of the workspace to set as the user's default workspace. The user must have access to the workspace. Set to null to clear the preference. Can be null.

waveBuildNotification

object

Optional

Wave container build completion email preference. One of ALWAYS_ON, ON_ERROR, or ALWAYS_OFF. A null value is treated as ALWAYS_ON.