Clerk · Example Payload

Clerk Backend Api Getapikeys 200

AuthenticationAuthorizationB2B SaaSCIAMIdentity ManagementMFAOAuthOpenID ConnectOrganizationsPasskeysSAMLSecuritySessionsSSOUser Management

Clerk Backend Api Getapikeys 200 is an example object payload from Clerk, with 7 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

apioperationmethodpathsummaryresponse_statusresponse

Example Payload

{
  "api": "clerk-backend-api",
  "operation": "getApiKeys",
  "method": "GET",
  "path": "/api_keys",
  "summary": "Get API Keys",
  "response_status": "200",
  "response": {
    "data": [
      {
        "object": "api_key",
        "id": "ak_3beecc9c60adb5f9b850e91a8ee1e992",
        "type": "api_key",
        "subject": "user_2xhFjEI5X2qWRvtV13BzSj8H6Dk",
        "name": "MY_SERVICE_API_KEY",
        "description": "This is my API Key",
        "claims": {
          "foo": "bar"
        },
        "scopes": [
          "read",
          "write"
        ],
        "revoked": false,
        "revocation_reason": "Revoked by user",
        "expired": false,
        "expiration": 1716883200,
        "created_by": "user_2xhFjEI5X2qWRvtV13BzSj8H6Dk",
        "last_used_at": 1716883200,
        "created_at": 1716883200,
        "updated_at": 1716883200
      }
    ],
    "total_count": 0
  }
}