Replace permissions assigned to a role using the latest aggregate row version.

PUT

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

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Put,
    RequestUri = new Uri("https://example.com/api/workspace/roles/example/permissions"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"ExpectedRowVersion\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"PermissionKeys\": [ \"example\" ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/roles/example/permissions';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"ExpectedRowVersion":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","PermissionKeys":["example"]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/workspace/roles/example/permissions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "PermissionKeys": [ "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 to update role permissions.

object

ExpectedRowVersion

required

Aggregate role-permission version read by the caller.

string format: uuid

PermissionKeys

required

List of normalized permission keys.

Array<string>

Example^generated

{
  "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "PermissionKeys": [
    "example"
  ]
}

Request payload to update role permissions.

object

ExpectedRowVersion

required

Aggregate role-permission version read by the caller.

string format: uuid

PermissionKeys

required

List of normalized permission keys.

Array<string>

Example^generated

{
  "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "PermissionKeys": [
    "example"
  ]
}

Request payload to update role permissions.

object

ExpectedRowVersion

required

Aggregate role-permission version read by the caller.

string format: uuid

PermissionKeys

required

List of normalized permission keys.

Array<string>

Example^generated

{
  "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "PermissionKeys": [
    "example"
  ]
}

Responses

200

application/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

application/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

application/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

application/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
    }
  ]
}

409

Conflict

application/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
    }
  ]
}

Replace permissions assigned to a role using the latest aggregate row version.

Authorizations

Parameters

Path Parameters

Query Parameters

Request Bodyrequired

Examplegenerated

Examplegenerated

Examplegenerated

Responses

200

Example

400

Example

403

Examplegenerated

404

Example

409

Example

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated