Update API User

PUT 
/api-users/:id/

Request

Path Parameters

id stringrequired

application/json

Body

required

name stringrequired

Possible values: <= 60 characters

Name of the user.

title string
Possible values: [ceo, cto, cso, seceng, dev, devop, manager, other, ``]
Job title:
• ceo - Chief Executive Officer
• cto - Chief Technology Officer
• cso - Chief Security Officer
• seceng - Security engineer
• dev - Developer
• devop - Developer Operations
• manager - Manager
• other - Other
active boolean

Default value: true

If true, the user can authenticate to Probely to interact with apps and the API.
If false, the user's access to Probely's apps and API is blocked.
Defaults to true.

labels

object[]

required

Array [

name stringrequired

Possible values: <= 255 characters

Name of the label.
The maximum length is 255 characters.

color string

Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.

]

application/x-www-form-urlencoded

Body

required

name stringrequired

Possible values: <= 60 characters

Name of the user.

title string
Possible values: [ceo, cto, cso, seceng, dev, devop, manager, other, ``]
Job title:
• ceo - Chief Executive Officer
• cto - Chief Technology Officer
• cso - Chief Security Officer
• seceng - Security engineer
• dev - Developer
• devop - Developer Operations
• manager - Manager
• other - Other
active boolean

Default value: true

If true, the user can authenticate to Probely to interact with apps and the API.
If false, the user's access to Probely's apps and API is blocked.
Defaults to true.

labels

object[]

required

Array [

name stringrequired

Possible values: <= 255 characters

Name of the label.
The maximum length is 255 characters.

color string

Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.

]

multipart/form-data

Body

required

name stringrequired

Possible values: <= 60 characters

Name of the user.

title string
Possible values: [ceo, cto, cso, seceng, dev, devop, manager, other, ``]
Job title:
• ceo - Chief Executive Officer
• cto - Chief Technology Officer
• cso - Chief Security Officer
• seceng - Security engineer
• dev - Developer
• devop - Developer Operations
• manager - Manager
• other - Other
active boolean

Default value: true

If true, the user can authenticate to Probely to interact with apps and the API.
If false, the user's access to Probely's apps and API is blocked.
Defaults to true.

labels

object[]

required

Array [

name stringrequired

Possible values: <= 255 characters

Name of the label.
The maximum length is 255 characters.

color string

Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.

]

Responses

200

application/json

Schema

Schema

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

Possible values: <= 60 characters

Name of the user.

changed_by

object

required

User who last made changes.

id stringrequired

A unique Base58 value identifying this object.

email email

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

changed date-timerequired

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

active boolean

Default value: true

If true, the user can authenticate to Probely to interact with apps and the API.
If false, the user's access to Probely's apps and API is blocked.
Defaults to true.

labels

object[]

required

Array [

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

Possible values: <= 255 characters

Name of the label.
The maximum length is 255 characters.

color string

Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.

changed_by

object

required

User who last made changes.

id stringrequired

A unique Base58 value identifying this object.

email email

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

changed date-timerequired

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

]

user_roles

object[]

Roles of the user.

Array [

id stringrequired

A unique Base58 value identifying this object.

role

object

required

Return serializer_class with all fields as read_only except key. The key is the field use to retrieve the object in to_internal_value.

This is for the drf-spectacular documentation generation.

id string

A unique Base58 value identifying this object.

name stringrequired

Possible values: <= 255 characters

Role's name.

scope

object

required

tier stringrequired

target

object

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

url urirequired

Target URL.

team

object

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

]

is_apiuser booleanrequired

If true, it is an app that interacts with Probely through the API.
If false, it is a human who interacts with Probely through our web interface.
Defaults to false."

key stringrequired

Example (from schema)

{
  "id": "string",
  "name": "string",
  "changed_by": {
    "id": "string",
    "email": "[email protected]",
    "name": "string"
  },
  "changed": "2024-07-29T15:51:28.071Z",
  "active": true,
  "labels": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "changed_by": {
        "id": "string",
        "email": "[email protected]",
        "name": "string"
      },
      "changed": "2024-07-29T15:51:28.071Z"
    }
  ],
  "user_roles": [
    {
      "id": "string",
      "role": {
        "id": "string",
        "name": "string"
      },
      "scope": {
        "tier": "string",
        "target": {
          "id": "string",
          "name": "string",
          "url": "string"
        },
        "team": {
          "id": "string",
          "name": "string"
        }
      }
    }
  ],
  "is_apiuser": true,
  "key": "string"
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...