Login

Login
Logs in a user

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=9.1.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
}

401

Unauthorized

Operation doesn't return any data structure

Vendor Extension

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

                    [{"type":"Classic"},{"type":"Modern"}]
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