COconductorone
Task

Search

Changed on

Search tasks based on filters specified in the request body. Each TaskView row is large — request a small page_size (≤10) and set expand_mask to only the paths you need; broad expansion inlines whole related objects (app, entitlement, user, policy) and bloats the response.

post/api/v1/search/tasks

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/search/tasks
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

accessReviewIdsstring[] nullable

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

accountOwnerIdsstring[] nullable

Search tasks that have any of these account owners.

accountStatusesstring[] nullable

Search tasks by the account status of the app user subject.

accountTypesstring[] nullable

The accountTypes field.

actorIdstring

Search tasks that have this actor ID.

appEntitlementIdsstring[] nullable

Search tasks that have any of these app entitlement IDs.

appResourceIdsstring[] nullable

Search tasks that have any of these app resource IDs.

appResourceTypeIdsstring[] nullable

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

appUserSubjectIdsstring[] nullable

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

applicationIdsstring[] nullable

Search tasks that have any of these apps as targets.

assignedOrStepApproverUserIdstring

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

assigneesInIdsstring[] nullable

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

certifyOutcomesstring[] nullable

Search tasks by certify outcome

createdAfterstring date-time nullable
createdBeforestring date-time nullable
currentStep'TASK_SEARCH_CURRENT_STEP_UNSPECIFIED' | 'TASK_SEARCH_CURRENT_STEP_APPROVAL' | 'TASK_SEARCH_CURRENT_STEP_PROVISION'

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

emergencyStatus'UNSPECIFIED' | 'ALL' | 'NON_EMERGENCY' | 'EMERGENCY'

Search tasks that are or are not emergency access.

excludeAppEntitlementIdsstring[] nullable

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

excludeAppResourceTypeIdsstring[] nullable

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

excludeApplicationIdsstring[] nullable

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

excludeIdsstring[] nullable

Exclude Specific TaskIDs from this serach result.

grantOutcomesstring[] nullable

Search tasks by grant outcome

includeActedAfterstring date-time nullable
includeDeletedboolean

Whether or not to include deleted tasks.

myWorkUserIdsstring[] nullable

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

olderThanDurationstring duration nullable
openerIdsstring[] nullable

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

openerOrSubjectUserIdstring

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

outcomeAfterstring date-time nullable
outcomeBeforestring date-time nullable
pageSizeinteger

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

pageTokenstring

The pageToken field.

pendingActionFilter'PENDING_ACTION_FILTER_UNSPECIFIED' | 'PENDING_ACTION_FILTER_WITH_PENDING' | 'PENDING_ACTION_FILTER_WITHOUT_PENDING'

Filter tasks by pending action status. Only applies when exactly one access_review_id is specified.

previouslyActedOnIdsstring[] nullable

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

querystring

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

requireApprovalReasonboolean

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

requireDenialReasonboolean

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

revokeOutcomesstring[] nullable

Search tasks by revoke outcome

sortBy'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'

Sort tasks in a specific order.

stepApprovalTypesstring[] nullable

Search tasks that have a current policy step of this type

subjectIdsstring[] nullable

Search tasks where these users are the subject.

taskStatesstring[] nullable

Search tasks with this task state.

userEmploymentStatusesstring[] nullable

The userEmploymentStatuses field.

Response

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

nextPageTokenstring

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.

Changes

  • fe943bedf41bRevision changes
    • info

      added the new STEP_APPROVAL_TYPE_ACCESS_PROFILE_OWNERS enum value to the request property /

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ////////////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

  • 918a4e749f56Revision changes
    • warning

      added the new OPERATION_ISSUE_CREDENTIAL enum value to the //////////// response property for the response status

    • warning

      added the new TYPE_CREDENTIAL_ISSUE enum value to the //////// response property for the response status

    • warning

      added the new TYPE_SPEND_REMEDY enum value to the //////// response property for the response status

    • info

      added the new optional request property ////

    • info

      added the new OPERATION_ISSUE_CREDENTIAL enum value to the request property ////////

    • info

      added the new TYPE_CREDENTIAL_ISSUE enum value to the request property ////

    • info

      added the new TYPE_SPEND_REMEDY enum value to the request property ////

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////// to the response with the status

    • info

      added the optional property ////////////////////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property ////////// to the response with the status