Getting the account information of the authenticated user¶
Sends a GET request to the endpoint /users/me.
Description¶
The Get-Logged-User request returns the account information of the currently authenticated user.
Requirements¶
Values of the request: none
Objects: none
Request¶
To request the account information of the currently authenticated user, no additional information is required in the path of the request.
As a result, the user gets an object UserVO with the requested information.
The object provides the following information:
| Attributes | Description | Values |
|---|---|---|
id |
The ID of the user. | string |
name |
The full name of the user. | string |
email |
The email address of the user. | string |
activeOrganisation |
The organisation context in which the token is used. | object |
Example¶
Example response:
{
"id": "xY9pQ5wR1",
"name": "Max Mustermann",
"email": "max@mustermann.de",
"activeOrganisation": {
"id": "xY9pQ5wR1",
"name": "Test Organisation"
}
}
Responses¶
The following responses are available:
| STATUS CODE | DESCRIPTION |
|---|---|
| 200 | The request has succeeded. |
| 401 | The request has not succeeded because the user authentication was incorrect. |