Resources

List resources

Returns a paginated list of resources in the specified zone. Use cursor pagination via after/before, and expand[]=total_count to include the matching row count. Filter by exact identifier via filter[identifier]. Filter by trait via filter[traits]: comma-separated values are AND'd, repeated params are OR'd. The scalar identifier query parameter is a backward-compatible alias for filter[identifier]: exact match on a single value, folded into the same exact-match identifier filter.

get/zones/{zoneId}/resources

Path parameters

zoneIdstring required

Zone ID

Query parameters

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]
string

Filter by exact resource identifier

OR
string[]
filter[owner_type]'platform' | 'customer'

Filter by owner type: platform (Keycard-managed) or customer (org-created).

identifierstring

Backward-compatible alias for filter[identifier]: exact match on a single resource identifier.

credentialProviderIdstring

Filter resources by credential provider ID

slugstring
string
OR
string[]

Filter by trait. Comma-separated values (a,b) are AND'd; repeated params are OR'd.

Response

Default Response

Changes

Changed in 11 of the 23 revisions of this API.1434

    • added the new optional query request parameter filter[identifier]

      new-optional-request-parameter

    • added the new optional query request parameter filter[owner_type]

      new-optional-request-parameter

    • added the new optional query request parameter filter[traits]

      new-optional-request-parameter

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the optional property items/items/credential_provider/allOf[subschema #1: Provider]/metadata/icon_url to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/credential_provider/allOf[subschema #1: Provider]/protocols/openid/external_id_claim to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/application/allOf[subschema #1: Application]/metadata/icon_url to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/credential_provider/allOf[subschema #1: Provider]/protocols/openid/single_logout_enabled to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/metadata/allOf[iam_Metadata]/icon_url to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/credential_provider/allOf[subschema #1: Provider]/protocols/openid/scopes to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/credential_lifetime_seconds to the response with the 200 status

      response-optional-property-added

    • added the required property items/items/prefix to the response with the 200 status

      response-required-property-added

    • added the required property items/items/application/allOf[subschema #1: Application]/consent to the response with the 200 status

      response-required-property-added

    • added the optional property items/items/credential_provider/allOf[subschema #1: Provider]/protocols/openid/user_identifier_claim to the response with the 200 status

      response-optional-property-added

  • d3d69f45bfed13See the full diff
    • removed the optional property items/items/application/allOf[subschema #1: Application]/traits from the response with the 200 status

      response-optional-property-removed

    • the endpoint scheme security OAuth2 was added to the API

      api-security-added

    • the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • the endpoint scheme security iam_bearerAuth was removed from the API

      api-security-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cb43483cd1b31112See the full diff
    • the items/items/metadata response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property items/items/metadata/docs_url from the response with the 200 status

      response-optional-property-removed

    • added the new optional query request parameter after

      new-optional-request-parameter

    • added the new optional query request parameter before

      new-optional-request-parameter

    • added the new optional query request parameter expand[]

      new-optional-request-parameter

    • added the new optional query request parameter limit

      new-optional-request-parameter

    • added the optional property items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/authorization_parameters to the response with the 200 status

      response-optional-property-added

    • added iam_Metadata to the items/items/metadata response property allOf list for the response status 200

      response-property-all-of-added

    • added the required property items/items/application/allOf[subschema #1: Application]/owner_type to the response with the 200 status

      response-required-property-added

    • added the required property items/items/application_type to the response with the 200 status

      response-required-property-added

    • added the required property items/items/credential_provider/allOf[subschema #1: Provider]/owner_type to the response with the 200 status

      response-required-property-added

    • added the required property items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/issuer to the response with the 200 status

      response-required-property-added

    • added the required property items/items/owner_type to the response with the 200 status

      response-required-property-added

    • added the required property pagination to the response with the 200 status

      response-required-property-added

    • added the optional property items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/scope_parameter to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/scope_separator to the response with the 200 status

      response-optional-property-added

    • added the optional property items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/token_response_access_token_pointer to the response with the 200 status

      response-optional-property-added