Returns the current Entity Security configuration.

GET

/api/workspace/admin/entity-definitions/{entityDefinitionId}/security

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://example.com/api/workspace/admin/entity-definitions/example/security"),
};
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/admin/entity-definitions/example/security';
const options = {method: 'GET'};

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

curl --request GET \
  --url https://example.com/api/workspace/admin/entity-definitions/example/security

Authorizations

None

Parameters

Path Parameters

entityDefinitionId

required

string

Query Parameters

access_token

string

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

Responses

200

application/json

object

Data

Returns the definition-scoped security artifacts edited by Entity Definition.

object

RowVersion

required

string format: uuid

SecurityStatements

required

Array<object>

Describes one current Entity Security Statement.

object

Key

required

string

Source

required

string

Enabled

required

boolean

RowVersion

required

string format: uuid

PermissionAssignments

required

Array<object>

Describes one direct Permission Assignment.

object

Key

required

string

PermissionId

required

string

StatementKey

required

string

RowVersion

required

string format: uuid

Responsibilities

required

Array<object>

Describes one Responsibility Definition.

object

Key

required

string

SubjectMode

required

string

Cardinality

required

string

Required

required

boolean

FutureScheduling

required

boolean

EligibleResponsibilityGroupKeys

required

Array<string>

Enabled

required

boolean

RowVersion

required

string format: uuid

InitialAssignmentRules

required

Array<object>

Describes one initial responsibility rule.

object

Key

required

string

ResponsibilityKey

required

string

SubjectSource

required

string

SubjectKey

string

nullable

Enabled

required

boolean

RowVersion

required

string format: uuid

AssignmentRules

required

Array<object>

Describes one responsibility assignment rule.

object

Key

required

string

ResponsibilityKey

required

string

ActorSelectorType

required

string

ActorSelectorKey

required

string

Actions

required

Array<string>

EligibleTargets

required

Array<object>

Identifies one eligible assignment target selector.

object

SelectorType

required

string

SelectorKey

string

nullable

Enabled

required

boolean

RowVersion

required

string format: uuid

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

Returns the definition-scoped security artifacts edited by Entity Definition.

object

RowVersion

required

string format: uuid

SecurityStatements

required

Array<object>

Describes one current Entity Security Statement.

object

Key

required

string

Source

required

string

Enabled

required

boolean

RowVersion

required

string format: uuid

PermissionAssignments

required

Array<object>

Describes one direct Permission Assignment.

object

Key

required

string

PermissionId

required

string

StatementKey

required

string

RowVersion

required

string format: uuid

Responsibilities

required

Array<object>

Describes one Responsibility Definition.

object

Key

required

string

SubjectMode

required

string

Cardinality

required

string

Required

required

boolean

FutureScheduling

required

boolean

EligibleResponsibilityGroupKeys

required

Array<string>

Enabled

required

boolean

RowVersion

required

string format: uuid

InitialAssignmentRules

required

Array<object>

Describes one initial responsibility rule.

object

Key

required

string

ResponsibilityKey

required

string

SubjectSource

required

string

SubjectKey

string

nullable

Enabled

required

boolean

RowVersion

required

string format: uuid

AssignmentRules

required

Array<object>

Describes one responsibility assignment rule.

object

Key

required

string

ResponsibilityKey

required

string

ActorSelectorType

required

string

ActorSelectorKey

required

string

Actions

required

Array<string>

EligibleTargets

required

Array<object>

Identifies one eligible assignment target selector.

object

SelectorType

required

string

SelectorKey

string

nullable

Enabled

required

boolean

RowVersion

required

string format: uuid

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

401

Unauthorized

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"
}

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

Returns the definition-scoped security artifacts edited by Entity Definition.

object

RowVersion

required

string format: uuid

SecurityStatements

required

Array<object>

Describes one current Entity Security Statement.

object

Key

required

string

Source

required

string

Enabled

required

boolean

RowVersion

required

string format: uuid

PermissionAssignments

required

Array<object>

Describes one direct Permission Assignment.

object

Key

required

string

PermissionId

required

string

StatementKey

required

string

RowVersion

required

string format: uuid

Responsibilities

required

Array<object>

Describes one Responsibility Definition.

object

Key

required

string

SubjectMode

required

string

Cardinality

required

string

Required

required

boolean

FutureScheduling

required

boolean

EligibleResponsibilityGroupKeys

required

Array<string>

Enabled

required

boolean

RowVersion

required

string format: uuid

InitialAssignmentRules

required

Array<object>

Describes one initial responsibility rule.

object

Key

required

string

ResponsibilityKey

required

string

SubjectSource

required

string

SubjectKey

string

nullable

Enabled

required

boolean

RowVersion

required

string format: uuid

AssignmentRules

required

Array<object>

Describes one responsibility assignment rule.

object

Key

required

string

ResponsibilityKey

required

string

ActorSelectorType

required

string

ActorSelectorKey

required

string

Actions

required

Array<string>

EligibleTargets

required

Array<object>

Identifies one eligible assignment target selector.

object

SelectorType

required

string

SelectorKey

string

nullable

Enabled

required

boolean

RowVersion

required

string format: uuid

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

Returns the current Entity Security configuration.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example

401

Examplegenerated

403

Examplegenerated

404

Example

Example^generated

Example^generated