Skip to content
varsafe
Esc
↑↓navigate↵open⌘Jpreview

Get the current identity

Returns the user, their teams and the active team for the calling credential.

GET/me
Responses
200Success.
userobjectrequired
Show properties
idstringrequired
min length 1
emailstring<email>required
namestringrequired
min length 1 · max length 255
createdAtstringrequired
emailVerifiedboolean
hasPasswordboolean
twoFactorEnabledboolean
passkeyOnlyModeboolean
isPlatformAdminboolean
teamsobject[]required
Show properties
Array of object
idstring<uuid>required
namestringrequired
min length 1 · max length 255
rolestringrequired
Allowed:owneradmindeveloperoperatorviewerbilling
maxActiveSessionsnumberrequired
activeSessionCountnumberrequired
400The request failed validation. `field` names the offending input.
statusCodeintegerrequired
HTTP status code, repeated in the body.
min -9007199254740991 · max 9007199254740991
codestringrequired
Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.
messagestringrequired
Human-readable explanation. Wording may change.
fieldstring
The offending request field, present on validation failures.
401No credential was presented, or it is invalid or revoked.
statusCodeintegerrequired
HTTP status code, repeated in the body.
min -9007199254740991 · max 9007199254740991
codestringrequired
Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.
messagestringrequired
Human-readable explanation. Wording may change.
fieldstring
The offending request field, present on validation failures.
403The credential is valid but lacks the required scope, role or team access.
statusCodeintegerrequired
HTTP status code, repeated in the body.
min -9007199254740991 · max 9007199254740991
codestringrequired
Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.
messagestringrequired
Human-readable explanation. Wording may change.
fieldstring
The offending request field, present on validation failures.
404The resource does not exist, or is not visible to this credential.
statusCodeintegerrequired
HTTP status code, repeated in the body.
min -9007199254740991 · max 9007199254740991
codestringrequired
Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.
messagestringrequired
Human-readable explanation. Wording may change.
fieldstring
The offending request field, present on validation failures.
429Rate limited. Retry after the interval named in the response.
statusCodeintegerrequired
HTTP status code, repeated in the body.
min -9007199254740991 · max 9007199254740991
codestringrequired
Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.
messagestringrequired
Human-readable explanation. Wording may change.
fieldstring
The offending request field, present on validation failures.
500Unexpected server error. The body never carries internal detail.
statusCodeintegerrequired
HTTP status code, repeated in the body.
min -9007199254740991 · max 9007199254740991
codestringrequired
Stable machine-readable error code, e.g. `SECRET_NOT_FOUND` or `FORBIDDEN`. Branch on this, never on the message.
messagestringrequired
Human-readable explanation. Wording may change.
fieldstring
The offending request field, present on validation failures.
Request
curl -X GET "https://api.varsafe.dev/me"
Response
{
  "user": {
    "id": "string",
    "email": "<email>",
    "name": "string",
    "createdAt": "string",
    "emailVerified": true,
    "hasPassword": true,
    "twoFactorEnabled": true,
    "passkeyOnlyMode": true,
    "isPlatformAdmin": true
  },
  "teams": [
    {
      "id": "<uuid>",
      "name": "string",
      "role": "owner"
    }
  ],
  "maxActiveSessions": 0,
  "activeSessionCount": 0
}