SPA User

SPA Me - Get current user profile

Returns the profile of the currently authenticated user.

GET/api/spa/me

SPA Me - Get current user profile

curl --request GET \
  --url 'https://app.output.rocks/api/spa/me' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

{
  "id": 1,
  "email": "user@example.com",
  "roles": [
    "ROLE_USER",
    "ROLE_ADMIN"
  ],
  "locale": "en",
  "clientId": 1,
  "subClientId": null,
  "clientIdentifier": "my-client",
  "subClientDescription": null,
  "isSubClientsEnabled": true,
  "isDelegated": false,
  "delegationId": "f53f4d5f-3216-486f-b1f1-3fc2a8e46020",
  "actorEmail": "john.doe@output.rocks",
  "actorName": "John Doe",
  "effectiveEmail": "bayernwerk@output.rocks"
}

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Response

200application/json

SpaMe resource

integer

User ID

Example: 1

string

User email

Example: "user@example.com"

roles

string[]

User roles

Example: ["ROLE_USER","ROLE_ADMIN"]

locale

string

User locale

Example: "en"

clientId

integer

Client ID

Example: 1

subClientId

integer

Sub-client ID

Example: null

clientIdentifier

string

Client identifier

Example: "my-client"

subClientDescription

string

Sub-client identifier

Example: null

isSubClientsEnabled

boolean

Whether the sub-clients (environmental tenants) module is enabled for the client

Available options: truefalse

Example: true

isDelegated

boolean

Whether user is currently in a delegated auth session

Available options: truefalse

Example: false

delegationId

string

Delegated auth session ID

Example: "f53f4d5f-3216-486f-b1f1-3fc2a8e46020"

actorEmail

string

Delegating actor email when delegated session is active

Example: "john.doe@output.rocks"

actorName

string

Delegating actor name when delegated session is active

Example: "John Doe"

effectiveEmail

string

Effective user email used for authorization

Example: "bayernwerk@output.rocks"