Atomically grant one known permission to a role without replacing concurrent changes.

POST

/api/workspace/roles/{roleId}/permissions/grants

curl --request POST \
  --url https://example.com/api/workspace/roles/example/permissions/grants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "PermissionKey": "example" }'

Authorizations

• WorkspaceBearer

Parameters

Path Parameters

roleId

required

string

Query Parameters

access_token

string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Request Body^required

Request payload for an atomic role permission grant or revoke.

object

PermissionKey

required

Normalized permission key.

string

Example^generated

{
  "PermissionKey": "example"
}

Request payload for an atomic role permission grant or revoke.

object

PermissionKey

required

Normalized permission key.

string

Example^generated

{
  "PermissionKey": "example"
}

Request payload for an atomic role permission grant or revoke.

object

PermissionKey

required

Normalized permission key.

string

Example^generated

{
  "PermissionKey": "example"
}

Responses

200

OK

Media typeapplication/json

object

Data

Complete permission set assigned to a workspace role.

object

RowVersion

required

Aggregate version that changes with every effective permission mutation.

string format: uuid

PermissionKeys

required

Normalized permission keys assigned to the role.

Array<string>

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

400

Bad Request

Media typeapplication/json

object

Data

Complete permission set assigned to a workspace role.

object

RowVersion

required

Aggregate version that changes with every effective permission mutation.

string format: uuid

PermissionKeys

required

Normalized permission keys assigned to the role.

Array<string>

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}

403

Forbidden

Media typeapplication/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

Media typeapplication/json

object

Data

Complete permission set assigned to a workspace role.

object

RowVersion

required

Aggregate version that changes with every effective permission mutation.

string format: uuid

PermissionKeys

required

Normalized permission keys assigned to the role.

Array<string>

Errors

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Warnings

Array<object>

nullable

object

Code

required

string

nullable

Message

required

string

nullable

Target

string

nullable

Field

string

nullable

Metadata

object

key

additional properties

string

nullable

Type

integer format: int32

Allowed values: 0 1 2

Severity

integer format: int32

Allowed values: 0 1 2

Success

boolean

Example

{
  "Errors": [
    {
      "Type": 0,
      "Severity": 0
    }
  ],
  "Warnings": [
    {
      "Type": 0,
      "Severity": 0
    }
  ]
}