Unkey · Example Payload

Unkey Identitiesgetidentity Example

API KeysRate LimitingAuthenticationDeveloper PlatformAccess ControlIdentityAnalytics

Unkey Identitiesgetidentity Example is an example object payload from Unkey, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "identities.getIdentity",
  "method": "POST",
  "path": "/v2/identities.getIdentity",
  "summary": "Get Identity",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "basic",
      "example": {
        "identity": "user_123"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "success",
      "example": {
        "data": {
          "externalId": "user_123",
          "id": "id_1234567890abcdef",
          "meta": {
            "email": "alice@example.com",
            "name": "Alice Smith",
            "plan": "premium"
          },
          "ratelimits": [
            {
              "duration": 60000,
              "limit": 1000,
              "name": "requests"
            }
          ]
        },
        "meta": {
          "requestId": "req_01H9TQPP77V5E48E9SH0BG0ZQX"
        }
      }
    },
    {
      "status": "403",
      "contentType": "application/json",
      "name": "missingPermission",
      "example": {
        "error": {
          "detail": "Your root key requires the 'identity.*.read_identity' permission to perform this operation",
          "status": 403,
          "title": "Forbidden",
          "type": "forbidden"
        },
        "meta": {
          "requestId": "req_0uVwX4yZaAbCdEfGhIjKl"
        }
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "name": "identityNotFound",
      "example": {
        "error": {
          "detail": "Identity with externalId \"user_abc123\" not found.",
          "status": 404,
          "title": "Not Found",
          "type": "not_found"
        },
        "meta": {
          "requestId": "req_2wXyZaAbCdEfGhIjKlMnOp"
        }
      }
    }
  ]
}