[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Login

Description

Logs in a user

Request

Request

URL

URL


post
https://{api_host}/cloudapi/1.0.0/sessions
Copy

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns Session of type(s) application/json;version=36.3
{
	"id": "urn:vcloud:session:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
	"location": "string",
	"org": {
		"id": "string",
		"name": "string"
	},
	"roleRefs": [
		{
			"id": "string",
			"name": "string"
		}
	],
	"roles": [
		"string"
	],
	"sessionIdleTimeoutMinutes": 0,
	"user": {
		"id": "string",
		"name": "string"
	}
}
string
id Optional

ID of session


string
location Optional

The accessible location this session is valid for


org Optional

Organization user is logged into for this session


array of EntityReference
roleRefs Optional

References to user’s roles


array of string
roles Optional

User’s roles for this session


integer
sessionIdleTimeoutMinutes Optional

The session idle timeout in minutes


user Optional

User of this session

Errors

Errors

401

Unauthorized

Code Samples

Code Samples

cURL Command

curl -X POST https://{api_host}/cloudapi/1.0.0/sessions


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?