Skip to content
Optiwork API Docs

Update a user

PATCH
/drives/{drive}/users/{user}
curl --request PATCH \
  --url https://work.optidata.cloud/api/drives/1/users/1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "email": "hello@example.com", "role": "example", "status": "active", "password": "example" }'

Replaces the user’s name, e-mail, role and status. The same rules as creation apply — in particular the e-mail must be unique across the tenant.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
drive
required
integer format: int64

Numeric id of the drive. Read it from GET /drives/config.json.

user
required
integer format: int64

Numeric id of the user.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
<= 255 characters
email
required
string format: email
<= 255 characters
role
required
string
status
required
string
Allowed values: active inactive blocked
password
string | null format: password

Responses

Section titled “ Responses ”

200

Section titled “200”

The updated user.

Media typeapplication/json
object
user
required

A user of the tenant.

object
id
integer format: int64
uuid
string format: uuid
cuid

Identifier of the company (tenant) the user belongs to.

string
username
string
email
string format: email
name
string
full_name
string
company_name
string
role

Role of the user inside the tenant.

string
status
string
Allowed values: active inactive blocked
avatar_url
string | null format: uri
created_at
string format: date-time
updated_at
string format: date-time
deleted_at
string | null format: date-time
profile

Profile extras (avatar, job title). Loaded only where noted.

object | null
groups

Groups the user belongs to. Loaded only where noted.

Array<object>

A group of users inside the tenant.

object
id
integer format: int64
guid

Tenant-wide identifier of the group; used in paths.

string format: uuid
name
string
description
string | null
email
string | null format: email
cuid
string
memberships

Members of the group, each with its embedded user.

Array<object>
object
key
additional properties
any
userStatus

Presence status of the user. Loaded only where noted.

object | null
status_details

Rendered presence details (type, icon, message). Present on dashboard listings.

object | null
Example
{
  "user": {
    "id": 15,
    "uuid": "9c1f0e2a-4d31-4d8a-8c1a-1f0b6b1f9a10",
    "cuid": "a1b2c3d4-2226-46c1-91b2-a9e9ba4c2d5b",
    "username": "jane.doe@acme.example",
    "email": "jane.doe@acme.example",
    "name": "Jane Doe",
    "full_name": "Jane Doe",
    "company_name": "Acme",
    "role": "super-admin",
    "status": "active",
    "groups": [
      {
        "id": 560,
        "guid": "a19d5670-335d-4285-8ee4-fcb54cb70faf",
        "name": "Finance"
      }
    ]
  }
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The caller lacks the permission level the operation requires.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledenied
{
  "message": "This action is unauthorized."
}

404

Section titled “404”

The resource does not exist, or does not belong to the given drive.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplemissing
{
  "message": "No query results for model [App\\Models\\Node] 99999999"
}

422

Section titled “422”

The request body or query string failed validation.

Media typeapplication/json
object
message
required

The first validation message.

string
errors
required

Validation messages keyed by field name.

object
key
additional properties
Array<string>
Examples
Exampleinvalid
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}