Skip to content
  • Auto
  • Light
  • Dark
Get Started

Shared

Shared

Shared

C1 API Policy V1 Accept
C1APIPolicyV1Accept

This policy step indicates that a ticket should have an approved outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.

ShowShow
acceptMessagestring
optional

An optional message to include in the comments when a task is automatically accepted.

C1 API Policy V1 Policy Step
C1APIPolicyV1PolicyStep

The PolicyStep message.

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

  • approval
  • provision
  • accept
  • reject
  • wait
ShowShow
acceptunion
optional
acceptMessagestringC1APIPolicyV1Accept | null

This policy step indicates that a ticket should have an approved outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.

approvalunion
optional
agentunionallowedReassigneesunionallowReassignmentbooleanappOwnersunionassignedbooleanentitlementOwnersunionescalationEscalationescalationEnabledbooleanexpressionuniongroupunionmanagerunionrequireApprovalReasonbooleanrequireDenialReasonbooleanrequireReassignmentReasonbooleanrequiresStepUpProviderIdstringresourceOwnersunionselfunionusersunionwebhookunionApproval | null

The Approval message.

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

  • users
  • manager
  • appOwners
  • group
  • self
  • entitlementOwners
  • expression
  • webhook
  • resourceOwners
  • agent
provisionunion
optional
assignedbooleanprovisionPolicyC1APIPolicyV1ProvisionPolicyprovisionTargetProvisionTargetProvision | null

The provision step references a provision policy for this step.

rejectunion
optional
rejectMessagestringC1APIPolicyV1Reject | null

This policy step indicates that a ticket should have a denied outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.

waitunion
optional
commentOnFirstWaitstringcommentOnTimeoutstringconditionunionnamestringtimeoutDurationstringC1APIPolicyV1Wait | null

Define a Wait step for a policy to wait on a condition to be met.

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

  • condition
C1 API Policy V1 Reject
C1APIPolicyV1Reject

This policy step indicates that a ticket should have a denied outcome. This is a terminal approval state and is used to explicitly define the end of approval steps.

ShowShow
rejectMessagestring
optional

An optional message to include in the comments when a task is automatically rejected.

C1 API Policy V1 Wait
C1APIPolicyV1Wait

Define a Wait step for a policy to wait on a condition to be met.

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

  • condition
ShowShow
commentOnFirstWaitstring
optional

The comment to post on first failed check.

commentOnTimeoutstring
optional

The comment to post if we timeout.

conditionunion
optional
conditionstringC1APIPolicyV1WaitCondition | null

The WaitCondition message.

namestring
optional

The name of our condition to show on the task details page

timeoutDurationstring
optional
formatduration
C1 API Policy V1 Wait Condition
C1APIPolicyV1WaitCondition

The WaitCondition message.

ShowShow
conditionstring
optional

The condition that has to be true for this wait condition to continue.