Update a role

Updates the specified role by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH/v3/roles/{id}

JWT

role:write

Parameters

Name	Type	In	Description
id*	string	path	Unique identifier for the role.

Request Body Schema

Property	Type	Description	Constraints
name	string	Name of the role.	min: 1, max: 256
description	string	Description for the role.	min: 0, max: 256
claims	array	List of permission claims for the role.	items: string

Request Example

{
  "name": "string",
  "description": "string",
  "claims": [
    "string"
  ]
}

Triggers webhook: role.updated

POST <your-webhook-url>
{
  "event": "role.updated",
  "data": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "description": "string",
    "claims": [
      "string"
    ]
  },
  "triggeredAt": "string"
}

Responses

200

400

401

403

404

429

500

200 OK

{
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "name": "string",
  "description": "string",
  "claims": [
    "string"
  ]
}