COconductorone
Request Catalog

Search Entitlements

Changed on

Search request catalogs based on filters specified in the request body. Rows are heavy (each entitlement carries its user bindings) — request a small page_size (≤10) and set expand_mask to only the paths you need; broad expansion inlines whole related objects and bloats the response.

post/api/v1/search/request_catalog/entitlements

Request

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

Request body

appDisplayNamestring

Search entitlements that belong to this app name (exact match).

entitlementAliasstring

Search for entitlements with this alias (exact match).

grantedStatus'UNSPECIFIED' | 'ALL' | 'GRANTED' | 'NOT_GRANTED'

Search entitlements with this granted status for your signed in user.

includeDeletedboolean

Include deleted entitlements

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.

querystring

Fuzzy search the display name of resource types.

Response

The RequestCatalogSearchServiceSearchEntitlementsResponse 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

  • f2cf3228f366Revision changes
    • breaking

      the request property type changed from object to no type

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      the response property //// became nullable for the status

    • breaking

      added subschema #2 to the // response property oneOf list for the response status

    • breaking

      the // response's property type changed from object to no type for status

    • warning

      removed the request property /

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • info

      added subschema #2 to the request property oneOf list

  • f6e337c979e4Revision changes
    • info

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