Me

Get the current user's access state

get

/api/me

Called by the back-office right after sign-in. Saves language as the user's language when none is stored yet, and sends a welcome e-mail the first time a user with no tenant role calls it, whether or not their address is verified. Global administrators do not get the welcome e-mail.

Query parameters

languagestringOptional

Language the back-office is currently displayed in. Stored when the user has no language yet and it is one of the back-office languages.

Responses

200

Access state returned.

Access state of the signed-in back-office user.

hasTenantsbooleanOptional

Whether the user holds a role on at least one tenant. False for a self-registered user nobody has invited yet, and for a global administrator with no tenant role of their own.

emailVerifiedbooleanOptional

Whether the user's e-mail address is verified, including a verification done since sign-in.

languagestring · nullableOptional

The user's back-office language code, e.g. fr, or null when none is stored.

401

The caller is not authenticated.

application/problem+json

get/api/me

GET /api/me HTTP/1.1
Host: app.neostore.cloud
Accept: */*

{
  "hasTenants": true,
  "emailVerified": true,
  "language": null
}

Set the current user's language

put

/api/me/language

Replaces the stored language, which decides the language of the platform e-mails sent to the user.

Body

Request body to change the signed-in user's back-office language.

languagestring · min: 1Required

Language code, one of the back-office languages the platform e-mails are translated into, e.g. en or fr. Also the language of the e-mails the platform sends this user.

Responses

204

Language saved.

No content

400

The language is missing or not one of the back-office languages.

401

The caller is not authenticated.

application/problem+json

put/api/me/language

PUT /api/me/language HTTP/1.1
Host: app.neostore.cloud
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "language": "text"
}

No content