Sign in

v1

latestOpenAPI 3.0.42026-08-064075233.0 KB
Users

Get me

Returns information about the user that is currently logged in together with information of it's organization.

get/api/users/me

Response

OK

idstring uuid

Unique identifier for the user.

providerIdstring uuid nullable

Identifier for the provider the user belongs to.

providerTypestring nullable

Type of the provider the user belongs to. None or External.

userNamestring nullable

Username of the user.

emailstring nullable

Email address of the user.

fullNamestring nullable

Full name of the user.

twoFactorProviderstring nullable

Two factor provider used by the user. Can be None or External.

organizationIdstring uuid

Identifier for the organization the user belongs to.

lastLoggedInstring date-time

Date and time when the user last logged in.

createdAtstring date-time

Date and time when the user was created.

receiveEmailAlertsboolean

If the user should receive email alerts.

iiotboolean

If the user is an IIoT user.

ipaboolean

If the user is an IPA user.

legalAgreementsstring[] nullable

Array of legal agreements the user has accepted.

uiPermissionsstring[] nullable

Array of UI permissions the user has.

Example response

{
  "id": "4100b683-bde7-40c8-bc9c-97c293913f7f",
  "providerId": "f1aba31e-5623-4f07-ae48-d576bc01a695",
  "providerType": "None",
  "userName": "john.doe",
  "email": "john.doe@example.com",
  "fullName": "John Doe",
  "twoFactorProvider": "None",
  "organizationId": "8b3d1b78-00c8-4b4a-8874-d5771048d750",
  "lastLoggedIn": "2024-09-25T09:33:38.013347Z",
  "createdAt": "2024-09-24T09:33:38.013347Z",
  "receiveEmailAlerts": true,
  "organization": {
    "id": "8b3d1b78-00c8-4b4a-8874-d5771048d750",
    "name": "My organization",
    "createdAt": "2024-09-23T09:33:38.013347Z",
    "lastLoggedIn": "2024-09-25T09:33:38.013347Z",
    "contactInformation": {
      "email": "john.doe@example.com\n            ",
      "phoneNumber": "+46 123 456 789",
      "country": "Sweden"
    },
    "subscription": {
      "organizationId": "8b3d1b78-00c8-4b4a-8874-d5771048d750",
      "type": "Commercial",
      "validFrom": "2024-09-23T09:33:38.013347Z",
      "validTo": "2025-09-23T09:33:38.013347Z",
      "maxNumberOfEdgenodes": -1,
      "dataLimitInBytes": -1
    },
    "alertEmailRecipients": [
      "john.doe@example.com"
    ],
    "docker": {
      "username": "a8a5ee33-1838-4f96-807c-8d44ce72b4d7",
      "password": "dc61ed73-0483-48d1-b92f-fb23a7888a19"
    }
  },
  "organizations": [
    {
      "id": "8b3d1b78-00c8-4b4a-8874-d5771048d750",
      "name": "My organization"
    }
  ],
  "legalAgreements": [
    "EulaV2"
  ],
  "uiPermissions": [
    "*"
  ]
}