Get logged-in user details

Prev Next
Get
/identity/users/me

Retrieve the details of the logged-in user

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Responses
200

Successful operation.

Expand All
object

The bean providing user details.

id
string

The user object identifier.

email
string

The user registration email address.

firstName
string

The user first name.

lastName
string

The user last name.

devices
Array of object (Device)

The list of devices used by the user to access the application REST API.

object

The bean providing device details.

deviceId
string

The unique identifier which is used to match the device among different logins.

os
string

The device operating system.

ExampleAndroid_9, iSO_11
model
string

The mobile device model.

ExampleONEPLUS A6013
platform
string

The mobile platform name.

Valid values[ "Android", "iOS" ]
notificationDeviceId
string

The device notification identifier obtained from the platform provider during the device registration for notifications.

userTypeName
string

The name of the user type associated with the user.

organizationId
string

The organization identifier the user belong to (required only for creation).

partnerId
string

The partner identifier the user belong to (required only for creation).

customerId
string

The customer identifier the user belong to (required only for creation).

locationId
string

The location identifier the user belong to (required only for creation).

timezone
string

The timezone used for date/times localization (e.g. Europe/Rome).

language
string

The language used for page localization (e.g. EN, ES).

termsOfServiceAcceptedTimestamp
integer (int64)

The last timestamp the user has accepted the terms of service.

privacyPolicyAcceptedTimestamp
integer (int64)

The last timestamp the user has accepted the privacy policy.

firstAccessTimestamp
integer (int64)

The timestamp the user has accessed the application the first time.

lastAccessTimestamp
integer (int64)

The timestamp the user has accessed the application the last time.

hostCustomers
Array of object (HostCustomer)

The list of customers where the user has been invited has external user.

object
customerId
string

The customer identifier the user has been invited to.

userType
object

The user-type object associated to this invited user.

id
string

The user-type object identifier.

name
string
category
string

The category this user type belongs to, one of ORGANIZATION, CUSTOMER, PARTNER.

rank
integer

The rank of the user type used to prevent unauthorized user reads or updates.

commandPayloadDuration
integer

The duration in milliseconds a command-payload is valid after its creation.

permissions
Array of string

The list of permissions associated with this user type.

string
status
string

The status of the invitation.

Valid values[ "PENDING_ACTIVATION", "ACTIVE" ]
creationTimestamp
integer (int64)

The timestamp at which the object was created.

alertActivatedInformationalEmailEnabled
boolean

The flag indicating whether an email must be sent on informational alert activation.

alertClearedInformationalEmailEnabled
boolean

The flag indicating whether an email must be sent on informational alert clearing.

alertActivatedWarningEmailEnabled
boolean

The flag indicating whether an email must be sent on warning alert activation.

alertClearedWarningEmailEnabled
boolean

The flag indicating whether an email must be sent on warning alert clearing.

alertActivatedFailureEmailEnabled
boolean Deprecated

The flag indicating whether an email must be sent on failure alert activation.

alertClearedFailureEmailEnabled
boolean Deprecated

The flag indicating whether an email must be sent on failure alert clearing.

alertActivatedCriticalEmailEnabled
boolean

The flag indicating whether an email must be sent on critical alert activation.

alertClearedCriticalEmailEnabled
boolean

The flag indicating whether an email must be sent on critical alert clearing.

alertActivatedEmergencyEmailEnabled
boolean

The flag indicating whether an email must be sent on emergency alert activation.

alertClearedEmergencyEmailEnabled
boolean

The flag indicating whether an email must be sent on emergency alert clearing.

alertActivatedInformationalSmsEnabled
boolean

The flag indicating whether an SMS must be sent on informational alert activation.

alertClearedInformationalSmsEnabled
boolean

The flag indicating whether an SMS must be sent on informational alert clearing.

alertActivatedWarningSmsEnabled
boolean

The flag indicating whether an SMS must be sent on warning alert activation.

alertClearedWarningSmsEnabled
boolean

The flag indicating whether an SMS must be sent on warning alert clearing.

alertActivatedFailureSmsEnabled
boolean Deprecated

The flag indicating whether an SMS must be sent on failure alert activation.

alertClearedFailureSmsEnabled
boolean Deprecated

The flag indicating whether an SMS must be sent on failure alert clearing.

alertActivatedCriticalSmsEnabled
boolean

The flag indicating whether an SMS must be sent on critical alert activation.

alertClearedCriticalSmsEnabled
boolean

The flag indicating whether an SMS must be sent on critical alert clearing.

alertActivatedEmergencySmsEnabled
boolean

The flag indicating whether an SMS must be sent on emergency alert activation.

alertClearedEmergencySmsEnabled
boolean

The flag indicating whether an SMS must be sent on emergency alert clearing.

alertActivatedInformationalPushEnabled
boolean

The flag indicating whether an push notification must be sent on informational alert activation.

alertClearedInformationalPVoicenabled
boolean

The flag indicating whether an push notification must be sent on informational alert clearing.

alertActivatedWarningPushEnabled
boolean

The flag indicating whether an push notification must be sent on warning alert activation.

alertClearedWarningPushEnabled
boolean

The flag indicating whether an push notification must be sent on warning alert clearing.

alertActivatedFailurePushEnabled
boolean Deprecated

The flag indicating whether an push notification must be sent on failure alert activation.

alertClearedFailurePushEnabled
boolean Deprecated

The flag indicating whether an push notification must be sent on failure alert clearing.

alertActivatedCriticalPushEnabled
boolean

The flag indicating whether an push notification must be sent on critical alert activation.

alertClearedCriticalPushEnabled
boolean

The flag indicating whether an push notification must be sent on critical alert clearing.

alertActivatedEmergencyPushEnabled
boolean

The flag indicating whether an push notification must be sent on emergency alert activation.

alertClearedEmergencyPushEnabled
boolean

The flag indicating whether an phone call must be made on emergency alert clearing.

alertActivatedInformationalVoiceEnabled
boolean

The flag indicating whether an phone call must be made on informational alert activation.

alertClearedInformationalVoiceEnabled
boolean

The flag indicating whether an phone call must be made on informational alert clearing.

alertActivatedWarningVoiceEnabled
boolean

The flag indicating whether an phone call must be made on warning alert activation.

alertClearedWarningVoiceEnabled
boolean

The flag indicating whether an phone call must be made on warning alert clearing.

alertActivatedFailureVoiceEnabled
boolean Deprecated

The flag indicating whether an phone call must be made on failure alert activation.

alertClearedFailureVoiceEnabled
boolean Deprecated

The flag indicating whether an phone call must be made on failure alert clearing.

alertActivatedCriticalVoiceEnabled
boolean

The flag indicating whether an phone call must be made on critical alert activation.

alertClearedCriticalVoiceEnabled
boolean

The flag indicating whether an phone call must be made on critical alert clearing.

alertActivatedEmergencyVoiceEnabled
boolean

The flag indicating whether an phone call must be made on emergency alert activation.

401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized