COconductorone
App Entitlement

Search Grants

Changed on

Search grants (user-to-entitlement bindings) across apps, with filters for app, user, resource type, and entitlement. Rows are heavy (each binding carries a full entitlement + user view) — 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/grants

Request

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

Request body

appIdsstring[] nullable

Search for grants contained in any of these apps.

appUserIdsstring[] nullable

Search for grants that are granted to any of these app user ids.

entitlementSlugsstring[] nullable

Filter for entitlements whose slug is in this list (e.g. "enrollment" for access profiles)

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.

purposestring[] nullable

Filter for entitlements with these purposes (e.g., ASSIGNMENT for membership entitlements)

resourceIdsstring[] nullable

Search for grants within a resource.

resourceTypeIdsstring[] nullable

Search grants for given resource types.

userIdstring

Search for grants of a user

Response

Successful response

nextPageTokenstring

The nextPageToken field.

Changes

  • f2cf3228f366Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property type changed from object to no type

    • breaking

      added subschema #2 to the // response property oneOf list for the response 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

    • 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

    • 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