keys

Retrieve a list of API keys

Returns a list of all API keys the user has access to

get/keys

Request

  • Base URL
    https://api.didomi.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.didomi.io/keys
  • Auth
    HTTP bearer

Query parameters

$limitinteger

Number of results to return

$skipinteger

Number of results to skip

$sortobject

Property to sort results

idstring

Unique ID of the API key

namestring

Name of the API key to help identify it. This could be the name of the app or team that will be using it, or a short description of what the key will be used for

descriptionstring

Description of the API key

organization_idstring

ID of the organization that owns the API key

created_atstring

Creation date of the API key (ISO8601)

enabledboolean

Status of the API key. A disabled API key cannot be used for obtaining a token. Already issued tokens remain valid until their expiration.

is_internalboolean

Marks an API key as internal. These keys are managed by Didomi. Internal keys are excluded from list results unless explicitly requested.

Query parameters to filter

Response

A list of APIKey objects

idstring

Unique ID of the API key

namestring

Name of the API key to help identify it. This could be the name of the app or team that will be using it, or a short description of what the key will be used for

descriptionstring

Description of the API key

organization_idstring

ID of the organization that owns the API key

created_atstring

Creation date of the API key (ISO8601)

enabledboolean

Status of the API key. A disabled API key cannot be used for obtaining a token. Already issued tokens remain valid until their expiration.

is_internalboolean

Marks an API key as internal. These keys are managed by Didomi. Internal keys are excluded from list results unless explicitly requested.

Changes

No recorded changes to this operation across all 10 revisions of this API.