Login Enterprise Login

Login Enterprise Login

Authenticates an enterprise or partner (MSP) user and, upon successful login, returns a velocloud.session cookie. Pass this session cookie in the authentication header in subsequent VCO calls. If you are using an HTTP client (e.g. Postman) that is configured to automatically follow HTTP redirects, a successful authentication request will cause your client to follow an HTTP 302 redirect to the portal 'Home' web page. Your session cookie can then be used to make VCO API calls. Note that session cookies expire after a period of time specified in the VCO configuration (default is 24 hours).

Request
URI
POST
https://{api_host}/portal/rest/login/enterpriseLogin
COPY
Request Body
auth_object of type(s) application/json
Optional

Show optional properties

{
    "password": "string",
    "username": "string"
}
{
    "email": "string",
    "password": "string",
    "password2": "string",
    "username": "string"
}
Responses
200

If you are using an HTTP client that is configured to automatically follow HTTP redirects (e.g. Postman), a successful authentication request will cause your client to follow an HTTP 302 redirect to the portal 'Home' web page. Your session cookie may then be used to make API calls.

Operation doesn't return any data structure

302

An HTTP 302 response is returned on both successful and failed authentication attempts. If the response includes a Set-Cookie header specifying a non-empty velocloud.session cookie, authentication was successful and this cookie may be used to make API calls.

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"username:"string","password:"string"}' https://{api_host}/portal/rest/login/enterpriseLogin