Skip to main content
PATCH
Update user Linux username
Requires the IAM action workspace:UpdateUser. See WORKSPACE permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

user_id
string<uuid>
required

User ID

Body

application/json
linux_username
string
required

Optional custom Linux login name, unique across users, service accounts and pending invitations in the organization. Reserved system names and the bsu_/bsa_ prefixes cannot be chosen. Omit on creation to generate a name. Renaming preserves UID, GID and home directory; existing sessions are not disconnected.

Required string length: 1 - 32
Pattern: ^[a-z_][a-z0-9_-]{0,31}$
Example:

"deploy-bot"

Response

User details

user
object

A platform user linked to the organization.