Login

Login

This request creates a new Manager service session. The supported authentication methods are the following:

  • with SSO credentials 
      {
    "type": "ssoCredentials",
    "username": "ssoUser",
    "password": "ssoPass",
    "principal" : null
  }


  • with SSO SAML token

    {
    "type": "ssoToken",
    "samlToken": "<saml2:Assertion xmlns:saml2=...>...</saml2:Assertion>",
    "timestamp": 1465194049081,
    "nonce": "jF845646gJzx734",
    "signature": "c2FtcGxlU2lnbmF0dXJlCg==",
    "principal" : null
}


  • OS root credentials:

    {
    "type": "localUser",
    "localUser": "root",
    "localPassword": "password"
}
Request
URI
POST
https://{api_host}/sessions
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body 
{
    "type": "ssoCredentials",
    "username": "[email protected]",
    "password": "mypassword"
}
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns SessionDetails of type(s) application/json;charset=UTF-8 
{
    "roles": [
        "EVERYONE"
    ],
    "user": "[email protected]"
}
array of string
roles
Optional

Roles granted to the session

string
user
Optional

The currently authenticated user


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.7+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Session Operations
GET
Get Session
POST
Login
DELETE
Logout