Replace an access role

PUT

/api/v1/roles/{id}

PUT

/api/v1/roles/{id}

Authorization

bearerAuth roles.manage

headerAuthorizationBearer <API key or OAuth 2.1 access token>

Send Authorization: Bearer <credential>. Create API keys in AirTrail Security settings. OAuth clients use authorization code with PKCE S256 and a resource identifier matching /api/v1.

Scope: roles.manage

Path Parameters

id*string

Request Body

application/json

body

name*string

Lengthlength <= 50

description?|

Lengthlength <= 200

permissions*array<string>

Response Body

Role updated.

application/json

response

data*

Example Request

curl -X PUT 'https://your-instance.example/api/v1/roles/string' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "permissions": [
    "string"
  ]
}'

Example Request

curl -X PUT 'https://your-instance.example/api/v1/roles/string' \  -H 'Content-Type: application/json' \  -d '{  "name": "string",  "permissions": [    "string"  ]}'

Example ResponseSchema

{
  "data": {}
}

{  "data": {}}

Replace an access role

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Request Body

Response Body