Create Workspace Role - Wacht API Documentation

POST

/

workspaces

/

{workspace_id}

/

roles

Create Workspace Role

curl --request POST \
  --url https://api.wacht.dev/workspaces/{workspace_id}/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ]
}'

{
  "id": "<string>",
  "name": "Admin",
  "description": "<string>",
  "permissions": [
    "workspace.manage",
    "members.invite",
    "members.remove"
  ],
  "is_default": false,
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Path Parameters

workspace_id

string

required

Body

application/json

name

string

required

permissions

string[]

required

description

string

Response

id

string

name

string

Example:

description

string | null

permissions

string[]

Example:

is_default

boolean

Example:

created_at

string<date-time>

Delete Workspace RoleDelete a workspace role

⌘I

Create Workspace Role

curl --request POST \
  --url https://api.wacht.dev/workspaces/{workspace_id}/roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ]
}'

{
  "id": "<string>",
  "name": "Admin",
  "description": "<string>",
  "permissions": [
    "workspace.manage",
    "members.invite",
    "members.remove"
  ],
  "is_default": false,
  "created_at": "2023-11-07T05:31:56Z"
}