v1

latestOpenAPI 3.1.0Serval License2026-07-26202952779.1 KB

User API

Update User

Update an existing user.

put/v2/users/{id}

Path parameters

idstring required

Request body

emailstring nullable

firstNamestring nullable

lastNamestring nullable

role'USER_ROLE_UNSPECIFIED' | 'USER_ROLE_ORG_MEMBER' | 'USER_ROLE_ORG_ADMIN' | 'USER_ROLE_ORG_GUEST'

avatarUrlstring nullable

authMethod'USER_AUTH_METHOD_UNSPECIFIED' | 'USER_AUTH_METHOD_MAGIC_LINK'

Specifies the authentication method for a user. If unset, the org default applies. Set to MAGIC_LINK to allow the user to bypass SSO (e.g. guest or break-glass accounts).

localestring nullable

BCP 47 language tag

phoneNumberstring nullable

Response

Success