Login

Login

Logs in a user

Request
URI
POST
https://{api_host}/cloudapi/1.0.0/sessions
COPY
Header Parameters
string
Authorization
Required

Authorization

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns Session of type(s) application/json;version=40.0 
{
    "id": "urn:vcloud:session:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "site": {
        "name": "string",
        "id": "string"
    },
    "user": {
        "name": "string",
        "id": "string"
    },
    "org": {
        "name": "string",
        "id": "string"
    },
    "operatingOrg": {
        "name": "string",
        "id": "string"
    },
    "location": "string",
    "roles": [
        "string"
    ],
    "roleRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "sessionIdleTimeoutMinutes": 0
}
string
id
Optional
Constraints: maxLength: 128

ID of session

object
site
Optional

Entity reference used to describe VCD entities

object
user
Optional

Entity reference used to describe VCD entities

object
org
Optional

Entity reference used to describe VCD entities

object
operatingOrg
Optional

Entity reference used to describe VCD entities

string
location
Optional

The accessible location this session is valid for

array of string
roles
Optional

User's roles for this session

array of object
roleRefs
Optional

References to user's roles

integer
sessionIdleTimeoutMinutes
Optional

The session idle timeout in minutes


401

Unauthorized

Operation doesn't return any data structure

Vendor Extension

This operation contains the following vendor extensions defined in the spec:

                    [object Object],[object Object]
Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/cloudapi/1.0.0/sessions
Availability
Added in 33.0
On This Page
Sessions Operations
GET
Get Current Sessions
POST
Login
GET
Get Session
DELETE
Logout
GET
Get Current Session
DELETE
Logout Current Session
GET
Get Current Session Rights