User login (PAT)

Prev Next
Post
/identity/users/patLogin

Authenticate the user in the DPS by using a PAT (Personal Access Token).

Header parameters
X-Servitly-Tenant
stringRequired

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

Body parameters

The login PAT and API Key.

object

The payload message for login requests based on PAT.

apiKey
string

The API KEY identifying the client.

Example{{apiKey}}
pat
string

The PAT used for login.

Example{{userPat}}
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