Skip to main content
POST
Search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

Search for tasks based on a plethora filters.

accessReviewIds
string[] | null

Search tasks that belong to any of the access reviews included in this list.

accountOwnerIds
string[] | null

Search tasks that have any of these account owners.

accountTypes
enum<string>[] | null

The accountTypes field.

Available options:
APP_USER_TYPE_UNSPECIFIED,
APP_USER_TYPE_USER,
APP_USER_TYPE_SERVICE_ACCOUNT,
APP_USER_TYPE_SYSTEM_ACCOUNT
actorId
string | null

Search tasks that have this actor ID.

appEntitlementIds
string[] | null

Search tasks that have any of these app entitlement IDs.

appResourceIds
string[] | null

Search tasks that have any of these app resource IDs.

appResourceTypeIds
string[] | null

Search tasks that have any of these app resource type IDs.

appUserSubjectIds
string[] | null

Search tasks that have any of these app users as subjects.

applicationIds
string[] | null

Search tasks that have any of these apps as targets.

assignedOrStepApproverUserId
string | null

Search tasks that are currently assigned to this user, or that are closed and were previously approved by this user.

assigneesInIds
string[] | null

Search tasks by List of UserIDs which are currently assigned these Tasks

certifyOutcomes
enum<string>[] | null

Search tasks by certify outcome

Available options:
CERTIFY_OUTCOME_UNSPECIFIED,
CERTIFY_OUTCOME_CERTIFIED,
CERTIFY_OUTCOME_DECERTIFIED,
CERTIFY_OUTCOME_ERROR,
CERTIFY_OUTCOME_CANCELLED,
CERTIFY_OUTCOME_WAIT_TIMED_OUT
createdAfter
string<date-time> | null
createdBefore
string<date-time> | null
currentStep
enum<string> | null

Search tasks that have this type of step as the current step.

Available options:
TASK_SEARCH_CURRENT_STEP_UNSPECIFIED,
TASK_SEARCH_CURRENT_STEP_APPROVAL,
TASK_SEARCH_CURRENT_STEP_PROVISION
emergencyStatus
enum<string> | null

Search tasks that are or are not emergency access.

Available options:
UNSPECIFIED,
ALL,
NON_EMERGENCY,
EMERGENCY
excludeAppEntitlementIds
string[] | null

Search tasks that do not have any of these app entitlement IDs.

excludeAppResourceTypeIds
string[] | null

Search tasks that do not have any of these app resource type IDs.

excludeApplicationIds
string[] | null

Search tasks that do NOT have any of these apps as targets.

excludeIds
string[] | null

Exclude Specific TaskIDs from this serach result.

expandMask
Task Expand Mask · object | null

The task expand mask is an array of strings that specifes the related objects the requester wishes to have returned when making a request where the expand mask is part of the input. Use '*' to view all possible responses.

grantOutcomes
enum<string>[] | null

Search tasks by grant outcome

Available options:
GRANT_OUTCOME_UNSPECIFIED,
GRANT_OUTCOME_GRANTED,
GRANT_OUTCOME_DENIED,
GRANT_OUTCOME_ERROR,
GRANT_OUTCOME_CANCELLED,
GRANT_OUTCOME_WAIT_TIMED_OUT
includeActedAfter
string<date-time> | null
includeDeleted
boolean | null

Whether or not to include deleted tasks.

myWorkUserIds
string[] | null

Search tasks where the user would see this task in the My Work section

olderThanDuration
string<duration> | null
openerIds
string[] | null

Search tasks that were created by any of the users in this array.

openerOrSubjectUserId
string | null

Search tasks that were opened by this user, or that the user is the subject of.

outcomeAfter
string<date-time> | null
outcomeBefore
string<date-time> | null
pageSize
integer<int32> | null

The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)

pageToken
string | null

The pageToken field.

pendingActionFilter
enum<string> | null

Filter tasks by pending action status. Only applies when exactly one access_review_id is specified. Requires the REVIEWS_PENDING_ACTIONS feature flag to be enabled.

Available options:
PENDING_ACTION_FILTER_UNSPECIFIED,
PENDING_ACTION_FILTER_WITH_PENDING,
PENDING_ACTION_FILTER_WITHOUT_PENDING
previouslyActedOnIds
string[] | null

Search tasks that were acted on by any of these users.

query
string | null

Fuzzy search tasks by display name, description, or ID.

refs
Task Ref · object[] | null

Query tasks by display name, description, or numeric ID.

requireApprovalReason
boolean | null

Filter tasks where the current approval step requires an approval reason.

requireDenialReason
boolean | null

Filter tasks where the current approval step requires a denial reason.

revokeOutcomes
enum<string>[] | null

Search tasks by revoke outcome

Available options:
REVOKE_OUTCOME_UNSPECIFIED,
REVOKE_OUTCOME_REVOKED,
REVOKE_OUTCOME_DENIED,
REVOKE_OUTCOME_ERROR,
REVOKE_OUTCOME_CANCELLED,
REVOKE_OUTCOME_WAIT_TIMED_OUT
sortBy
enum<string> | null

Sort tasks in a specific order.

Available options:
TASK_SEARCH_SORT_BY_UNSPECIFIED,
TASK_SEARCH_SORT_BY_ACCOUNT,
TASK_SEARCH_SORT_BY_RESOURCE,
TASK_SEARCH_SORT_BY_ACCOUNT_OWNER,
TASK_SEARCH_SORT_BY_REVERSE_TICKET_ID,
TASK_SEARCH_SORT_BY_TICKET_ID,
TASK_SEARCH_SORT_BY_CREATED_AT,
TASK_SEARCH_SORT_BY_REVERSE_CREATED_AT,
TASK_SEARCH_SORT_BY_APP_RESOURCE_ID_AND_APP_ENTITLEMENT
stepApprovalTypes
enum<string>[] | null

Search tasks that have a current policy step of this type

Available options:
STEP_APPROVAL_TYPE_UNSPECIFIED,
STEP_APPROVAL_TYPE_USERS,
STEP_APPROVAL_TYPE_MANAGER,
STEP_APPROVAL_TYPE_APP_OWNERS,
STEP_APPROVAL_TYPE_GROUP,
STEP_APPROVAL_TYPE_SELF,
STEP_APPROVAL_TYPE_ENTITLEMENT_OWNERS,
STEP_APPROVAL_TYPE_EXPRESSION,
STEP_APPROVAL_TYPE_WEBHOOK,
STEP_APPROVAL_TYPE_RESOURCE_OWNERS,
STEP_APPROVAL_TYPE_AGENT
subjectIds
string[] | null

Search tasks where these users are the subject.

taskStates
enum<string>[] | null

Search tasks with this task state.

Available options:
TASK_STATE_UNSPECIFIED,
TASK_STATE_OPEN,
TASK_STATE_CLOSED
taskTypes
Task Type · object[] | null

Search tasks with this task type. This is a oneOf, and needs an object, which can be empty, to sort.

userEmploymentStatuses
string[] | null

The userEmploymentStatuses field.

Response

200 - application/json

The TaskSearchResponse message contains a list of results and a nextPageToken if applicable.

The TaskSearchResponse message contains a list of results and a nextPageToken if applicable.

expanded
object[] | null

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

list
Task View · object[] | null

List of serialized related objects.

nextPageToken
string | null

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.