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=37.1 
{
    "id": "urn:vcloud:session:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "site": {
        "name": "string",
        "id": "string"
    },
    "user": {
        "name": "string",
        "id": "string"
    },
    "org": {
        "name": "string",
        "id": "string"
    },
    "location": "string",
    "roles": [
        "string"
    ],
    "roleRefs": [
        {
            "name": "string",
            "id": "string"
        }
    ],
    "sessionIdleTimeoutMinutes": 0
}
string
id
Optional

ID of session

EntityReference
site
Optional

site

EntityReference
user
Optional

user

EntityReference
org
Optional

org

string
location
Optional

The accessible location this session is valid for

array of string
roles
Optional

User's roles for this session

array of EntityReference
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

Availability
Added in 33.0
On This Page
Sessions Operations
GET
Get Accessible Locations
GET
Get Current Session
GET
Get Current Sessions
GET
Get Session
GET
Get Token
POST
Login
DELETE
Logout
DELETE
Logout Current Session
POST
Provider Login