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}/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

Show optional properties

{
    "password": "string",
    "username": "string"
}

{
    "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.

vRealizeOpsToken

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

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

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

Deprecated

PUT

Assign Traversal Spec To User Using PUT

Deprecated

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