Skip to main content
GET
Get policy

Path Parameters

workspaceSlug
string
required

URL-safe workspace identifier.

policySlug
string
required

URL slug of the policy, unique within its workspace.

Response

Response type for a workspace policy.

Response type for a workspace policy.

createdAt
string<date-time>
required

When the policy was created.

createdBy
object
required

Account that created this policy.

definition
object
required

The structured policy body consumed by the engine.

displayName
string
required

Human-readable policy display name.

slug
string
required

URL slug of the policy, unique within its workspace.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
updatedAt
string<date-time>
required

When the policy was last updated.

workspaceSlug
string
required

Handle of the workspace this policy belongs to.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
description
string

Policy description.