Login

Description

Logs the user in to CloudShell, authenticates the user’s credentials and domain, and returns an authorization token to be used with all subsequent requests. Requests that contain this token return information relevant for the specified domain, per the user's permissions.

URL

http://{CloudShell Sandbox API Gateway IP address}:{port#}/api/login

HTTP method

PUT

Request

Headers

Example header format for the login method:

Content-Type: application/json

Request body

The user credentials (in JSON format). The parameters of the login method include:

Parameter	Description
username	The user's name. (string)
password	The user's password. (string)
domain	The user's domain. (string)

Request example

Example request input for the login method in JSON format:

{
   "username":"admin",
   "password":"admin",
   "domain":"Global"
}

Response

Response example

The following is a sample authorization token returned by the login method:

"a0IAmINiGUmVsoJS9IeG1A=="

Response summary

The login method returns an authorization token that must be added to the header of each API method.