Bulk Update API Users

POST 
/api-users/bulk/update/

Request

application/json

Body

required

name stringrequired

Possible values: <= 60 characters

Name of the user.

active booleanrequired

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 stringrequired
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.
]
user_roles object[]
Roles of the user.
Array [
role objectrequired
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 stringrequired
A unique Base58 value identifying this object.
scope objectrequired
tier stringrequired
target object
id stringrequired
A unique Base58 value identifying this object.
team object
id stringrequired
A unique Base58 value identifying this object.
]

application/x-www-form-urlencoded

Body

required

name stringrequired

Possible values: <= 60 characters

Name of the user.

active booleanrequired

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 stringrequired
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.
]
user_roles object[]
Roles of the user.
Array [
role objectrequired
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 stringrequired
A unique Base58 value identifying this object.
scope objectrequired
tier stringrequired
target object
id stringrequired
A unique Base58 value identifying this object.
team object
id stringrequired
A unique Base58 value identifying this object.
]

multipart/form-data

Body

required

name stringrequired

Possible values: <= 60 characters

Name of the user.

active booleanrequired

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 stringrequired
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.
]
user_roles object[]
Roles of the user.
Array [
role objectrequired
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 stringrequired
A unique Base58 value identifying this object.
scope objectrequired
tier stringrequired
target object
id stringrequired
A unique Base58 value identifying this object.
team object
id stringrequired
A unique Base58 value identifying this object.
]

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 objectrequired

User who last made changes.

id stringrequired

A unique Base58 value identifying this object.

email emailrequired

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 booleanrequired

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 stringrequired
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 objectrequired
User who last made changes.
id stringrequired
A unique Base58 value identifying this object.
email emailrequired
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 objectrequired
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 stringrequired
A unique Base58 value identifying this object.
name stringrequired
Possible values: <= 255 characters
Role's name.
scope objectrequired
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-09-10T15:58:28.975Z",
  "active": true,
  "labels": [
    {
      "id": "string",
      "name": "string",
      "color": "string",
      "changed_by": {
        "id": "string",
        "email": "[email protected]",
        "name": "string"
      },
      "changed": "2024-09-10T15:58:28.975Z"
    }
  ],
  "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[]required
non_field_errors string[]required

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 stringrequired

Example (from schema)

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

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

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

Loading...