Appearance
Create Role
Create a new role for the target path. The authenticated user must have ADMIN permissions for the targetPath.
Parameters
| name * are required parameters | data type | description |
|---|---|---|
body.name* | string | The display name for the role |
body.description | string | A description of the role and its intended use |
body.permissions | string[] | Array of permission keys assigned to this role |
Return Value
The created role object.
Error Codes
400 Bad Request: Returned when parameters are invalid.401 Unauthorized: Returned when permissions are insufficient.
Examples
bash
curl -X POST "https://app.wombat.software/api/{targetPath}/role" \
-H "Content-Type: application/json" \
-H "Authentication: Bearer ..." \
-d '{"name": "Site Manager", "permissions": ["READ", "MANAGE_FORM"]}'ENDPOINTS
post
/api/{targetPath}/role