Skip to main content
PUT
Update a model access policy

Authorizations

Authorization
string
header
required

An access token from Barndoor's identity provider, sent as Authorization: Bearer <token>. Use a service-account token from the OAuth 2.0 client-credentials grant for scripts and CI, or a signed-in user's token. The caller needs the admin role in the organization. Gateway API keys (bd-...) are not accepted here.

Path Parameters

id
string<uuid>
required

Record ID (UUID)

Body

application/json
change_note
string | null

Optional note explaining this change. Omitting it clears the previous note.

enabled
boolean | null
name
string | null
policy_type
string | null
scope_id
string<uuid> | null

UUID of the scoped entity, for UUID-keyed scope types such as user, team, or api_key. Omit to leave unchanged; send null to clear.

scope_type
string | null
scope_value
string | null

Name of the scoped entity, for name-keyed scope types, such as a role or IdP group name. Omit to leave unchanged; send null to clear.

targets
object[] | null

One thing a model access policy allows or denies, selected by kind.

traffic_type
string | null

Response

OK

A model access policy.

enabled
boolean
required
id
string<uuid>
required
name
string
required
org_id
string<uuid>
required
policy_type
string
required
scope_type
string
required
targets
object[]
required

One thing a model access policy allows or denies, selected by kind.

traffic_type
string
required
scope_id
string<uuid> | null
scope_value
string | null
created_by_email
string | null
created_by_name
string | null
created_by_user_id
string<uuid> | null
last_change_note
string | null

Note explaining the last change.

last_modified_at
string<date-time> | null

When the last attributed change was made.

last_modified_by_email
string | null
last_modified_by_name
string | null
last_modified_by_user_id
string<uuid> | null