Find API keys by owner or status

info

Ory Talos Secure API Keys on Ory Network is in preview. The HTTP API is versioned v2alpha1, and request and response shapes can change. Pin the version of the Ory SDK that you use.

Find the API keys in Ory Talos Secure API Keys that belong to one actor, for example to review or revoke them.

Before you begin

• To manage keys in the Ory Console, you need the Owner or Developer role in the project. Members with the Viewer role can't view keys or send requests from the Playground.
• If an API key page in the Ory Console shows Enable Ory Talos, select Enable API keys. The change takes a short time to apply. See Eventual consistency.

To call the API, you need your project slug and a project API key.

A project API key is required for all administrative operations. To create one, read Creating API Keys.

The quickstart shows where to find the project slug and how to set up the TypeScript and Go SDKs. The examples on this page read both values from environment variables:

export PROJECT_SLUG=<your-project-slug>
export ORY_API_KEY=<your-project-api-key>

Find keys by owner or status

Ory Console

1. Go to API Keys → Keys in the Ory Console.
2. Enter the actor ID in Filter by exact actor ID… and select Apply.
3. Optionally, narrow the list by status with the Filters list. It works only together with an actor filter.

To show all keys again, select Clear filters. The API Keys → Imported in the Ory Console page has no filters.

curl

Call GET /v2alpha1/admin/issuedApiKeys, or GET /v2alpha1/admin/importedApiKeys for imported keys, with the filter query parameter:

Filter	Returns
actor_id="user:alice"	All keys of the actor.
actor_id="user:alice" AND status=KEY_STATUS_ACTIVE	The active keys of the actor.
actor_id="user:alice" AND status=KEY_STATUS_REVOKED	The revoked keys of the actor.

• You can filter on actor_id, status, or both. Join two conditions with AND. Other fields are rejected.
• Put the actor_id value in double quotes.
• A status condition works only together with an actor_id condition. A filter with only status returns HTTP 400.

Each response returns up to page_size keys: 50 by default, and at most 1,000. If next_page_token in the response isn't empty, send it as page_token to get the next page.

Expired keys keep the active status, so a filter for active keys also returns them. To tell them apart, compare the expiry with the current time: the Expires column in the Ory Console, or expire_time in the API.