TRtryardent
v1-api-keys

List Api Keys

Changed on

List all API keys for the organization, active and revoked.

Requires 'api_keys.read' permission.

Returns: List of API keys (without secret keys)

get/v1/orgs/{org_id}/api-keys

Request

  • Base URL
    https://api.tryardent.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.tryardent.com/v1/orgs/{org_id}/api-keys
  • Auth
    none declared

Path parameters

org_idstring required

Response

Active keys first (newest first), then revoked keys.

idstring required

API key ID.

namestring required

Human-readable key name.

key_prefixstring required

First characters of the key; the secret itself is never returned.

scopesstring[] required

Permission scopes granted to the key.

expires_atstring nullable

When the key expires. Null when it does not expire.

revoked_atstring nullable

When the key was revoked. Null for active keys.

revoked_reasonstring nullable

Why the key was revoked: admin_revoked, member_removed, or unknown_legacy for keys revoked before the reason was recorded. Null for active keys.

revoked_byobject nullable

Who revoked the key: {email, full_name}. Null for active keys and for revocations with no attributable user.

created_atstring required

When the key was created.

last_used_atstring nullable

When the key last authenticated a request. Null when never used.

usersobject nullable

Who created the key: {email, full_name}.

Changes

  • 885763e37dfbRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status