Login | VMware Cloud Director Availability API

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

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 VMware Cloud Director credentials

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

with VMware Cloud Director auth cookie:

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

with VMware Cloud Director access token (jwt):

{
    "type": "vcdAccessToken",
    "vcdAccessToken": "eyJhbGciOiJSUzI1NiJ9...."
}

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.

VMware_Cloud_Director_Availability_vApp_Replication_Manager_cookie

Responses

200

Returns C4SessionDetails of type(s) application/json;charset=UTF-8

{
    "authenticatedSites": [
        {
            "org": "Org1",
            "site": "site1"
        }
    ],
    "roles": [
        "EVERYONE"
    ],
    "user": "admin1@Org1"
}

array of AuthenticatedSiteDetails

authenticatedSites

Optional

VMware Cloud 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

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

NotAuthenticated

Returns ApiError of type(s) application/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/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.