Skip to content
  • Auto
  • Light
  • Dark
Get Started

Shared

Shared

Shared

C1 API Policy V1 Accept
C1APIPolicyV1Acceptstruct

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
C1APIPolicyV1PolicyStepstruct

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
AcceptAcceptMessagestringC1APIPolicyV1Accept
optional

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.

ApprovalAgentApprovalAgentAllowedReassigneesarrayAllowReassignmentboolAppOwnersApprovalAppOwnersAssignedboolEntitlementOwnersApprovalEntitlementOwnersEscalationApprovalEscalationEscalationEnabledboolExpressionApprovalExpressionGroupApprovalGroupManagerApprovalManagerRequireApprovalReasonboolRequireDenialReasonboolRequireReassignmentReasonboolRequiresStepUpProviderIDstringResourceOwnersApprovalResourceOwnersSelfApprovalSelfUsersApprovalUsersWebhookApprovalWebhookApproval
optional

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
ProvisionAssignedboolProvisionPolicyC1APIPolicyV1ProvisionPolicyProvisionTargetProvisionProvisionTargetProvision
optional

The provision step references a provision policy for this step.

RejectRejectMessagestringC1APIPolicyV1Reject
optional

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.

WaitCommentOnFirstWaitstringCommentOnTimeoutstringConditionC1APIPolicyV1WaitConditionNamestringTimeoutDurationstringC1APIPolicyV1Wait
optional

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
C1APIPolicyV1Rejectstruct

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
C1APIPolicyV1Waitstruct

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.

ConditionConditionstringC1APIPolicyV1WaitCondition
optional

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
C1APIPolicyV1WaitConditionstruct

The WaitCondition message.

ShowShow
Conditionstring
optional

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