Skip to content
MouseMouse
Docs menu

auth

Identity of the caller

1 operation · 5 schemas

GET /v1/auth/me

Who am I

getMe · scope key:read

Returns the authenticated principal: the user plus how they authenticated (session or API key, and the key's scopes). List org memberships via GET /v1/orgs.

Responses

getMe responses
StatusDescriptionBody
200

The authenticated principal.

Me
401

Missing or invalid credentials.

Problemapplication/problem+json

Schemas (5)

The schemas these operations reach before any other tag’s do. A type that links elsewhere is rendered on that tag’s page.

Me

object

Me fields
FieldTypeDescription
userrequiredUserPublic
authrequiredAuthInfo

UserPublic

object

UserPublic fields
FieldTypeDescription
idrequiredId
usernamerequiredSlug
display_namestring | null

length ≤ 128

avatar_urlstring (uri) | null (uri)
created_atrequiredstring (date-time)

AuthInfo

object

AuthInfo fields
FieldTypeDescription
kindrequiredstring

one of session · api_key

How the caller authenticated.

key_idstring | null

API key id (key_...) when kind is api_key.

scopesrequiredarray of string

Effective scopes, hierarchical: write implies read, train implies write. Sessions carry all three.

Id

string

length ≤ 64

Prefixed ULID id, e.g. repo_01J8ZC9EXAMPLE0000000000EX.

Slug

string

length 1–64 · pattern ^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$

Lowercase URL-safe name: a-z 0-9 -, no leading/trailing dash.