Give an account a platform role, or take it away (owners only).

PUT

/api/admin/users/{id}/role

curl --request PUT \
  --url https://example.com/api/admin/users/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/role \
  --header 'Content-Type: application/json' \
  --data '{ "role": "example" }'

Parameters

Path Parameters

id

required

string format: uuid

Request Body^required

Media typeapplication/json

object

role

required

null | string

Example ^generated

{
  "role": "example"
}

Responses

200

OK

Media typeapplication/json

object

id

required

string format: uuid

email

required

null | string

username

required

null | string

displayName

required

string

createdAt

required

string format: date-time

termsVersion

required

null | string

termsAcceptedAt

required

null | string format: date-time

role

required

null | string

hasPassword

required

boolean

twoFactorEnabled

required

boolean

logins

required

Array<string>

suspendedAt

required

null | string format: date-time

suspendedReason

required

null | string

community

required

null | string

profiles

required

Array<object>

object

id

required

string format: uuid

publicId

required

string

name

required

string

avatar

required

string

kind

required

string

ageBand

required

null | string

createdAt

required

string format: date-time

names

required

Array<object>

object

name

required

string

at

required

string format: date-time

kind

string

default: rename

onPublicBoards

required

boolean

hiddenFromBoards

required

boolean

deleteAfter

required

null | string format: date-time

Example

{
  "profiles": [
    {
      "names": [
        {
          "kind": "rename"
        }
      ]
    }
  ]
}

400

Bad Request

Media typeapplication/problem+json

object

type

null | string

title

null | string

status

null | integer format: int32

detail

null | string

instance

null | string

errors

object

key

additional properties

Array<string>

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

404

Not Found