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.
Path parameters
Zone ID
Query parameters
Cursor for forward pagination
Cursor for backward pagination
Maximum number of items to return
Filter by owner type: platform (Keycard-managed) or customer (org-created).
Backward-compatible alias for filter[identifier]: exact match on a single resource identifier.
Filter resources by credential provider ID
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
queryrequest parameterfilter[identifier]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[owner_type]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterfilter[traits]new-optional-request-parameter
- ○
added the non-success response with the status
404response-non-success-status-added
- ○
added the optional property
items/items/credential_provider/allOf[subschema #1: Provider]/metadata/icon_urlto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/items/credential_provider/allOf[subschema #1: Provider]/protocols/openid/external_id_claimto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
items/items/application/allOf[subschema #1: Application]/metadata/icon_urlto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/items/credential_provider/allOf[subschema #1: Provider]/protocols/openid/single_logout_enabledto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/items/metadata/allOf[iam_Metadata]/icon_urlto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
items/items/credential_provider/allOf[subschema #1: Provider]/protocols/openid/scopesto the response with the200statusresponse-optional-property-added
- ○
- ○
added the optional property
items/items/credential_lifetime_secondsto the response with the200statusresponse-optional-property-added
- ○
- ○
added the required property
items/items/prefixto the response with the200statusresponse-required-property-added
- ○
- ○
added the required property
items/items/application/allOf[subschema #1: Application]/consentto the response with the200statusresponse-required-property-added
- ○
- ○
added the optional property
items/items/credential_provider/allOf[subschema #1: Provider]/protocols/openid/user_identifier_claimto the response with the200statusresponse-optional-property-added
- ○
- ●
removed the optional property
items/items/application/allOf[subschema #1: Application]/traitsfrom the response with the200statusresponse-optional-property-removed
- ○
the endpoint scheme security
OAuth2was added to the APIapi-security-added
- ○
the endpoint scheme security
bearerAuthwas added to the APIapi-security-added
- ○
the endpoint scheme security
iam_bearerAuthwas removed from the APIapi-security-removed
This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
the
items/items/metadataresponse's property type/format changed fromobject/to/for status200response-property-type-changed
- ●
removed the optional property
items/items/metadata/docs_urlfrom the response with the200statusresponse-optional-property-removed
- ○
added the new optional
queryrequest parameterafternew-optional-request-parameter
- ○
added the new optional
queryrequest parameterbeforenew-optional-request-parameter
- ○
added the new optional
queryrequest parameterexpand[]new-optional-request-parameter
- ○
added the new optional
queryrequest parameterlimitnew-optional-request-parameter
- ○
added the optional property
items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/authorization_parametersto the response with the200statusresponse-optional-property-added
- ○
added
iam_Metadatato theitems/items/metadataresponse propertyallOflist for the response status200response-property-all-of-added
- ○
added the required property
items/items/application/allOf[subschema #1: Application]/owner_typeto the response with the200statusresponse-required-property-added
- ○
added the required property
items/items/application_typeto the response with the200statusresponse-required-property-added
- ○
added the required property
items/items/credential_provider/allOf[subschema #1: Provider]/owner_typeto the response with the200statusresponse-required-property-added
- ○
added the required property
items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/issuerto the response with the200statusresponse-required-property-added
- ○
added the required property
items/items/owner_typeto the response with the200statusresponse-required-property-added
- ○
added the required property
paginationto the response with the200statusresponse-required-property-added
- ▲
- ○
added the optional property
items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/scope_parameterto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/scope_separatorto the response with the200statusresponse-optional-property-added
- ○
added the optional property
items/items/credential_provider/allOf[subschema #1: Provider]/protocols/oauth2/token_response_access_token_pointerto the response with the200statusresponse-optional-property-added
- ○