Update user role

PUT 
https://demo.frigate.video/api/users/:username/role

Updates a user's role. The built-in admin user's role cannot be modified. Requires admin role. Valid roles are defined in the configuration.

Request

Path Parameters

username Usernamerequired

application/json

Bodyrequired

roleRole (string)required

Responses

200

Successful Response

application/json

Schema

Schema

400

Bad Request - Invalid role

403

Forbidden - Cannot modify admin user's role or admin role required

422

Validation Error

application/json

Schema

Schema

detail object[]
Array [
loc object[]required
Array [
anyOf
string
string
integer
integer
]
msgMessage (string)required
typeError Type (string)required
]

Example (auto)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

• python
• nodejs
• javascript
• curl
• rust

• HTTP.CLIENT
• REQUESTS

import http.client
import json

conn = http.client.HTTPSConnection("demo.frigate.video")
payload = json.dumps({
  "role": "string"
})
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}
conn.request("PUT", "/api/users/:username/role", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Request Collapse all

Base URL

https://demo.frigate.video/api

Parameters

username — pathrequired

Body required

{
  "role": "string"
}

ResponseClear

Click the Send API Request button above and see the response here!