Skip to main content
Version: 2023.3

New Job Scheduling API Login

Description

Both the new CloudShell Job Scheduling Portal and the API use token-based authentication. When a user logs in, an access token is generated for the user's session together with a refresh-token that can be used to create new access tokens in case the access token expires, providing you with maximum control over access to the system by 3rd party applications and users.

note

The New Job Scheduling does not include the Global domain. This means two things:

  • There is no central location for reviewing activity from all domains in the Job Scheduling Portal.
  • Users associated only with the Global domain cannot access the Job Scheduling Portal or API.

URL

http://{Job Scheduling API IP}:{port#}/api/Account/login

HTTP method

POST

Request

Headers

Example header format:

Content-Type: application/json

Request body
ParameterDescription/Comments
usernameCloudShell admin username. (string)
passwordCloudShell admin password. (string)
Request example
{
"username": "string",
"password": "string"
}

Response

Response example
{
"accessToken": "oHk5r-5R-lYlB7ekIjdk6FVKHs7GXwIdZxU6s7M9Rdo",
"refreshToken": "rXd4YhgsW0GdoYuim6k-TeZPugPAOr5uN-kWjGMPNzo",
"tokenType": "Bearer",
"expiresIn": 18000
}
Response summary
ParameterDescription/Comments
accessTokenToken for authorizing REST API calls. (guid)
refreshtokenToken for refreshing expires accessToken. (guid)
tokenTypeToken type. (string)
expiresInValidity period in seconds. (Numeric)