Acquire Token | VCF Operations API

Acquire Token

Acquire a token to perform REST API calls

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

Show optional properties

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

"{\n  \"username\" : \"Some-LDAP-User\",\n  \"authSource\" : \"Imported LDAP Server\",\n  \"password\" : \"Some-LDAP-User-Password\"\n}"

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.

Token-based-authorization

Responses

200

The token and expiry time of the token

Returns auth-token of type(s) application/json

"No Custom Example is Available"

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

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"password":"string","username":"string"}' https://{api_host}/suite-api/api/auth/token/acquire

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Errors

Auth Operations