SCscanopy
Users
internal

Update your own user record

Changed on
put/api/v1/users/{id}

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/users/{id}
  • Auth
    API key in cookie session_id

Path parameters

idstring uuid required

User ID

Request body

emailstring email required

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

email_verification_requiredboolean

Whether the user must verify their email before the API serves their session (an org on a license plan, see auth::verification_gate). Computed and set like terms_acceptance_required.

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

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
site_idsstring[] required

The sites this entity applies to.

terms_acceptance_requiredboolean

Whether the user must accept the current terms before the API serves their session. Computed, never stored: set only on the signed-in user's own record (/api/auth/me, login, accept), false everywhere else.

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

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

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

Changes