Download full document:

trust_preauthtoken

Configuration for Preauth token required for Agent registration resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
service_name<String>Read-writeThis is the Service name.
Minimum length = 1
Maximum length = 512
name<String>Read-writeName of the Tenant.
Minimum length = 1
Maximum length = 512
token<String>Read-writePreauth token for a tenant.
Minimum length = 1
Maximum length = 512
api_gateway_url<String>Read-writeThis is the service API-GW URL.
Minimum length = 1
Maximum length = 512

Operations

(click to see Properties)

GET (ALL)

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>.

get (all)

URL: https://<MGMT-IP>/nitro/v1/config/trust_preauthtoken

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "trust_preauthtoken":[{
"service_name":<String_value>,
"name":<String_value>,
"token":<String_value>,
"api_gateway_url":<String_value>}]}