Get identity
Returns the caller's identity as a whoami response. The response
shape depends on the API key type used — inspect the object field
to distinguish the two key resources.
OrgKey resource — returned when authenticated with an org API key. Contains the key's metadata, permissions, and org context.
PersonalKey resource — returned when authenticated with a personal
API key. Contains the key's metadata, permissions, and org scope
(all or selected).
Inspect the object field to determine which resource was returned:
// Org key → OrgKey resource
{ "object": "org_key", "id": "okey_...", "name": "CI/CD", "permissions": [...], ... }
// Personal key → PersonalKey resource
{ "object": "personal_key", "id": "pkey_...", "name": "Dev PAT", "org_scope": "all", ... }
Note: The 200 response schema documents the OrgKey resource only. Personal keys are a private surface — see the Private spec for the PersonalKey resource shape.
Permissions
| Key type | Accepted | Permission required | Notes |
|---|---|---|---|
| Org API key | yes | — | Returns an OrgKey resource scoped to the key's org |
| Personal API key | yes | — | Returns a PersonalKey resource; X-Org-ID is not required for this endpoint |
Responses
- application/json
- application/json
- application/json
Request Example for get/me
curl https://api.nametrust.com/me
{
"object": "org_key",
"revoked_by": {
"object": "user",
"last_login_at": "2025-06-15T09:30:00Z",
"last_active_at": "2025-06-15T09:30:00Z",
"id": "user_01h455vb4pex5vsknk084sn02q",
"email": "jane@acme.com",
"first_name": "Jane",
"last_name": "Doe",
"avatar_url": "https://example.com/avatar.jpg",
"mfa_enabled": true,
"created_at": "2025-06-01T12:00:00Z",
"updated_at": "2025-06-15T09:30:00Z"
},
"expires_at": "string",
"last_used_at": "string",
"revoked_at": "string",
"created_at": "string",
"updated_at": "string",
"id": "okey_01h455vb4pex5vsknk084sn02q",
"name": "CI/CD Pipeline",
"prefix": "nt_org_Bx4f",
"permissions": [
"string"
],
"ip_allowlist": [
"string"
],
"status": "active",
"creator": {
"object": "user",
"last_login_at": "2025-06-15T09:30:00Z",
"last_active_at": "2025-06-15T09:30:00Z",
"id": "user_01h455vb4pex5vsknk084sn02q",
"email": "jane@acme.com",
"first_name": "Jane",
"last_name": "Doe",
"avatar_url": "https://example.com/avatar.jpg",
"mfa_enabled": true,
"created_at": "2025-06-01T12:00:00Z",
"updated_at": "2025-06-15T09:30:00Z"
},
"updated_by": {
"object": "user",
"last_login_at": "2025-06-15T09:30:00Z",
"last_active_at": "2025-06-15T09:30:00Z",
"id": "user_01h455vb4pex5vsknk084sn02q",
"email": "jane@acme.com",
"first_name": "Jane",
"last_name": "Doe",
"avatar_url": "https://example.com/avatar.jpg",
"mfa_enabled": true,
"created_at": "2025-06-01T12:00:00Z",
"updated_at": "2025-06-15T09:30:00Z"
}
}