Sign in
Users

Update your own user record

put/api/v1/users/{id}

Path parameters

idstring uuid required

User ID

Request body

emailstring email required

The user's email address, also their login identifier.

email_verifiedboolean

Whether the user has verified their email address

has_passwordboolean

Whether the user has a password set — computed from password_hash, never stored in DB

network_idsstring[] required

The networks this entity applies to.

oidc_linked_atstring date-time nullable

When the account was linked to the identity provider.

oidc_providerstring nullable

Slug of the identity provider this account signs in through, when linked.

organization_idstring uuid required

The organization that owns this record.

permissions'Owner' | 'Admin' | 'Member' | 'Viewer' required
terms_accepted_atstring date-time nullable

When the user accepted the terms of service.

created_atstring date-time required

When this record was first created.

idstring uuid required

Server-assigned unique identifier.

updated_atstring date-time required

When this record was last modified.

Response

User updated

errorstring nullable

Human-readable failure message. Omitted on success.

successboolean required

true when the request succeeded. false responses carry error instead of data.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.17.13"
  }
}

Changes