Who this credential is, and what it may do
GET
/api/auth/me
const url = 'https://app.dycrypt.com/o/acme/api/auth/me';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://app.dycrypt.com/o/acme/api/auth/me \ --header 'Authorization: Bearer <token>'Open to tokens as well as people — letting a credential ask what it is reveals nothing the caller did not already hold. The usual way for an integration to check its token at startup.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”The caller.
Media typeapplication/json
Who a credential is. Open to tokens — it reveals nothing the caller did not already hold.
object
username
A token appears as token/<name>.
string
displayName
string
role
string
platform
True for a control-plane account
boolean
platformRole
Present only for a control-plane account. Advisory — every refusal is the server’s.
string
version
string
organization
object
slug
string
name
string
tenant
The organisation this request resolved to.
string | null
Examplegenerated
{ "username": "example", "displayName": "example", "role": "example", "platform": true, "platformRole": "example", "version": "example", "organization": { "slug": "example", "name": "example" }, "tenant": "example"}No credential, or one that no longer resolves — revoked, expired, deleted. Replace it.
Media typeapplication/json
Every failure in this API has this shape and no other.
object
error
required
string
Example
{ "error": "this token does not have licenses:write"}