Login

Login

Creates a new C4 session. The supported authentication methods are:

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


  • with SSO SAML token

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


  • with vCloud Director credentials

    {
    "type": "vcdCredentials",
    "vcdUser": "admin1@org2",
    "vcdPassword": "password"
}


  • with vCloud Director auth cookie:

    {
    "type": "vcdCookie",
    "vcdCookie": "f12977876fef48a6b032ffdb2cdf22d7"
}


  • 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

request

AuthenticationRequest of type(s) application/json
Required 
{
    "type": "string"
}
string
type
Required

type

Possible values are : ssoToken, ssoCredentials, localUser, vcdCookie, vcdCredentials,
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns C4SessionDetails of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "authenticatedSites": [
        {
            "org": "Org1",
            "site": "site1"
        }
    ],
    "roles": [
        "EVERYONE"
    ],
    "user": "admin1@Org1"
}
array of AuthenticatedSiteDetails
authenticatedSites
Optional

vCloud Director sites the current session has authenticated with. The site specified in the request should be present here

array of string
roles
Optional

Roles granted to the session

string
user
Optional

The currently authenticated user


401

Returned error codes include (but are not limited to):

  • NotAuthenticated
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
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

Returned error codes include (but are not limited to):

  • GeneralServerFailure
Returns ApiError of type(s) application/vnd.vmware.h4-v3.5+json;charset=UTF-8 
{
    "args": [
        "string"
    ],
    "code": "string",
    "msg": "string",
    "stacktrace": "string"
}
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
POST
Extend
GET
Get Session
POST
Login
DELETE
Logout
DELETE
Shrink