Herald
OpenapiRole definitions

Create a new role

Create a new role definition. Requires `roles.manage` permission.

POST
/api/roles/{realmId}/define

Create a new role definition. Requires roles.manage permission.

Authorization

bearer_auth
AuthorizationBearer <token>

In: header

Path Parameters

realmId*string

Realm ID

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

clientId*string
description?string|null
name*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/roles/string/define" \  -H "Content-Type: application/json" \  -d '{    "clientId": "string",    "name": "string"  }'
{  "clientId": "string",  "description": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "isBuiltin": true,  "name": "string",  "realmId": "string"}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}