Update Role

PUT 
/roles/:id/

Request

Path Parameters

id stringrequired

application/json

Body

required

name stringrequired

Possible values: <= 255 characters

Role's name.

permissions object[]
Array [
id stringrequired
Possible values: <= 255 characters
Textual identifier.
]
description stringnullablerequired

Short description.

application/x-www-form-urlencoded

Body

required

name stringrequired

Possible values: <= 255 characters

Role's name.

permissions object[]
Array [
id stringrequired
Possible values: <= 255 characters
Textual identifier.
]
description stringnullablerequired

Short description.

multipart/form-data

Body

required

name stringrequired

Possible values: <= 255 characters

Role's name.

permissions object[]
Array [
id stringrequired
Possible values: <= 255 characters
Textual identifier.
]
description stringnullablerequired

Short description.

Responses

200

application/json

Schema

Schema

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

Possible values: <= 255 characters

Role's name.

permissions object[]
Array [
id stringrequired
Possible values: <= 255 characters
Textual identifier.
name stringrequired
Possible values: <= 255 characters
Permission name.
]
custom booleanrequired
description stringnullablerequired

Short description.

Example (from schema)

{
  "id": "string",
  "name": "string",
  "permissions": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "custom": true,
  "description": "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."
}

404

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail stringrequired

Example (from schema)

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

Loading...