ADC NITRO APIs

authenticationpushservice

August 17, 2023

Contributed by:

Configuration for Service details for sending push notifications resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name for the push service. Must begin with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters. Cannot be changed after the profile is created. CLI Users: If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my push service” or ‘my push service’). . Minimum length = 1 Maximum length = 127
clientid	Read-write	Unique identity for communicating with Citrix Push server in cloud. Minimum length = 1
clientsecret	Read-write	Unique secret for communicating with Citrix Push server in cloud. Minimum length = 1
customerid	Read-write	Customer id/name of the account in cloud that is used to create clientid/secret pair. Minimum length = 1
refreshinterval	Read-write	Interval at which certificates or idtoken is refreshed. Default value: 50
Namespace	Read-only	This is fully qualified domain name of the notification service in the cloud. If omitted, namespace defaults to https://mfa.cloud.com/. Minimum length = 1 Maximum length = 63
hubname	Read-only	Name of the hub within a namespace. This is used to classify different identities within a namespace. Minimum length = 1
servicekey	Read-only	Key to be used to compute signature necessary for registering to notification service. Minimum length = 1
servicekeyname	Read-only	Friendly name of the Key to be used to compute signature necessary for registering to notification service. Minimum length = 1
certendpoint	Read-only	URL of the endpoint that contains JWKs (Json Web Key) for JWT (Json Web Token) verification. This is used at cloud instance that offers push service.
pushservicestatus	Read-only	Describes status of push service. Default value: INIT Possible values = INIT, CERTFETCH, CCTOKEN, COMPLETE
trustservice	Read-only	URL of the service that generates tokens for cloud access. Minimum length = 1
pushcloudserverstatus	Read-only	Describes status of the cloud service that does push. Possible values = UP, DOWN
signingkeyname	Read-only	Friendly name of the Key to be used to compute signature necessary for accessing notification service. Minimum length = 1
signingkey	Read-only	Key to be used to compute signature necessary for accessing notification service. Minimum length = 1
__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/authenticationpushservice

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"authenticationpushservice":{
<b>      "name":<String_value>,
</b>      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "customerid":<String_value>,
      "refreshinterval":<Double_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/authenticationpushservice/ 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/authenticationpushservice

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"authenticationpushservice":{
<b>      "name":<String_value>,
</b>      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "customerid":<String_value>,
      "refreshinterval":<Double_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/authenticationpushservice? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"authenticationpushservice":{
<b>      "name":<String_value>,
</b>      "refreshinterval":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/authenticationpushservice

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/authenticationpushservice? 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/authenticationpushservice? filter=property-name1:property-val1,property-name2:property-val2

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

view

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

Use this query-parameter to get the summary output of authenticationpushservice 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/authenticationpushservice? pagesize=#no;pageno=#no

Use this query-parameter to get the authenticationpushservice 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:

{ "authenticationpushservice": [ {
      "name":<String_value>,
      "Namespace":<String_value>,
      "hubname":<String_value>,
      "servicekey":<String_value>,
      "servicekeyname":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "customerid":<String_value>,
      "certendpoint":<String_value>,
      "refreshinterval":<Double_value>,
      "pushservicestatus":<String_value>,
      "trustservice":<String_value>,
      "pushcloudserverstatus":<String_value>,
      "signingkeyname":<String_value>,
      "signingkey":<String_value>
}]}

<!--NeedCopy-->

get

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

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/authenticationpushservice/ 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/authenticationpushservice/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of authenticationpushservice 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:

{  "authenticationpushservice": [ {
      "name":<String_value>,
      "Namespace":<String_value>,
      "hubname":<String_value>,
      "servicekey":<String_value>,
      "servicekeyname":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "customerid":<String_value>,
      "certendpoint":<String_value>,
      "refreshinterval":<Double_value>,
      "pushservicestatus":<String_value>,
      "trustservice":<String_value>,
      "pushcloudserverstatus":<String_value>,
      "signingkeyname":<String_value>,
      "signingkey":<String_value>
}]}

<!--NeedCopy-->

count

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

{ "authenticationpushservice": [ { "__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

authenticationpushservice

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

authenticationpushservice

Properties

Operations

add

delete

update

unset

get (all)

get

count

In this article