Skip to main content
PATCH
Patch Access Policy Draft

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 for a policy's draft. Owners, status and enablement belong to the policy, so sending them is refused like any other unknown field.

name
string

The name of the access policy.

business_justification
string

Explanation for why this policy exists.

Maximum string length: 500
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 draft version of an access policy.

Owners, status and enablement belong to the policy rather than a version, so the draft leaves them out. Read them from GET /v1/access-policies/{id}.

name
string
required

The name of the access policy.

business_justification
string
required

Explanation for why this policy exists.

Maximum string length: 500
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.