Policies

Policies

Policies

Create

post/api/v1/policies

Get

get/api/v1/policies/{id}

Update

post/api/v1/policies/{id}

List

get/api/v1/policies

Delete

delete/api/v1/policies/{id}

Test

post/api/v1/policies/test-account-provision-policy

List Policy Response

ListPolicyResponseobject

The ListPolicyResponse message.

ShowShow

listarray of idstringcreatedAtstringdeletedAtstringdescriptionstringdisplayNamestringpolicyStepsmappolicyTypeenumpostActionsarray of PolicyPostActionsreassignTasksToDelegatesbooleanrulesarray of RulesystemBuiltinbooleanupdatedAtstringPolicy

optional

The list of results containing up to X results, where X is the page size defined in the request

nextPageTokenstring

optional

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

Policy

Policyobject

A policy describes the behavior of the ConductorOne system when processing a task. You can describe the type, approvers, fallback behavior, and escalation processes.

ShowShow

idstring

optional

The ID of the Policy.

createdAtstring

optional

formatdate-time

deletedAtstring

optional

formatdate-time

descriptionstring

optional

The description of the Policy.

displayNamestring

optional

The display name of the Policy.

policyStepsmap

optional

A map of string(policy type) to steps in a policy. This structure is leftover from a previous design, and should only ever have one key->value set.

Hide ParametersShow Parameters

stepsarray of acceptC1APIPolicyV1AcceptapprovalApprovalprovisionProvisionrejectC1APIPolicyV1RejectwaitC1APIPolicyV1WaitC1APIPolicyV1PolicyStep

optional

An array of policy steps indicating the processing flow of a policy. These steps are oneOfs, and only one property may be set for each array index at a time.

policyTypeenum

optional

"POLICY_TYPE_UNSPECIFIED" OR "POLICY_TYPE_GRANT" OR "POLICY_TYPE_REVOKE" OR 3 more

Indicates the type of this policy. Can also be used to get the value from policySteps.

Hide ParametersShow Parameters

"POLICY_TYPE_UNSPECIFIED"

"POLICY_TYPE_GRANT"

"POLICY_TYPE_REVOKE"

"POLICY_TYPE_CERTIFY"

"POLICY_TYPE_ACCESS_REQUEST"

"POLICY_TYPE_PROVISION"

postActionsarray of certifyRemediateImmediatelybooleanPolicyPostActions

optional

An array of actions (ordered) to take place after a policy completes processing.

reassignTasksToDelegatesboolean

optional

A policy configuration option that allows for reassinging tasks to delgated users. This level of delegation refers to the individual delegates users set on their account.

rulesarray of conditionstringpolicyKeystringRule

optional

The rules field.

systemBuiltinboolean

optional

Whether this policy is a builtin system policy. Builtin system policies cannot be edited.

updatedAtstring

optional

formatdate-time

Policy Post Actions

PolicyPostActionsobject

These are actions to happen after a policy is complete.

This message contains a oneof named action. Only a single field of the following list may be set at a time:

• certifyRemediateImmediately

ShowShow

certifyRemediateImmediatelyboolean

optional

ONLY valid when used in a CERTIFY Ticket Type: Causes any deprovision or change in a grant to be applied when Certify Ticket is closed. This field is part of the action oneof. See the documentation for c1.api.policy.v1.PolicyPostActions for more details.

Rule

Ruleobject

The Rule message.

ShowShow

conditionstring

optional

The condition field.

policyKeystring

optional

This is a reference to a list of policy steps from policy_steps

PoliciesValidate

Validate Cel

post/api/v1/policies/validate/cel