Acquire Token Using POST

Acquire Token Using POST

Performing a POST /api/auth/token/acquire would yield a response object that includes token and its validity. HTTP Status 401 will be sent back if the authentication operation has failed.
NOTE: The validity of the acquired token is extended after each call and is set to 6 hours from the last call.

Request
URI
POST
https://{api_host}/suite-api/api/auth/token/acquire
COPY
Request Body

The UsernamePassword object that encapsulates username, password and optionally the name of an Auth Source as specified by the user

username-password of type(s) application/json
Required 
{
    "authSource": "string",
    "password": "string",
    "username": "string"
}
string
authSource
Optional

The auth source name

string
password
Required

The password

string
username
Required

The username

Authentication
This operation uses the following authentication methods.
Responses
200

The token and expiry time of the token

Returns auth-token of type(s) application/json 
{
    "expiresAt": "string",
    "roles": [
        "string"
    ],
    "token": "string",
    "validity": 0
}
string
expiresAt
Optional

Token expiration time, in easy to read string representation (since Jan 1, 1970)

array of string
roles
Optional

List of roles the current user has

string
token
Required

Auth token for accessing future rest API(s)

integer As int64 As int64
validity
Required

Token expiration time in milliseconds (since Jan 1, 1970)


401

Authentication failed

Operation doesn't return any data structure

On This Page
Auth Operations
POST
Acquire Token Using POST
POST
Add Auth Source Using POST
POST
Add Role Privileges Using POST
PUT
Assign Role Permission To User Group Using PUT
PUT
Assign Role Permission To User Using PUT
PUT
Assign Traversal Spec To User Group Using PUT
PUT
Assign Traversal Spec To User Using PUT
PUT
Change Password Using PUT
POST
Create Scope Using POST
POST
Create User Group Using POST
POST
Create User Role Using POST
POST
Create User Using POST
DELETE
Delete Auth Source Using DELETE
DELETE
Delete Scopes Using DELETE
DELETE
Delete User Groups Using DELETE
DELETE
Delete User Group Using DELETE
DELETE
Delete User Role Using DELETE
DELETE
Delete Users Using DELETE
DELETE
Delete User Using DELETE
GET
Get All Object Scopes Using GET
GET
Get Assigned Role Permissions For Current User Using GET
GET
Get Assigned Role Permissions For User Group Using GET
GET
Get Assigned Role Permissions For User Using GET
GET
Get Auth Sources Using GET
GET
Get Auth Source Types Using GET
GET
Get Auth Source Type Using GET
GET
Get Auth Source Using GET
GET
Get Available Privilege Groups Using GET
GET
Get Available Privileges Using GET
GET
Get Current User Role Privileges Using GET
GET
Get Current User Using GET
GET
Get Role By Name Using GET
GET
Get Role Privileges Using GET
GET
Get Roles Using GET
GET
Get Scope Using GET
GET
Get Traversal Specs Using GET
GET
Get User Groups Using GET
GET
Get User Group Using GET
GET
Get Users Using GET
GET
Get User Using GET
POST
Import Users Using POST
PUT
Modify Scope Using PUT
PUT
Modify User Group Using PUT
PUT
Modify User Using PUT
PATCH
Patch Auth Source With Certificate Details Using PATCH
PATCH
Patch Test Auth Source Using PATCH
POST
Release Token Using POST
DELETE
Remove Role Privileges Using DELETE
POST
Search User Groups For Auth Source Using POST
POST
Search Users For Auth Source Using POST
PUT
Set Role Privileges Using PUT
PUT
Synchronize User Groups Using PUT
POST
Test Auth Source Using POST
DELETE
Unassigned Role Permission From User Group Using DELETE
DELETE
Unassigned Role Permission From User Using DELETE
PUT
Update Auth Source Using PUT
PUT
Update User Role Using PUT