Skip to main content
POST
/
workspaces
/
{id}
/
roles
Create workspace role
curl --request POST \
  --url https://api.wacht.dev/workspaces/{id}/roles \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --cookie session_id= \
  --data name=Developer \
  --data-urlencode permissions%5B0%5D=workspace:read \
  --data-urlencode permissions%5B1%5D=workspace:write
{
  "id": "444444444444444444",
  "workspace_id": "123456789012345678",
  "name": "Developer",
  "permissions": [
    "workspace:read",
    "workspace:write"
  ],
  "is_system_role": false,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
session_id
string
cookie
required

Session-based authentication using cookies

Path Parameters

​
id
string<uint64>
required

Workspace ID

Body

application/x-www-form-urlencoded
​
name
string
required

Role name

Example:

"Developer"

​
permissions
string[]
required

List of permissions

Example:
["workspace:read", "workspace:write"]

Response

Role created successfully

​
id
string<uint64>

Role ID

Example:

"444444444444444444"

​
workspace_id
string<uint64>

Workspace ID

Example:

"123456789012345678"

​
name
string

Role name

Example:

"Developer"

​
permissions
string[]

Role permissions

Example:
["workspace:read", "workspace:write"]
​
is_system_role
boolean

Whether this is a system role

Example:

false

​
created_at
string<date-time>
​
updated_at
string<date-time>