POST Flow/Tickets/Reject

Changes the status of a Flow Ticket to Rejected.You can only reject Flow Tickets that have a status of Pending. For example, if someone requests to join a team, the ticket moves to a Pending state for approval or rejection. For more information, see Flow Ticket status codes.

NOTE If you are using this API call to prevent a person or group from joining a Team, the requester receives an email confirmation. The email includes Comment and other information.

Requirements

The caller must be a Flow Ticket approver of the resource. For Team flow approvals, the caller must be the team owner.
Token scope: Any valid scope, such as Agent, Certificate, or SSH:Approve

Headers

Content type: Content-Type:application/json.
Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Specify TicketId or the TicketIDs array, not both.

Input parameters
Name	Description
Comment	The reason for rejecting the Flow Ticket.
RejectionLevel	One of the following actions: 1 = Retry. Rejection and allow another attempt to restart an action on a Flow. For example, member can attempt to join a team again. 2 = Final. Stop the Flow. No further action is allowed.
TicketId	Case sensitive. A Flow Ticket Id that is Pending review for approval or rejection. Carefully review and use an Id from POST Flow/Tickets/Enumerate.
TicketIds	Case sensitive. An array of Flow Ticket Ids that are Pending review for approval or rejection. Carefully review and use Ids from POST Flow/Tickets/Enumerate.
Comment	The reason for rejection.

Returns

Valid requests return an HTTP 200. Request with errors return one of the following:

Response description
Name	Description
Error	The reason the HTTP 400 Bad Request occurred.
InvalidTicketIds	If present, an array of Ticket IDs that are not currently in the Pending state. For example, the Flow Ticket was already rejected.
Message	Appears only if Result is a non-zero value. One of the following reasons that the Flow Ticket was rejected: RejectionLevel must be set to Retry (1) or Final (2). Ticket IDs are missing.
Result	The Result code of this API call. For more information, see Flow Ticket result codes.

Example: Reject a set of Flow Tickets

Request

POST https://tpp.venafi.example/vedsdk/Flow/Tickets/Reject
Authorization:Bearer 4MyGeneratedBearerTknz==
{{
   "TicketIDs":[
      3,
      4
   ],
   "Comment":"Your request to join Team A was rejected.",
   "RejectionLevel":1
}

Response

HTTP/1.1 200 OK
{
}