User login (credentials)

  • 1 minute(s) read
Prev Next
Post
/identity/users/login

Authenticate the user in the DPS by using personal credentials (username and password).

Header parameters
X-Servitly-Tenant
stringRequired

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

Query parameters
apiKey
stringRequired

The API KEY identifying the client.

Example{{apiKey}}
Body parameters

The login credentials and optional device details.

Expand All
object

The payload message for login requests.

email
string

The user registration email address.

Example{{userEmail}}
password
string

The user private password.

Example{{userPassword}}
devices
Array of object (Device) | null
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.

Responses
200

Authentication succeeded.

object

The response message for login requests.

token
string

The JWT token to be used as bear token in the authenticated requets.

Example661fd29342541977c4002ec7...
tokenExpirationTimestamp
integer (int64)

The timestamp when the token will expire and must be refreshed.

Example1578438000000
refreshToken
string

The Refresh token to be used to obtain a new JWT token.

Examplecd2bd3a0-861d-4798-8fd6-2a2a99fb92e8
userId
string

The id of the authenticated user.

Example6616689a0de6d87b47cd6308
tenantId
string

The id of the target tenant.

Example661533a57bba156cf6e8d04b
401

Invalid credentials, user not authenticated.

object
message
string

The error response.

ExampleInvalid credentials
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error