Developing

You need to authenticate with a user name and password for running the REST operations. Additionally, role-based authorization is required for authenticating into the product and running various operations.

To be able to authenticate, you need to generate the authorization token by running a POST call with the following request URL. You also need to provide the user name and password in the request body (in JSON format).

In the preceding URL, the following definitions apply:

• <protocol> refers to the protocol that you want to use for communication with the Console Server.
  

  The value can be one of the following:

  • http
  • https
• <host> refers to the host name of the Console Server.
• <Port> refers to the port number of the Console Server. Default port is 9797.

Output

The response is an authorization token. By default, this token is valid for a period of 60 minutes. After the default period expires, the token cannot be used, you need to generate a new token.

Required headers while running the supported APIs

• Authorization
  Pass the authorization token as the value.

• Content-Type:  application/json


Example

POST

{
    "username": "admin",
    "password": "admin12345"
}

{
    "username": "admin",
    "authToken": "6AkjnOzw9hH8/t5hUAIn7b0rbNI="
}

You can log out and terminate a user session by sending a POST request. You also need to provide the authorization token in the request body (in JSON format).

After you log out from a given session, the authorization token generated earlier does not remain valid. Attempts to reuse the earlier generated token generates an error.

In the preceding URL, the following definitions apply:

• <protocol> refers to the protocol that you want to use for communication with the Console Server.
  

  The value can be one of the following:

  • http
  • https
• <host> refers to the host name of the Console Server.
• <Port> refers to the port number of the Console Server. Default port is 9797.

Required headers

• Authorization
  Pass the authorization token as the value. For more information, see Authentication and authorization.

• Content-Type:  application/json


Example

POST

{
    "Authorization": "7dNJZSao3zZKjuZ5/o1Z8Ji570Q="
}

{
    "status": "SUCCESS"
}