Search

Search

Search

Search App Resource Types

client.search.createAppResourceTypes(SearchCreateAppResourceTypesParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringSearchCreateAppResourceTypesResponse

post/api/v1/search/app_resource_types

Search App Resources

client.search.createAppResources(SearchCreateAppResourcesParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreateAppResourcesResponse

post/api/v1/search/app_resources

Search

client.search.createAppUsers(SearchCreateAppUsersParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreateAppUsersResponse

post/api/v1/search/app_users

Search Attribute Values

client.search.createAttributes(SearchCreateAttributesParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringSearchCreateAttributesResponse

post/api/v1/search/attributes

Search

client.search.createEntitlements(SearchCreateEntitlementsParamsbody?, RequestOptionsoptions?): expandedunionfacetsFacetslistunionnextPageTokenstringSearchCreateEntitlementsResponse

post/api/v1/search/entitlements

Search Grants

client.search.createGrants(SearchCreateGrantsParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreateGrantsResponse

post/api/v1/search/grants

Search Past Grants

client.search.createPastGrants(SearchCreatePastGrantsParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreatePastGrantsResponse

post/api/v1/search/past-grants

Search

client.search.createPolicies(SearchCreatePoliciesParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringListPolicyResponse

post/api/v1/search/policies

Search

client.search.createTasks(SearchCreateTasksParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreateTasksResponse

post/api/v1/search/tasks

Search

client.search.createUsers(SearchCreateUsersParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringSearchCreateUsersResponse

post/api/v1/search/users

Search

client.search.createWebhooks(SearchCreateWebhooksParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringSearchCreateWebhooksResponse

post/api/v1/search/webhooks

Task Expand Mask

TaskExpandMask

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.

ShowShow

pathsunion

optional

Array<string> | null

A list of paths to expand in the response. May be any combination of "*", "access_review_id", "user_id", "created_by_user_id", "app_id", "app_user_id", "app_entitlement_ids", "step_approver_ids", "identity_user_id", and "insight_ids".

Task Type

TaskType

Task Type provides configuration for the type of task: certify, grant, or revoke

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

• grant
• revoke
• certify
• offboarding

ShowShow

certifyunion

optional

accessReviewIdstringaccessReviewSelectionstringappEntitlementIdstringappIdstringappUserIdstringidentityUserIdstringoutcomeunionoutcomeTimestringCertify | null

The TaskTypeCertify message indicates that a task is a certify task and all related details.

Hide ParametersShow Parameters

accessReviewIdstring

optional

The ID of the access review.

accessReviewSelectionstring

optional

The ID of the specific access review object that owns this certify task. This is also set on a revoke task if the revoke task is created from the denied outcome of a certify task.

appEntitlementIdstring

optional

The ID of the app entitlement.

appIdstring

optional

The ID of the app.

appUserIdstring

optional

The ID of the app user.

identityUserIdstring

optional

The ID of the user.

outcomeunion

optional

"CERTIFY_OUTCOME_UNSPECIFIED" | "CERTIFY_OUTCOME_CERTIFIED" | "CERTIFY_OUTCOME_DECERTIFIED" | 3 more

The outcome of the certification.

Hide ParametersShow Parameters

"CERTIFY_OUTCOME_UNSPECIFIED"

"CERTIFY_OUTCOME_CERTIFIED"

"CERTIFY_OUTCOME_DECERTIFIED"

"CERTIFY_OUTCOME_ERROR"

"CERTIFY_OUTCOME_CANCELLED"

"CERTIFY_OUTCOME_WAIT_TIMED_OUT"

outcomeTimestring

optional

formatdate-time

grantunion

optional

appEntitlementIdstringappIdstringappUserIdstringgrantDurationstringidentityUserIdstringoutcomeunionoutcomeTimestringsourceTaskGrantSourceGrant | null

The TaskTypeGrant message indicates that a task is a grant task and all related details.

Hide ParametersShow Parameters

appEntitlementIdstring

optional

The ID of the app entitlement.

appIdstring

optional

The ID of the app.

appUserIdstring

optional

The ID of the app user.

grantDurationstring

optional

formatduration

identityUserIdstring

optional

The ID of the user.

outcomeunion

optional

"GRANT_OUTCOME_UNSPECIFIED" | "GRANT_OUTCOME_GRANTED" | "GRANT_OUTCOME_DENIED" | 3 more

The outcome of the grant.

Hide ParametersShow Parameters

"GRANT_OUTCOME_UNSPECIFIED"

"GRANT_OUTCOME_GRANTED"

"GRANT_OUTCOME_DENIED"

"GRANT_OUTCOME_ERROR"

"GRANT_OUTCOME_CANCELLED"

"GRANT_OUTCOME_WAIT_TIMED_OUT"

outcomeTimestring

optional

formatdate-time

sourceexternalUrlstringintegrationIdstringrequestIdstringTaskGrantSource

optional

The TaskGrantSource message tracks which external URL was the source of the specificed grant ticket.

offboardingunion

optional

outcomeunionoutcomeTimestringsubjectUserIdstringOffboarding | null

The TaskTypeOffboarding message.

Hide ParametersShow Parameters

outcomeunion

optional

"OFFBOARDING_OUTCOME_UNSPECIFIED" | "OFFBOARDING_OUTCOME_IN_PROGRESS" | "OFFBOARDING_OUTCOME_DONE" | 2 more

The outcome field.

Hide ParametersShow Parameters

"OFFBOARDING_OUTCOME_UNSPECIFIED"

"OFFBOARDING_OUTCOME_IN_PROGRESS"

"OFFBOARDING_OUTCOME_DONE"

"OFFBOARDING_OUTCOME_ERROR"

"OFFBOARDING_OUTCOME_CANCELLED"

outcomeTimestring

optional

formatdate-time

subjectUserIdstring

optional

The subjectUserId field.

revokeunion

optional

appEntitlementIdstringappIdstringappUserIdstringidentityUserIdstringoutcomeunionoutcomeTimestringsourceSourceRevoke | null

The TaskTypeRevoke message indicates that a task is a revoke task and all related details.

Hide ParametersShow Parameters

appEntitlementIdstring

optional

The ID of the app entitlement.

appIdstring

optional

The ID of the app.

appUserIdstring

optional

The ID of the app user.

identityUserIdstring

optional

The ID of the user.

outcomeunion

optional

"REVOKE_OUTCOME_UNSPECIFIED" | "REVOKE_OUTCOME_REVOKED" | "REVOKE_OUTCOME_DENIED" | 3 more

The outcome of the revoke.

Hide ParametersShow Parameters

"REVOKE_OUTCOME_UNSPECIFIED"

"REVOKE_OUTCOME_REVOKED"

"REVOKE_OUTCOME_DENIED"

"REVOKE_OUTCOME_ERROR"

"REVOKE_OUTCOME_CANCELLED"

"REVOKE_OUTCOME_WAIT_TIMED_OUT"

outcomeTimestring

optional

formatdate-time

sourceexpiredunionnonUsageunionrequestunionreviewunionSource

optional

The TaskRevokeSource message indicates the source of the revoke task is one of expired, nonUsage, request, or review.

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

• review
• request
• expired
• nonUsage

Hide ParametersShow Parameters

expiredunion

optional

expiredAtstringExpired | null

The TaskRevokeSourceExpired message indicates that the source of the revoke task is due to a grant expiring.

Hide ParametersShow Parameters

expiredAtstring

optional

formatdate-time

nonUsageunion

optional

expiresAtstringlastLoginstringNonUsage | null

The TaskRevokeSourceNonUsage message indicates that the source of the revoke task is due to the grant not being used.

Hide ParametersShow Parameters

expiresAtstring

optional

formatdate-time

lastLoginstring

optional

formatdate-time

requestunion

optional

requestUserIdstringRequest | null

The TaskRevokeSourceRequest message indicates that the source of the revoke task was a request.

Hide ParametersShow Parameters

requestUserIdstring

optional

The ID of the user who initiated the revoke request.

reviewunion

optional

accessReviewIdstringcertTicketIdstringReview | null

The TaskRevokeSourceReview message tracks which access review was the source of the specificed revoke ticket.

Hide ParametersShow Parameters

accessReviewIdstring

optional

The ID of the access review associated with the revoke task.

certTicketIdstring

optional

The ID of the certify ticket that was denied and created this revoke task.

SearchApps

Search

client.search.apps.create(AppCreateParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringAppCreateResponse

post/api/v1/search/apps

SearchAppsEntitlements

Search App Entitlements For App User

client.search.apps.entitlements.retrieve(stringappUserID, EntitlementRetrieveParamsparams, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringC1APIAppV1ListAppEntitlementsResponse

get/api/v1/search/apps/{app_id}/entitlements/users/{app_user_id}

SearchIAM

NOTE: Searches personal clients for all users

client.search.iam.createPersonalClients(IAMCreatePersonalClientsParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringIAMCreatePersonalClientsResponse

post/api/v1/search/iam/personal_clients

SearchRequest Catalog

Search Entitlements

client.search.requestCatalog.createEntitlements(RequestCatalogCreateEntitlementsParamsbody?, RequestOptionsoptions?): expandedunionlistunionnextPageTokenstringRequestCatalogCreateEntitlementsResponse

post/api/v1/search/request_catalog/entitlements

SearchStep Up

Search

client.search.stepUp.createProviders(StepUpCreateProvidersParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringStepUpCreateProvidersResponse

post/api/v1/search/step-up/providers

Search

client.search.stepUp.createTransactions(StepUpCreateTransactionsParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringStepUpCreateTransactionsResponse

post/api/v1/search/step-up/transactions

SearchSystem Log

Search

client.search.systemLog.createExports(SystemLogCreateExportsParamsbody?, RequestOptionsoptions?): listunionnextPageTokenstringSystemLogCreateExportsResponse

post/api/v1/search/systemlog/exports