Returns Access Policies, capability groups, exact Permissions, and health for one Board profile.

GET

/api/workspace/admin/boards/boards/{boardId}/security/profiles/{resourceKind}/access-policies

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/boards/boards/example/security/profiles/example/access-policies"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
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/boards/boards/example/security/profiles/example/access-policies';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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/boards/boards/example/security/profiles/example/access-policies \
  --header 'Authorization: Bearer <token>'

Authorizations

WorkspaceBearer

Parameters

Path Parameters

boardId

required

string

resourceKind

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

ManagedBy

The configuration object that owns a generated Security artifact.

object

Kind

Owner resource kind.

string

nullable

Stable owner identity.

string

nullable

Label

Current owner display name or key.

string

nullable

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

400

Bad Request

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

ManagedBy

The configuration object that owns a generated Security artifact.

object

Kind

Owner resource kind.

string

nullable

Stable owner identity.

string

nullable

Label

Current owner display name or key.

string

nullable

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

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

ManagedBy

The configuration object that owns a generated Security artifact.

object

Kind

Owner resource kind.

string

nullable

Stable owner identity.

string

nullable

Label

Current owner display name or key.

string

nullable

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

Returns Access Policies, capability groups, exact Permissions, and health for one Board profile.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

400

Example

401

Examplegenerated

403

Examplegenerated

404

Example

Example^generated

Example^generated