The signed-in user

GET

/me

curl --request GET \
  --url https://example.com/api/v1/me \
  --cookie __Host-shardkeep_session=<__Host-shardkeep_session>

Authorizations

• sessionCookie
• bearerToken

Responses

200

The signed-in user.

Media typeapplication/json

object

id

required

string format: uuid

username

required

string

email

required

string

displayName

required

string

globalAdmin

required

boolean

passwordChangeRequired

required

While true, only GET /me, POST /me/password and POST /auth/logout work.

boolean

createdAt

required

string format: date-time

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "username": "example",
  "email": "example",
  "displayName": "example",
  "globalAdmin": true,
  "passwordChangeRequired": true,
  "createdAt": "2026-04-15T12:00:00Z"
}

401

Not signed in, or the credentials are invalid.

Media typeapplication/problem+json

An RFC 9457 problem with a machine-readable code.

object

type

required

string

title

required

string

status

required

integer

detail

string

code

required

Stable machine-readable error code.

string

Example

{
  "type": "about:blank",
  "title": "Conflict",
  "status": 409,
  "code": "conflict"
}