Login User

Login User

Note: UPN(e.g. [email protected]) based login is not supported.

Request
URI
POST
https://{api_host}/rest/login
COPY
Query Parameters
string
client_reference_id
Optional

Client reference identifier present in the response of key-agreement api.

Header Parameters
string
Accept-Language
Optional

Header to support localization.

Possible values are : de, en, es, fr, ja, ko, zh-CN, zh-TW,
Request Body
AuthLogin of type(s) application/json
Required 
{
    "domain": "AD-TEST-DOMAIN",
    "password": [
        "<password>"
    ],
    "username": "Administrator"
}
string
domain
Required

Domain

array of string
password
Required

User password

string
username
Required

User Name

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AuthTokens of type(s) */* 
{
    "access_token": "<jwt.access.token>",
    "refresh_token": "<jwt.refresh.token>"
}
string
access_token
Required

Access Token to be used in API calls.

string
refresh_token
Required

Refresh Token to be used to get a new Access token.


400

Bad Request

Operation doesn't return any data structure

401

User is not authenticated

Operation doesn't return any data structure

404

Not Found

Operation doesn't return any data structure

On This Page
Auth Operations
GET
Authenticate Smart Card
POST
Key Agreement
POST
Login User
POST
Logout User
POST
Refresh Access Token