ADC NITRO APIs

authenticationazurekeyvault

August 17, 2023

Contributed by:

Configuration for Azure Key Vault entity resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name for the new Azure Key Vault profile. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after an action is created. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my action” or ‘my action’). Minimum length = 1
vaultname	Read-write	Name of the Azure vault account as configured in azure portal. Minimum length = 1 Maximum length = 63
clientid	Read-write	Unique identity of the relying party requesting for authentication. Minimum length = 1
clientsecret	Read-write	Unique secret string to authorize relying party at authorization server. Minimum length = 1
servicekeyname	Read-write	Friendly name of the Key to be used to compute signature. Minimum length = 1
signaturealg	Read-write	Algorithm to be used to sign/verify transactions. Default value: RS256 Possible values = RS256
tokenendpoint	Read-write	URL endpoint on relying party to which the OAuth token is to be sent. Minimum length = 1
pushservice	Read-write	Name of the service used to send push notifications. Minimum length = 1
defaultauthenticationgroup	Read-write	This is the group that is added to user sessions that match current IdP policy. It can be used in policies to identify relying party trust.
refreshinterval	Read-write	Interval at which access token in obtained. Default value: 50
tenantid	Read-write	TenantID of the application. This is usually specific to providers such as Microsoft and usually refers to the deployment identifier.
authentication	Read-write	If authentication is disabled, otp checks are not performed after azure vault keys are obtained. This is useful to distinguish whether user has registered devices. . Default value: ENABLED Possible values = ENABLED, DISABLED
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
UPDATE
UNSET
GET (ALL)
GET
COUNT

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: http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"authenticationazurekeyvault":{
<b>      "name":<String_value>,
</b><b>      "vaultname":<String_value>,
</b><b>      "clientid":<String_value>,
</b><b>      "clientsecret":<String_value>,
</b><b>      "servicekeyname":<String_value>,
</b>      "signaturealg":<String_value>,
      "tokenendpoint":<String_value>,
      "pushservice":<String_value>,
      "defaultauthenticationgroup":<String_value>,
      "refreshinterval":<Double_value>,
      "tenantid":<String_value>,
      "authentication":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault/ name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"authenticationazurekeyvault":{
<b>      "name":<String_value>,
</b>      "vaultname":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "servicekeyname":<String_value>,
      "signaturealg":<String_value>,
      "tokenendpoint":<String_value>,
      "pushservice":<String_value>,
      "defaultauthenticationgroup":<String_value>,
      "refreshinterval":<Double_value>,
      "tenantid":<String_value>,
      "authentication":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"authenticationazurekeyvault":{
<b>      "name":<String_value>,
</b>      "signaturealg":true,
      "pushservice":true,
      "defaultauthenticationgroup":true,
      "refreshinterval":true,
      "authentication":true
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of authenticationazurekeyvault resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault? view=summary

Use this query-parameter to get the summary output of authenticationazurekeyvault resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault? pagesize=#no;pageno=#no

Use this query-parameter to get the authenticationazurekeyvault resources in chunks.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "authenticationazurekeyvault": [ {
      "name":<String_value>,
      "vaultname":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "servicekeyname":<String_value>,
      "signaturealg":<String_value>,
      "tokenendpoint":<String_value>,
      "pushservice":<String_value>,
      "defaultauthenticationgroup":<String_value>,
      "refreshinterval":<Double_value>,
      "tenantid":<String_value>,
      "authentication":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of authenticationazurekeyvault resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "authenticationazurekeyvault": [ {
      "name":<String_value>,
      "vaultname":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "servicekeyname":<String_value>,
      "signaturealg":<String_value>,
      "tokenendpoint":<String_value>,
      "pushservice":<String_value>,
      "defaultauthenticationgroup":<String_value>,
      "refreshinterval":<Double_value>,
      "tenantid":<String_value>,
      "authentication":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationazurekeyvault? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "authenticationazurekeyvault": [ { "__count": "#no"} ] }

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

authenticationazurekeyvault

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

authenticationazurekeyvault

Properties

Operations

add

delete

update

unset

get (all)

get

count

In this article