ROrossum
User

Update current user

Changed on

Update the currently authorized user. Fields organization, groups, and queues are read-only at this endpoint; use update user to modify them.

put/api/v1/auth/user

Request

Request body

idinteger

ID of the user

urlstring uri

URL of the user

first_namestring

First name of the user

last_namestring

Last name of the user

emailstring email

Email of the user

phone_numberstring nullable

Phone number of the user

passwordstring

Password (not shown on API)

date_joinedstring date-time

Date of user join

usernamestring

Username of a user

groupsstring[]

List of user role (permission groups)

organizationstring uri

Organization URL.

queuesstring[]

List of queues user is assigned to

is_activeboolean

Whether user is enabled or disabled

last_loginstring date-time nullable

Date of last login

ui_settingsobject

User-related frontend UI settings (e.g. locales). Rossum internal.

metadataMetadata

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

oidc_idstring nullable

OIDC provider id used to match Rossum user (displayed only to admin user)

auth_type'sso' | 'password'

Authorization method, can be sso or password. This field can be edited only by admin.

deletedboolean

Whether a user is deleted

Example request

{
  "id": 10775,
  "url": "https://example.rossum.app/api/v1/users/10775",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john-doe@east-west-trading.com",
  "phone_number": "+1-212-456-7890",
  "date_joined": "2018-09-19T13:44:56.000000Z",
  "username": "john-doe@east-west-trading.com",
  "groups": [
    "https://example.rossum.app/api/v1/groups/3"
  ],
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "is_active": true,
  "last_login": "2019-02-07T16:20:18.652253Z",
  "ui_settings": {},
  "metadata": {
    "some_key": "some_value"
  },
  "auth_type": "password"
}

Response

OK

idinteger required

ID of the user

urlstring uri required

URL of the user

first_namestring required

First name of the user

last_namestring required

Last name of the user

emailstring email required

Email of the user

phone_numberstring nullable required

Phone number of the user

passwordstring required

Password (not shown on API)

date_joinedstring date-time required

Date of user join

usernamestring required

Username of a user

groupsstring[] required

List of user role (permission groups)

organizationstring uri required

Organization URL.

queuesstring[] required

List of queues user is assigned to

is_activeboolean required

Whether user is enabled or disabled

last_loginstring date-time nullable required

Date of last login

ui_settingsobject required

User-related frontend UI settings (e.g. locales). Rossum internal.

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

oidc_idstring nullable required

OIDC provider id used to match Rossum user (displayed only to admin user)

auth_type'sso' | 'password' required

Authorization method, can be sso or password. This field can be edited only by admin.

deletedboolean required

Whether a user is deleted

Example response

{
  "id": 10775,
  "url": "https://example.rossum.app/api/v1/users/10775",
  "first_name": "John",
  "last_name": "Doe",
  "email": "john-doe@east-west-trading.com",
  "phone_number": "+1-212-456-7890",
  "date_joined": "2018-09-19T13:44:56.000000Z",
  "username": "john-doe@east-west-trading.com",
  "groups": [
    "https://example.rossum.app/api/v1/groups/3"
  ],
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "is_active": true,
  "last_login": "2019-02-07T16:20:18.652253Z",
  "ui_settings": {},
  "metadata": {
    "some_key": "some_value"
  },
  "auth_type": "password"
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      added to the request body allOf list

    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed from the request body allOf list

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      removed the optional write-only property password from the response with the status