Skip to content

Returns Access Policies, exact capability groups, Permissions, and configuration health.

GET
/api/workspace/admin/entity-definitions/{entityDefinitionId}/security/access-policies
curl --request GET \
--url https://example.com/api/workspace/admin/entity-definitions/example/security/access-policies
  • None
entityDefinitionId
required
string
access_token
string

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

OK

Media typeapplication/json
object
Data

Returns the policy-first administration projection for one exact Security profile.

object
RowVersion
required
string format: uuid
ProfileKey
required
string
ResourceKind
required
string
Policies
required
Array<object>

Describes one Access Policy projected from a Statement and its Permission Assignments.

object
Key
required
string
Source
required
string
Enabled
required
boolean
PermissionIds
required
Array<string>
GuidedCondition

Describes a guided condition projection that can round-trip to the canonical Statement DSL.

object
MatchMode
required
string
Conditions
required
Array<object>

Describes one guided condition while retaining its exact DSL expression.

object
Kind
required
string
Expression
required
string
CapabilityGroups
required
Array<object>

Groups exact Permissions for policy-first selection without introducing a persisted preset.

object
Key
required
string
PermissionIds
required
Array<string>
Permissions
required
Array<object>

Describes one assignable permission.

object
PermissionId
required
string
PermissionKey
required
string
Category
required
string
SelectorKey
string
nullable
ParentPermissionKey
string
nullable
ValueFamily
string
nullable
SupportsCreate
required
boolean
SupportsExisting
required
boolean
Health
required

Summarizes configuration-level Security health without evaluating a concrete user or record.

object
RootViewCovered
required
boolean
DisabledPolicyCount
required
integer format: int32
UnusedPolicyCount
required
integer format: int32
UncoveredExactPermissionCount
required
integer format: int32
RedundantFieldRefinementCount
required
integer format: int32
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
}
]
}

Bad Request

Media typeapplication/json
object
Data

Returns the policy-first administration projection for one exact Security profile.

object
RowVersion
required
string format: uuid
ProfileKey
required
string
ResourceKind
required
string
Policies
required
Array<object>

Describes one Access Policy projected from a Statement and its Permission Assignments.

object
Key
required
string
Source
required
string
Enabled
required
boolean
PermissionIds
required
Array<string>
GuidedCondition

Describes a guided condition projection that can round-trip to the canonical Statement DSL.

object
MatchMode
required
string
Conditions
required
Array<object>

Describes one guided condition while retaining its exact DSL expression.

object
Kind
required
string
Expression
required
string
CapabilityGroups
required
Array<object>

Groups exact Permissions for policy-first selection without introducing a persisted preset.

object
Key
required
string
PermissionIds
required
Array<string>
Permissions
required
Array<object>

Describes one assignable permission.

object
PermissionId
required
string
PermissionKey
required
string
Category
required
string
SelectorKey
string
nullable
ParentPermissionKey
string
nullable
ValueFamily
string
nullable
SupportsCreate
required
boolean
SupportsExisting
required
boolean
Health
required

Summarizes configuration-level Security health without evaluating a concrete user or record.

object
RootViewCovered
required
boolean
DisabledPolicyCount
required
integer format: int32
UnusedPolicyCount
required
integer format: int32
UncoveredExactPermissionCount
required
integer format: int32
RedundantFieldRefinementCount
required
integer format: int32
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
}
]
}

Unauthorized

Media typeapplication/json
object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable
key
additional properties
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

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
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example",
"instance": "example"
}

Not Found

Media typeapplication/json
object
Data

Returns the policy-first administration projection for one exact Security profile.

object
RowVersion
required
string format: uuid
ProfileKey
required
string
ResourceKind
required
string
Policies
required
Array<object>

Describes one Access Policy projected from a Statement and its Permission Assignments.

object
Key
required
string
Source
required
string
Enabled
required
boolean
PermissionIds
required
Array<string>
GuidedCondition

Describes a guided condition projection that can round-trip to the canonical Statement DSL.

object
MatchMode
required
string
Conditions
required
Array<object>

Describes one guided condition while retaining its exact DSL expression.

object
Kind
required
string
Expression
required
string
CapabilityGroups
required
Array<object>

Groups exact Permissions for policy-first selection without introducing a persisted preset.

object
Key
required
string
PermissionIds
required
Array<string>
Permissions
required
Array<object>

Describes one assignable permission.

object
PermissionId
required
string
PermissionKey
required
string
Category
required
string
SelectorKey
string
nullable
ParentPermissionKey
string
nullable
ValueFamily
string
nullable
SupportsCreate
required
boolean
SupportsExisting
required
boolean
Health
required

Summarizes configuration-level Security health without evaluating a concrete user or record.

object
RootViewCovered
required
boolean
DisabledPolicyCount
required
integer format: int32
UnusedPolicyCount
required
integer format: int32
UncoveredExactPermissionCount
required
integer format: int32
RedundantFieldRefinementCount
required
integer format: int32
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
}
]
}