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 Policies by a few properties.

displayName
string

Search for policies with a case insensitive match on the display name.

excludePolicyIds
string[] | null

The policy IDs to exclude from the search.

includeDeleted
boolean

The includeDeleted field.

pageSize
integer<int32>

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

The pageToken field.

policyTypes
enum<string>[] | null

The policy type to search on. This can be POLICY_TYPE_GRANT, POLICY_TYPE_REVOKE, POLICY_TYPE_CERTIFY, POLICY_TYPE_ACCESS_REQUEST, or POLICY_TYPE_PROVISION.

Available options:
POLICY_TYPE_UNSPECIFIED,
POLICY_TYPE_GRANT,
POLICY_TYPE_REVOKE,
POLICY_TYPE_CERTIFY,
POLICY_TYPE_ACCESS_REQUEST,
POLICY_TYPE_PROVISION
query
string

Query the policies with a fuzzy search on display name and description.

refs
Policy Ref · object[] | null

The refs field.

scopeAppEntitlementId
string

When scope_view is POLICY_SCOPE_VIEW_SCOPED, only return policies scoped to this entitlement.

scopeAppId
string

When scope_view is POLICY_SCOPE_VIEW_SCOPED, only return policies scoped to this app.

scopeObjectType
enum<string>

When scope_view is POLICY_SCOPE_VIEW_SCOPED, narrow local policies to a coarse object type (app-local vs entitlement-local).

Available options:
POLICY_SCOPE_OBJECT_TYPE_UNSPECIFIED,
POLICY_SCOPE_OBJECT_TYPE_APP,
POLICY_SCOPE_OBJECT_TYPE_ENTITLEMENT
scopeSlot
enum<string>

When scope_view narrows to one object, only return that object's local policies in this slot. Ignored when no object is identified by scope_app_id, which lists every local policy regardless of slot.

Available options:
POLICY_SCOPE_SLOT_UNSPECIFIED,
POLICY_SCOPE_SLOT_EMERGENCY
scopeView
enum<string>

Which policies to return based on scope. Defaults to global-only, so app/entitlement-scoped policies never appear unless explicitly requested. Ignored when refs are provided (explicit ID lookups always resolve).

Available options:
POLICY_SCOPE_VIEW_UNSPECIFIED,
POLICY_SCOPE_VIEW_GLOBAL,
POLICY_SCOPE_VIEW_SCOPED,
POLICY_SCOPE_VIEW_ALL,
POLICY_SCOPE_VIEW_GLOBAL_AND_OBJECT

Response

200 - application/json

Successful response

The SearchPoliciesResponse message.

list
Policy · object[] | null

The list field.

nextPageToken
string

The nextPageToken field.