Grants
Create grant
⚠️ This endpoint is in public preview.
Grant a role to a principal (user or token) on a workspace, or org-wide when workspace_id is omitted.
post/preview/v2/grants
Request body
Example request
{
"principal_id": "my-resource-name",
"workspace_id": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
"role_id": "role_k3R-nX9vLm7Qp2Yw5Jd8F"
}Response
Grant created.
Example response
{
"principal_id": "my-resource-name",
"object": "grant",
"id": "grnt_k3R-nX9vLm7Qp2Yw5Jd8F",
"workspace": {
"id": "wksp_k3R-nX9vLm7Qp2Yw5Jd8F",
"name": "my-resource-name"
},
"role": {
"id": "role_k3R-nX9vLm7Qp2Yw5Jd8F",
"name": "my-resource-name"
},
"created_at": 1738972800
}