Update Managed User

Updates an existing managed user. Only externalId, metadata and isActive can change, and metadata is replaced as a whole, so send all of it. isActive: false switches the managed user off: what it already has stays, and nothing new can be filed under it until you send isActive: true. Switching it off also ends all of its editor sessions, and they do not come back when you switch it on again.

The Idempotency-Key header is required (400 without it).

PUT /managed-users/{id}

Update Managed User

cURL

curl --request PUT \
  --url https://api.widgetic.com/v1/managed-users/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "externalId": "updated-external-user-123",
  "metadata": {
    "firstName": "John",
    "lastName": "Smith",
    "role": "admin"
  },
  "isActive": false
}
'

200

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "managerId": "123e4567-e89b-12d3-a456-426614174001",
    "externalId": "external-user-123",
    "metadata": {
      "firstName": "John",
      "lastName": "Doe",
      "role": "editor"
    },
    "isActive": true,
    "createdAt": "2023-01-01T00:00:00Z",
    "updatedAt": "2023-01-02T00:00:00Z"
  },
  "meta": {
    "page": 1,
    "size": 20,
    "total": 135,
    "limit": 20,
    "offset": 0,
    "hasNextPage": true,
    "hasPreviousPage": false,
    "nextCursor": "<string>",
    "warnings": [
      "<string>"
    ]
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Idempotency-Key · string · required

Required: a call without it is refused with 400. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, - and _. Send the same key again when you retry (after a timeout, a dropped connection or a 5xx) and the call is carried out once: the retry gets the first answer back, marked X-Idempotency-Cached: true. The same key with a different body is refused with 422, and a retry that arrives while the first call is still running with 409 (see Retry-After).

Required string length: 8 - 50

Pattern: ^[a-zA-Z0-9_-]{8,50}$

Example:

"9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d"

Path Parameters

id · string<uuid> · required

ID of the managed user to update

Body

application/json

externalId · string

Updated external identifier for the managed user. Must be unique among the managed users you manage (409 otherwise).

Example:

"updated-external-user-123"

metadata · object

Updated additional metadata for the managed user

Example:

{
  "firstName": "John",
  "lastName": "Smith",
  "role": "admin"
}

isActive · boolean

Switch the managed user off (false) or back on (true). A managed user that is off keeps everything already filed under it, and that content can still be listed, but nothing new can be filed under it (409 MANAGED_USER_INACTIVE). Send a real boolean, not the text "false". Switching a managed user off also ends all of its editor sessions.

Example:

false

Response

200

application/json

Managed user updated successfully

success · boolean · required

Always true on a success.

Example:

true

data · object · required

A managed user as the API answers. The answer names its fields in camelCase (externalId), and so does the request that creates or changes a managed user; the snake_case spelling (external_id) is read too.

Show child attributes

Example:

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "managerId": "123e4567-e89b-12d3-a456-426614174001",
  "externalId": "external-user-123",
  "metadata": {
    "firstName": "John",
    "lastName": "Doe",
    "role": "editor"
  },
  "isActive": true,
  "createdAt": "2023-01-01T00:00:00Z",
  "updatedAt": "2023-01-02T00:00:00Z"
}

meta · object

Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat.

Show child attributes