This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
authenticationpushservice
Configuration for Service details for sending push notifications resource.
Properties
(click to see Operations)
Name | Data Type | 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)
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 Citrix ADC appliance, the URL is as follows:
http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.
add
URL:http://<Citrix-ADC-IP-address(NSIP)>/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>
}}
Response:
HTTP Status Code on Success: 201 Created HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
delete
URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the error
update
URL:http://<Citrix-ADC-IP-address(NSIP)>/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>
}}
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
unset
URL:http://<Citrix-ADC-IP-address(NSIP)>/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
}}
Response:
HTTP Status Code on Success: 200 OK HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for Citrix ADC specific errors). The response payload provides details of the error
get (all)
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/authenticationpushservice
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/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://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC. Filtering can be done on any of the properties of the resource.
view
http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/authenticationpushservice?view=summary
Note:By default, the retrieved results are displayed in detail view (?view=detail).
pagination
http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
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>
}]}
get
URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/authenticationpushservice/name_value<String>
Query-parameters:
attrs
http://<Citrix-ADC-IP-address(NSIP)>/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://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/authenticationpushservice/name_value<String>?view=summary
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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
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>
}]}
count
URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:
Content-Type:application/json
Response Payload:
{ "authenticationpushservice": [ { "__count": "#no"} ] }
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.