Developer Documentation
Citrix ADM NITRO API Reference

login

June 20, 2023
Contributed by: 
C

Configuration for Login/Logout resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
ID Read-write ID of the User that wants to login in cloud.

Maximum length = 128
session_timeout Read-write Session Timeout in seconds, if no activity is performed for specified time then session will be expired.
auth_with_remote_pubkey 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.
password Read-write Password.

Maximum length = 128
challenge Read-write Challenge request for authentication.
challenge_response Read-write Challenge response for authentication.
client_port Read-write Login Client port.

Maximum value =
token Read-write Random token to identify session during logout.
permission Read-write Actions that this user is authorized to perform.

Minimum length = 1

Maximum length = 128
username Read-write User Name that wants to login.

Maximum length = 128
client_ip Read-write Login client IP.
session_creator Read-write session_creator.
sessionid Read-write Session ID would only be set if login was performed successfully.
Secret Read-write Secret.

Maximum length = 128

Operations

(click to see Properties )

  • ADD
  • DELETE

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

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

add

URL: https://<MGMT-IP>/nitro/v2/config/login?onerror=<String_value> HTTPS Method: POST

Request Headers: Content-Type: application/json

X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Request Payload: 

{"login": {
<b>"password":<String_value></b>,
<b>"username":<String_value></b>,
"ID":<String_value>,
"session_timeout":<Integer_value>,
"auth_with_remote_pubkey":<Integer_value>,
"challenge_response":<String_value>,
"challenge":<String_value>,
"client_port":<Integer_value>,
"token":<String_value>,
"permission":<String_value>,
"session_creator":<String_value>,
"client_ip":<String_value>,
"sessionid":<String_value>,
"Secret":<String_value>}}

<!--NeedCopy-->

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "login":[{
"ID":<String_value>,
"session_timeout":<Integer_value>,
"auth_with_remote_pubkey":<Integer_value>,
"login_type":<String_value>,
"password":<String_value>,
"challenge":<String_value>,
"challenge_response":<String_value>,
"client_port":<Integer_value>,
"token":<String_value>,
"tenant_name":<String_value>,
"permission":<String_value>,
"challenge_token":<String_value>,
"username":<String_value>,
"client_ip":<String_value>,
"session_creator":<String_value>,
"sessionid":<String_value>,
"cert_verified":<Boolean_value>,
"Secret":<String_value>}]}

<!--NeedCopy-->

delete

URL: https://<MGMT-IP>/nitro/v2/config/login/ HTTPS Method: DELETE

Request Headers: X-NITRO-USER:username_value<String>

X-NITRO-PASS:password_value<String>

or

Cookie:NITRO_AUTH_TOKEN=token_value<String>

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

<!--NeedCopy-->
login
June 20, 2023
Contributed by: 
C
June 20, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.