Sign in
admin

Update Deployment User

Changed on

Deactivate or reactivate an account, or change whether it may administer this deployment.

Both fields are optional and omitting one leaves it alone; a body naming neither is refused rather than treated as a no-op. Deactivating also ends that account's dashboard sessions immediately, so a lost laptop stops working now rather than when its cookie is next presented.

Two changes are refused to keep a deployment reachable: an operator may not deactivate their own account or drop their own operator access, and neither may be taken from the deployment's bootstrap operator, which is the identity master-key sign-in resolves to. Granting either is unguarded.

patch/api/v1/admin/users/{user_id}

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Otari-Key
    • API key in header x-api-key

Path parameters

user_idstring uuid required

Request body

is_activeboolean nullable
is_superuserboolean nullable

Response

Successful Response

created_atstring date-time required
emailstring nullable required
full_namestring nullable required
idstring uuid required
is_activeboolean required
is_bootstrap_operatorboolean required
is_selfboolean required
is_superuserboolean required
last_sign_in_atstring date-time nullable required

Changes

  • fbee488d4d9fRevision changes
    • info

      added the optional property to the response with the status

  • e27406481fffRevision changes
    • info

      api operation id update_deployment_user_api_v1_admin_users__user_id__patch removed and replaced with admin-update_deployment_user