Skip to main content
PATCH
Patch Access Policy

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

access_policy_id
string
required

The access policy's ID, which GET /v1/access-policies returns as id.

Body

application/json

A merge-patch body. A field you omit keeps its value, and no field can be null.

name
string

The name of the access policy.

business_justification
string

Explanation for why this policy exists.

Maximum string length: 500
status
enum<string>

The status of the access policy, draft or published.

Available options:
draft,
published
is_enabled
boolean

Whether the access policy is enabled.

access_condition
object

The Lumos Condition object determining which identities qualify for this policy. Cannot be sent together with is_everyone_condition: true. For more information, see the Lumos Conditions documentation.

is_everyone_condition
boolean

Send true to make the access policy apply to everyone, replacing its access_condition. false changes nothing. The everyone condition a read returns in access_condition counts as true.

apps
AccessPolicyAppInput · object[]

The apps granted by this access policy. Replaces the current apps wholesale.

Minimum array length: 1

Response

Successful Response

The full representation of an access policy returned by the V1 API.

name
string
required

The name of the access policy.

business_justification
string
required

Explanation for why this policy exists.

Maximum string length: 500
id
string
required

The unique ID of the access policy.

status
enum<string>
required

The status of the access policy.

Available options:
draft,
published
is_enabled
boolean
required

Whether the access policy is enabled.

apps
AccessPolicyAppOutput · object[]
required

The apps and entitlements granted by this access policy.

access_condition
object
required

The Lumos Condition object determining which identities qualify for this policy. For more information, see the Lumos Conditions documentation.

is_everyone_condition
boolean
required
read-only

True when the policy applies to everyone in your organization. In that case, access_condition holds the condition Lumos uses to match everyone.

owners
OwnersOutput · object | null

The users and groups that own this access policy. Returned only with expand=owners, owners.users, or owners.groups.