Session
Authenticate User
Authenticate user and obtain a JWT bearer token for subsequent API calls. This endpoint does not require authentication.
Request
URI
POST
https://{api_host}/provider/session
COPY
Request Body
Authenticate Request Body
AuthDTO
of type(s)
application/json
Required
{
"email": "string",
"password": "string"
}
string
email
Required
User email address
string
password
Required
User password
Responses
200
Successful authentication
Returns
UserSessionInfo
of type(s)
*/*
{
"email": "string",
"type": "string",
"roles": [
"string"
]
}
string
email
Optional
Email address of the authenticated user
string
type
Optional
Type of user authentication. Valid values are:
- TDM - Local TDM user
- LDAP - LDAP authenticated user
Possible values are :
TDM,
LDAP,
array of
string
roles
Optional
List of roles assigned to the user
Possible values are :
SYSTEM_ADMIN,
DSM_ADMIN,
DSM_USER,
Response Headers
string
Authorization
Bearer token for subsequent API calls
401
Authentication failure
Returns
string
of type(s)
application/json
"Authentication Failed - Bad credentials"
412
Account locked due to multiple failed login attempts
Returns
string
of type(s)
application/json
"Account is locked. Try after sometime or contact your administrator."Code Samples
COPY
curl -X POST -H 'Content-Type: application/json' -d '{"email:"string","password:"string"}' https://{api_host}/provider/session