Partial Update API User Role

PATCH 
/api-user-roles/:id/

Request

Path Parameters

id stringrequired

application/json

Body

id string

Possible values: >= 12 characters and <= 12 characters

user

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

role

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

scope

object

tier stringrequired

Possible values: [account, team, target]

• account - account
• team - team
• target - target

team

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

target

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

application/x-www-form-urlencoded

Body

id string

Possible values: >= 12 characters and <= 12 characters

user

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

role

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

scope

object

tier stringrequired

Possible values: [account, team, target]

• account - account
• team - team
• target - target

team

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

target

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

multipart/form-data

Body

id string

Possible values: >= 12 characters and <= 12 characters

user

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

role

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

scope

object

tier stringrequired

Possible values: [account, team, target]

• account - account
• team - team
• target - target

team

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

target

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

Responses

200

application/json

Schema

Schema

id stringrequired

A unique Base58 value identifying this object.

user

object

required

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.

role

object

required

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 stringnullable

Short description.

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

Example (from schema)

{
  "id": "string",
  "user": {
    "id": "string",
    "email": "[email protected]",
    "name": "string"
  },
  "role": {
    "id": "string",
    "name": "string",
    "permissions": [
      {
        "id": "string",
        "name": "string"
      }
    ],
    "custom": true,
    "description": "string"
  },
  "scope": {
    "tier": "string",
    "target": {
      "id": "string",
      "name": "string",
      "url": "string"
    },
    "team": {
      "id": "string",
      "name": "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."
}

404

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Not found."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

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

Loading...