COconductorone
Policy

Search

Changed on

Search policies based on filters specified in the request body.

post/api/v1/search/policies

Request

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

Request body

displayNamestring

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

excludePolicyIdsstring[] nullable

The policy IDs to exclude from the search.

includeDeletedboolean

The includeDeleted field.

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.

policyTypesstring[] nullable

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.

querystring

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

scopeAppEntitlementIdstring

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

scopeAppIdstring

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

scopeObjectType'POLICY_SCOPE_OBJECT_TYPE_UNSPECIFIED' | 'POLICY_SCOPE_OBJECT_TYPE_APP' | 'POLICY_SCOPE_OBJECT_TYPE_ENTITLEMENT'

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

scopeSlot'POLICY_SCOPE_SLOT_UNSPECIFIED' | 'POLICY_SCOPE_SLOT_EMERGENCY'

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.

scopeView'POLICY_SCOPE_VIEW_UNSPECIFIED' | 'POLICY_SCOPE_VIEW_GLOBAL' | 'POLICY_SCOPE_VIEW_SCOPED' | 'POLICY_SCOPE_VIEW_ALL' | 'POLICY_SCOPE_VIEW_GLOBAL_AND_OBJECT'

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).

Response

Successful response

nextPageTokenstring

The nextPageToken field.

Changes

  • fe943bedf41bRevision changes
    • info

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

  • 918a4e749f56Revision changes
    • info

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