login
Configuration for Login/Logout resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| ID | <String> | Read-write | ID of the User that wants to login in cloud. Maximum length = 128 |
| permission | <String> | Read-write | Actions that this user is authorized to perform. Minimum length = 1 Maximum length = 128 |
| session_timeout | <Integer> | Read-write | Session Timeout in seconds, if no activity is performed for specified time then session will be expired. |
| auth_with_remote_pubkey | <Integer> | Read-write | Login request to specify if SSH authentication took place with remote public keys for this user, 1 for remotely managed pubkey else 0. |
| username | <String> | Read-write | User Name that wants to login. Maximum length = 128 |
| password | <String> | Read-write | Password. Maximum length = 128 |
| challenge | <String> | Read-write | Challenge request for authentication. |
| challenge_response | <String> | Read-write | Challenge response for authentication. |
| client_ip | <String> | Read-write | Login client IP. |
| client_port | <Integer> | Read-write | Login Client port. Maximum value = |
| sessionid | <String> | Read-write | Session ID would only be set if login was performed successfully. |
| token | <String> | Read-write | Random token to identify session during logout. |
| Secret | <String> | Read-write | Secret. Maximum length = 128 |
Operations
(click to see Properties)
Some options that you can use for each operations:
Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".
Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER:<username>
X-NITRO-PASS:<password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Note:
Mandatory parameters are marked in red and placeholder content is marked in <green>.
add
URL: https://<MGMT-IP>/nitro/v1/config/login?onerror=<String_value>
HTTP Method: null
Request Payload:
{login: {
<b>"client_port":<Integer_value></b>,
"ID":<String_value>,
"session_timeout":<Integer_value>,
"auth_with_remote_pubkey":<Integer_value>,
"password":<String_value>,
"challenge_response":<String_value>,
"challenge":<String_value>,
"token":<String_value>,
"permission":<String_value>,
"username":<String_value>,
"client_ip":<String_value>,
"sessionid":<String_value>,
"Secret":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "login":[{
"ID":<String_value>,
"tenant_name":<String_value>,
"permission":<String_value>,
"session_timeout":<Integer_value>,
"challenge_token":<String_value>,
"auth_with_remote_pubkey":<Integer_value>,
"username":<String_value>,
"login_type":<String_value>,
"password":<String_value>,
"challenge":<String_value>,
"challenge_response":<String_value>,
"client_ip":<String_value>,
"client_port":<Integer_value>,
"cert_verified":<Boolean_value>,
"sessionid":<String_value>,
"token":<String_value>,
"Secret":<String_value>}]}
delete
URL: https://<MGMT-IP>/nitro/v1/config/login/
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }