Update custom role

Updates an existing custom role's description and/or permissions. Built-in roles cannot be modified.

Path Parameters

id*string

Length1 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?string

permissions?array<>

Response Body

`application/json`

curl -X PUT "http://localhost:3001/api/v1/admin/roles/role_abc123" \  -H "Content-Type: application/json" \  -d '{}'

{
  "role": {
    "id": "string",
    "orgId": "string",
    "name": "string",
    "description": "string",
    "permissions": [
      "string"
    ],
    "isBuiltin": true,
    "createdAt": "string",
    "updatedAt": "string"
  }
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

{
  "property1": null,
  "property2": null
}

{
  "error": "string",
  "message": "string",
  "requestId": "string"
}

Update custom role

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`