API Guide

Session management
Topics:
• Start an OMIVV session
• End an OMIVV session
Start an OMIVV session
Description: Starts an OMIVV session for the given OMIVV IP. The OMIVV session is valid for 60 minutes. Only the admin user
is allowed to successfully log in as an API user.
The bearer token received from this API must be used for other APIs as a header parameter.
Command or URL: /Services/AuthenticationService/login
Method: POST
Request body:
{
"apiUserCredential" : {
"username":"{OMIV username (admin}",
"domain" : "",
"password" : "{OMIVV password}"
}
}
For more information about request body parameters, see Request body on page 36.
Parameters: None
vCenter Privileges required: None
HTTP response code:
Table 1. HTTP response codes
Code Description
200 OK
400 Invalid parameters
429 Too many requests
500 Internal Server error / timeout
503 Client limit exhausted.
For OMIVV-Specific error codes, see OMIVV-Specific error codes on page 47.
Example Response:
{
"accessToken": "{token ID}",
"tokenType": "{token type}",
"expiresAt": "{token expire date and time}"
}
For more information, see Response body on page 39.
3
Session management 9