-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
-
videooptimizationdetectionpolicy_videooptimizationglobaldetection_binding
-
videooptimizationglobaldetection_videooptimizationdetectionpolicy_binding
-
videooptimizationglobalpacing_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicylabel_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicy_videooptimizationglobalpacing_binding
-
-
vpnsamlssoprofile
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!
vpnsamlssoprofile
Configuration for SAML sso action resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name |
|
Read-write | Name for the new saml single sign-on 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 SSO 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 |
| samlsigningcertname |
|
Read-write | Name of the signing authority as given in the SAML server’s SSL certificate.
Minimum length = 1 |
| assertionconsumerserviceurl |
|
Read-write | URL to which the assertion is to be sent.
Minimum length = 1 |
| relaystaterule |
|
Read-write | Expression to extract relaystate to be sent along with assertion. Evaluation of this expression should return TEXT content. This is typically a target url to which user is redirected after the recipient validates SAML token. |
| sendpassword |
|
Read-write | Option to send password in assertion.
Default value: OFF Possible values = ON, OFF |
| samlissuername |
|
Read-write | The name to be used in requests sent from Citrix ADC to IdP to uniquely identify Citrix ADC.
Minimum length = 1 |
| signaturealg |
|
Read-write | Algorithm to be used to sign/verify SAML transactions.
Default value: RSA-SHA256 Possible values = RSA-SHA1, RSA-SHA256 |
| digestmethod |
|
Read-write | Algorithm to be used to compute/verify digest for SAML transactions.
Default value: SHA256 Possible values = SHA1, SHA256 |
| audience |
|
Read-write | Audience for which assertion sent by IdP is applicable. This is typically entity name or url that represents ServiceProvider. |
| nameidformat |
|
Read-write | Format of Name Identifier sent in Assertion.
Default value: transient Possible values = Unspecified, emailAddress, X509SubjectName, WindowsDomainQualifiedName, kerberos, entity, persistent, transient |
| nameidexpr |
|
Read-write | Expression that will be evaluated to obtain NameIdentifier to be sent in assertion.
Maximum length = 128 |
| attribute1 |
|
Read-write | Name of attribute1 that needs to be sent in SAML Assertion. |
| attribute1expr |
|
Read-write | Expression that will be evaluated to obtain attribute1’s value to be sent in Assertion.
Maximum length = 128 |
| attribute1friendlyname |
|
Read-write | User-Friendly Name of attribute1 that needs to be sent in SAML Assertion. |
| attribute1format |
|
Read-write | Format of Attribute1 to be sent in Assertion.
Possible values = URI, Basic |
| attribute2 |
|
Read-write | Name of attribute2 that needs to be sent in SAML Assertion. |
| attribute2expr |
|
Read-write | Expression that will be evaluated to obtain attribute2’s value to be sent in Assertion.
Maximum length = 128 |
| attribute2friendlyname |
|
Read-write | User-Friendly Name of attribute2 that needs to be sent in SAML Assertion. |
| attribute2format |
|
Read-write | Format of Attribute2 to be sent in Assertion.
Possible values = URI, Basic |
| attribute3 |
|
Read-write | Name of attribute3 that needs to be sent in SAML Assertion. |
| attribute3expr |
|
Read-write | Expression that will be evaluated to obtain attribute3’s value to be sent in Assertion.
Maximum length = 128 |
| attribute3friendlyname |
|
Read-write | User-Friendly Name of attribute3 that needs to be sent in SAML Assertion. |
| attribute3format |
|
Read-write | Format of Attribute3 to be sent in Assertion.
Possible values = URI, Basic |
| attribute4 |
|
Read-write | Name of attribute4 that needs to be sent in SAML Assertion. |
| attribute4expr |
|
Read-write | Expression that will be evaluated to obtain attribute4’s value to be sent in Assertion.
Maximum length = 128 |
| attribute4friendlyname |
|
Read-write | User-Friendly Name of attribute4 that needs to be sent in SAML Assertion. |
| attribute4format |
|
Read-write | Format of Attribute4 to be sent in Assertion.
Possible values = URI, Basic |
| attribute5 |
|
Read-write | Name of attribute5 that needs to be sent in SAML Assertion. |
| attribute5expr |
|
Read-write | Expression that will be evaluated to obtain attribute5’s value to be sent in Assertion.
Maximum length = 128 |
| attribute5friendlyname |
|
Read-write | User-Friendly Name of attribute5 that needs to be sent in SAML Assertion. |
| attribute5format |
|
Read-write | Format of Attribute5 to be sent in Assertion.
Possible values = URI, Basic |
| attribute6 |
|
Read-write | Name of attribute6 that needs to be sent in SAML Assertion. |
| attribute6expr |
|
Read-write | Expression that will be evaluated to obtain attribute6’s value to be sent in Assertion.
Maximum length = 128 |
| attribute6friendlyname |
|
Read-write | User-Friendly Name of attribute6 that needs to be sent in SAML Assertion. |
| attribute6format |
|
Read-write | Format of Attribute6 to be sent in Assertion.
Possible values = URI, Basic |
| attribute7 |
|
Read-write | Name of attribute7 that needs to be sent in SAML Assertion. |
| attribute7expr |
|
Read-write | Expression that will be evaluated to obtain attribute7’s value to be sent in Assertion.
Maximum length = 128 |
| attribute7friendlyname |
|
Read-write | User-Friendly Name of attribute7 that needs to be sent in SAML Assertion. |
| attribute7format |
|
Read-write | Format of Attribute7 to be sent in Assertion.
Possible values = URI, Basic |
| attribute8 |
|
Read-write | Name of attribute8 that needs to be sent in SAML Assertion. |
| attribute8expr |
|
Read-write | Expression that will be evaluated to obtain attribute8’s value to be sent in Assertion.
Maximum length = 128 |
| attribute8friendlyname |
|
Read-write | User-Friendly Name of attribute8 that needs to be sent in SAML Assertion. |
| attribute8format |
|
Read-write | Format of Attribute8 to be sent in Assertion.
Possible values = URI, Basic |
| attribute9 |
|
Read-write | Name of attribute9 that needs to be sent in SAML Assertion. |
| attribute9expr |
|
Read-write | Expression that will be evaluated to obtain attribute9’s value to be sent in Assertion.
Maximum length = 128 |
| attribute9friendlyname |
|
Read-write | User-Friendly Name of attribute9 that needs to be sent in SAML Assertion. |
| attribute9format |
|
Read-write | Format of Attribute9 to be sent in Assertion.
Possible values = URI, Basic |
| attribute10 |
|
Read-write | Name of attribute10 that needs to be sent in SAML Assertion. |
| attribute10expr |
|
Read-write | Expression that will be evaluated to obtain attribute10’s value to be sent in Assertion.
Maximum length = 128 |
| attribute10friendlyname |
|
Read-write | User-Friendly Name of attribute10 that needs to be sent in SAML Assertion. |
| attribute10format |
|
Read-write | Format of Attribute10 to be sent in Assertion.
Possible values = URI, Basic |
| attribute11 |
|
Read-write | Name of attribute11 that needs to be sent in SAML Assertion. |
| attribute11expr |
|
Read-write | Expression that will be evaluated to obtain attribute11’s value to be sent in Assertion.
Maximum length = 128 |
| attribute11friendlyname |
|
Read-write | User-Friendly Name of attribute11 that needs to be sent in SAML Assertion. |
| attribute11format |
|
Read-write | Format of Attribute11 to be sent in Assertion.
Possible values = URI, Basic |
| attribute12 |
|
Read-write | Name of attribute12 that needs to be sent in SAML Assertion. |
| attribute12expr |
|
Read-write | Expression that will be evaluated to obtain attribute12’s value to be sent in Assertion.
Maximum length = 128 |
| attribute12friendlyname |
|
Read-write | User-Friendly Name of attribute12 that needs to be sent in SAML Assertion. |
| attribute12format |
|
Read-write | Format of Attribute12 to be sent in Assertion.
Possible values = URI, Basic |
| attribute13 |
|
Read-write | Name of attribute13 that needs to be sent in SAML Assertion. |
| attribute13expr |
|
Read-write | Expression that will be evaluated to obtain attribute13’s value to be sent in Assertion.
Maximum length = 128 |
| attribute13friendlyname |
|
Read-write | User-Friendly Name of attribute13 that needs to be sent in SAML Assertion. |
| attribute13format |
|
Read-write | Format of Attribute13 to be sent in Assertion.
Possible values = URI, Basic |
| attribute14 |
|
Read-write | Name of attribute14 that needs to be sent in SAML Assertion. |
| attribute14expr |
|
Read-write | Expression that will be evaluated to obtain attribute14’s value to be sent in Assertion.
Maximum length = 128 |
| attribute14friendlyname |
|
Read-write | User-Friendly Name of attribute14 that needs to be sent in SAML Assertion. |
| attribute14format |
|
Read-write | Format of Attribute14 to be sent in Assertion.
Possible values = URI, Basic |
| attribute15 |
|
Read-write | Name of attribute15 that needs to be sent in SAML Assertion. |
| attribute15expr |
|
Read-write | Expression that will be evaluated to obtain attribute15’s value to be sent in Assertion.
Maximum length = 128 |
| attribute15friendlyname |
|
Read-write | User-Friendly Name of attribute15 that needs to be sent in SAML Assertion. |
| attribute15format |
|
Read-write | Format of Attribute15 to be sent in Assertion.
Possible values = URI, Basic |
| attribute16 |
|
Read-write | Name of attribute16 that needs to be sent in SAML Assertion. |
| attribute16expr |
|
Read-write | Expression that will be evaluated to obtain attribute16’s value to be sent in Assertion.
Maximum length = 128 |
| attribute16friendlyname |
|
Read-write | User-Friendly Name of attribute16 that needs to be sent in SAML Assertion. |
| attribute16format |
|
Read-write | Format of Attribute16 to be sent in Assertion.
Possible values = URI, Basic |
| encryptassertion |
|
Read-write | Option to encrypt assertion when Citrix ADC sends one.
Default value: OFF Possible values = ON, OFF |
| samlspcertname |
|
Read-write | Name of the SSL certificate of peer/receving party using which Assertion is encrypted.
Minimum length = 1 |
| encryptionalgorithm |
|
Read-write | Algorithm to be used to encrypt SAML assertion.
Default value: AES256 Possible values = DES3, AES128, AES192, AES256 |
| skewtime |
|
Read-write | This option specifies the number of minutes on either side of current time that the assertion would be valid. For example, if skewTime is 10, then assertion would be valid from (current time - 10) min to (current time + 10) min, ie 20min in all.
Default value: 5 |
| signassertion |
|
Read-write | Option to sign portions of assertion when Citrix ADC IDP sends one. Based on the user selection, either Assertion or Response or Both or none can be signed.
Default value: ASSERTION Possible values = NONE, ASSERTION, RESPONSE, BOTH |
| signatureservice |
|
Read-write | Name of the service in cloud used to sign the data.
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/vpnsamlssoprofile
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnsamlssoprofile":{
<b> "name":<String_value>,
</b> "samlsigningcertname":<String_value>,
<b> "assertionconsumerserviceurl":<String_value>,
</b> "relaystaterule":<String_value>,
"sendpassword":<String_value>,
"samlissuername":<String_value>,
"signaturealg":<String_value>,
"digestmethod":<String_value>,
"audience":<String_value>,
"nameidformat":<String_value>,
"nameidexpr":<String_value>,
"attribute1":<String_value>,
"attribute1expr":<String_value>,
"attribute1friendlyname":<String_value>,
"attribute1format":<String_value>,
"attribute2":<String_value>,
"attribute2expr":<String_value>,
"attribute2friendlyname":<String_value>,
"attribute2format":<String_value>,
"attribute3":<String_value>,
"attribute3expr":<String_value>,
"attribute3friendlyname":<String_value>,
"attribute3format":<String_value>,
"attribute4":<String_value>,
"attribute4expr":<String_value>,
"attribute4friendlyname":<String_value>,
"attribute4format":<String_value>,
"attribute5":<String_value>,
"attribute5expr":<String_value>,
"attribute5friendlyname":<String_value>,
"attribute5format":<String_value>,
"attribute6":<String_value>,
"attribute6expr":<String_value>,
"attribute6friendlyname":<String_value>,
"attribute6format":<String_value>,
"attribute7":<String_value>,
"attribute7expr":<String_value>,
"attribute7friendlyname":<String_value>,
"attribute7format":<String_value>,
"attribute8":<String_value>,
"attribute8expr":<String_value>,
"attribute8friendlyname":<String_value>,
"attribute8format":<String_value>,
"attribute9":<String_value>,
"attribute9expr":<String_value>,
"attribute9friendlyname":<String_value>,
"attribute9format":<String_value>,
"attribute10":<String_value>,
"attribute10expr":<String_value>,
"attribute10friendlyname":<String_value>,
"attribute10format":<String_value>,
"attribute11":<String_value>,
"attribute11expr":<String_value>,
"attribute11friendlyname":<String_value>,
"attribute11format":<String_value>,
"attribute12":<String_value>,
"attribute12expr":<String_value>,
"attribute12friendlyname":<String_value>,
"attribute12format":<String_value>,
"attribute13":<String_value>,
"attribute13expr":<String_value>,
"attribute13friendlyname":<String_value>,
"attribute13format":<String_value>,
"attribute14":<String_value>,
"attribute14expr":<String_value>,
"attribute14friendlyname":<String_value>,
"attribute14format":<String_value>,
"attribute15":<String_value>,
"attribute15expr":<String_value>,
"attribute15friendlyname":<String_value>,
"attribute15format":<String_value>,
"attribute16":<String_value>,
"attribute16expr":<String_value>,
"attribute16friendlyname":<String_value>,
"attribute16format":<String_value>,
"encryptassertion":<String_value>,
"samlspcertname":<String_value>,
"encryptionalgorithm":<String_value>,
"skewtime":<Double_value>,
"signassertion":<String_value>,
"signatureservice":<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/vpnsamlssoprofile/ 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/vpnsamlssoprofile
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnsamlssoprofile":{
<b> "name":<String_value>,
</b> "samlsigningcertname":<String_value>,
"assertionconsumerserviceurl":<String_value>,
"sendpassword":<String_value>,
"samlissuername":<String_value>,
"relaystaterule":<String_value>,
"signaturealg":<String_value>,
"digestmethod":<String_value>,
"audience":<String_value>,
"nameidformat":<String_value>,
"nameidexpr":<String_value>,
"attribute1":<String_value>,
"attribute1expr":<String_value>,
"attribute1friendlyname":<String_value>,
"attribute1format":<String_value>,
"attribute2":<String_value>,
"attribute2expr":<String_value>,
"attribute2friendlyname":<String_value>,
"attribute2format":<String_value>,
"attribute3":<String_value>,
"attribute3expr":<String_value>,
"attribute3friendlyname":<String_value>,
"attribute3format":<String_value>,
"attribute4":<String_value>,
"attribute4expr":<String_value>,
"attribute4friendlyname":<String_value>,
"attribute4format":<String_value>,
"attribute5":<String_value>,
"attribute5expr":<String_value>,
"attribute5friendlyname":<String_value>,
"attribute5format":<String_value>,
"attribute6":<String_value>,
"attribute6expr":<String_value>,
"attribute6friendlyname":<String_value>,
"attribute6format":<String_value>,
"attribute7":<String_value>,
"attribute7expr":<String_value>,
"attribute7friendlyname":<String_value>,
"attribute7format":<String_value>,
"attribute8":<String_value>,
"attribute8expr":<String_value>,
"attribute8friendlyname":<String_value>,
"attribute8format":<String_value>,
"attribute9":<String_value>,
"attribute9expr":<String_value>,
"attribute9friendlyname":<String_value>,
"attribute9format":<String_value>,
"attribute10":<String_value>,
"attribute10expr":<String_value>,
"attribute10friendlyname":<String_value>,
"attribute10format":<String_value>,
"attribute11":<String_value>,
"attribute11expr":<String_value>,
"attribute11friendlyname":<String_value>,
"attribute11format":<String_value>,
"attribute12":<String_value>,
"attribute12expr":<String_value>,
"attribute12friendlyname":<String_value>,
"attribute12format":<String_value>,
"attribute13":<String_value>,
"attribute13expr":<String_value>,
"attribute13friendlyname":<String_value>,
"attribute13format":<String_value>,
"attribute14":<String_value>,
"attribute14expr":<String_value>,
"attribute14friendlyname":<String_value>,
"attribute14format":<String_value>,
"attribute15":<String_value>,
"attribute15expr":<String_value>,
"attribute15friendlyname":<String_value>,
"attribute15format":<String_value>,
"attribute16":<String_value>,
"attribute16expr":<String_value>,
"attribute16friendlyname":<String_value>,
"attribute16format":<String_value>,
"encryptassertion":<String_value>,
"samlspcertname":<String_value>,
"encryptionalgorithm":<String_value>,
"skewtime":<Double_value>,
"signassertion":<String_value>,
"signatureservice":<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/vpnsamlssoprofile? action=unset
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnsamlssoprofile":{
<b> "name":<String_value>,
</b> "samlsigningcertname":true,
"sendpassword":true,
"samlissuername":true,
"relaystaterule":true,
"signaturealg":true,
"digestmethod":true,
"audience":true,
"nameidformat":true,
"nameidexpr":true,
"attribute1":true,
"attribute1friendlyname":true,
"attribute1format":true,
"attribute2":true,
"attribute2friendlyname":true,
"attribute2format":true,
"attribute3":true,
"attribute3friendlyname":true,
"attribute3format":true,
"attribute4":true,
"attribute4friendlyname":true,
"attribute4format":true,
"attribute5":true,
"attribute5friendlyname":true,
"attribute5format":true,
"attribute6":true,
"attribute6friendlyname":true,
"attribute6format":true,
"attribute7":true,
"attribute7friendlyname":true,
"attribute7format":true,
"attribute8":true,
"attribute8friendlyname":true,
"attribute8format":true,
"attribute9":true,
"attribute9friendlyname":true,
"attribute9format":true,
"attribute10":true,
"attribute10friendlyname":true,
"attribute10format":true,
"attribute11":true,
"attribute11friendlyname":true,
"attribute11format":true,
"attribute12":true,
"attribute12friendlyname":true,
"attribute12format":true,
"attribute13":true,
"attribute13friendlyname":true,
"attribute13format":true,
"attribute14":true,
"attribute14friendlyname":true,
"attribute14format":true,
"attribute15":true,
"attribute15friendlyname":true,
"attribute15format":true,
"attribute16":true,
"attribute16friendlyname":true,
"attribute16format":true,
"encryptassertion":true,
"samlspcertname":true,
"encryptionalgorithm":true,
"skewtime":true,
"signassertion":true,
"signatureservice":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/vpnsamlssoprofile
Query-parameters:
attrs
http:// <netscaler-ip-address> /nitro/v1/config/vpnsamlssoprofile? 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/vpnsamlssoprofile? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of vpnsamlssoprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http:// <netscaler-ip-address> /nitro/v1/config/vpnsamlssoprofile? view=summary
Use this query-parameter to get the summary output of vpnsamlssoprofile 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/vpnsamlssoprofile? pagesize=#no;pageno=#no
Use this query-parameter to get the vpnsamlssoprofile 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:
{ "vpnsamlssoprofile": [ {
"name":<String_value>,
"samlsigningcertname":<String_value>,
"assertionconsumerserviceurl":<String_value>,
"sendpassword":<String_value>,
"samlissuername":<String_value>,
"relaystaterule":<String_value>,
"signaturealg":<String_value>,
"digestmethod":<String_value>,
"audience":<String_value>,
"nameidformat":<String_value>,
"nameidexpr":<String_value>,
"attribute1":<String_value>,
"attribute2":<String_value>,
"attribute3":<String_value>,
"attribute4":<String_value>,
"attribute5":<String_value>,
"attribute6":<String_value>,
"attribute7":<String_value>,
"attribute8":<String_value>,
"attribute9":<String_value>,
"attribute10":<String_value>,
"attribute11":<String_value>,
"attribute12":<String_value>,
"attribute13":<String_value>,
"attribute14":<String_value>,
"attribute15":<String_value>,
"attribute16":<String_value>,
"attribute1friendlyname":<String_value>,
"attribute2friendlyname":<String_value>,
"attribute3friendlyname":<String_value>,
"attribute4friendlyname":<String_value>,
"attribute5friendlyname":<String_value>,
"attribute6friendlyname":<String_value>,
"attribute7friendlyname":<String_value>,
"attribute8friendlyname":<String_value>,
"attribute9friendlyname":<String_value>,
"attribute10friendlyname":<String_value>,
"attribute11friendlyname":<String_value>,
"attribute12friendlyname":<String_value>,
"attribute13friendlyname":<String_value>,
"attribute14friendlyname":<String_value>,
"attribute15friendlyname":<String_value>,
"attribute16friendlyname":<String_value>,
"attribute1format":<String_value>,
"attribute2format":<String_value>,
"attribute3format":<String_value>,
"attribute4format":<String_value>,
"attribute5format":<String_value>,
"attribute6format":<String_value>,
"attribute7format":<String_value>,
"attribute8format":<String_value>,
"attribute9format":<String_value>,
"attribute10format":<String_value>,
"attribute11format":<String_value>,
"attribute12format":<String_value>,
"attribute13format":<String_value>,
"attribute14format":<String_value>,
"attribute15format":<String_value>,
"attribute16format":<String_value>,
"attribute1expr":<String_value>,
"attribute2expr":<String_value>,
"attribute3expr":<String_value>,
"attribute4expr":<String_value>,
"attribute5expr":<String_value>,
"attribute6expr":<String_value>,
"attribute7expr":<String_value>,
"attribute8expr":<String_value>,
"attribute9expr":<String_value>,
"attribute10expr":<String_value>,
"attribute11expr":<String_value>,
"attribute12expr":<String_value>,
"attribute13expr":<String_value>,
"attribute14expr":<String_value>,
"attribute15expr":<String_value>,
"attribute16expr":<String_value>,
"encryptassertion":<String_value>,
"samlspcertname":<String_value>,
"encryptionalgorithm":<String_value>,
"skewtime":<Double_value>,
"signassertion":<String_value>,
"signatureservice":<String_value>
}]}
<!--NeedCopy-->
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnsamlssoprofile/ name_value<String>
Query-parameters:
attrs
http:// <netscaler-ip-address> /nitro/v1/config/vpnsamlssoprofile/ 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/vpnsamlssoprofile/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of vpnsamlssoprofile 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:
{ "vpnsamlssoprofile": [ {
"name":<String_value>,
"samlsigningcertname":<String_value>,
"assertionconsumerserviceurl":<String_value>,
"sendpassword":<String_value>,
"samlissuername":<String_value>,
"relaystaterule":<String_value>,
"signaturealg":<String_value>,
"digestmethod":<String_value>,
"audience":<String_value>,
"nameidformat":<String_value>,
"nameidexpr":<String_value>,
"attribute1":<String_value>,
"attribute2":<String_value>,
"attribute3":<String_value>,
"attribute4":<String_value>,
"attribute5":<String_value>,
"attribute6":<String_value>,
"attribute7":<String_value>,
"attribute8":<String_value>,
"attribute9":<String_value>,
"attribute10":<String_value>,
"attribute11":<String_value>,
"attribute12":<String_value>,
"attribute13":<String_value>,
"attribute14":<String_value>,
"attribute15":<String_value>,
"attribute16":<String_value>,
"attribute1friendlyname":<String_value>,
"attribute2friendlyname":<String_value>,
"attribute3friendlyname":<String_value>,
"attribute4friendlyname":<String_value>,
"attribute5friendlyname":<String_value>,
"attribute6friendlyname":<String_value>,
"attribute7friendlyname":<String_value>,
"attribute8friendlyname":<String_value>,
"attribute9friendlyname":<String_value>,
"attribute10friendlyname":<String_value>,
"attribute11friendlyname":<String_value>,
"attribute12friendlyname":<String_value>,
"attribute13friendlyname":<String_value>,
"attribute14friendlyname":<String_value>,
"attribute15friendlyname":<String_value>,
"attribute16friendlyname":<String_value>,
"attribute1format":<String_value>,
"attribute2format":<String_value>,
"attribute3format":<String_value>,
"attribute4format":<String_value>,
"attribute5format":<String_value>,
"attribute6format":<String_value>,
"attribute7format":<String_value>,
"attribute8format":<String_value>,
"attribute9format":<String_value>,
"attribute10format":<String_value>,
"attribute11format":<String_value>,
"attribute12format":<String_value>,
"attribute13format":<String_value>,
"attribute14format":<String_value>,
"attribute15format":<String_value>,
"attribute16format":<String_value>,
"attribute1expr":<String_value>,
"attribute2expr":<String_value>,
"attribute3expr":<String_value>,
"attribute4expr":<String_value>,
"attribute5expr":<String_value>,
"attribute6expr":<String_value>,
"attribute7expr":<String_value>,
"attribute8expr":<String_value>,
"attribute9expr":<String_value>,
"attribute10expr":<String_value>,
"attribute11expr":<String_value>,
"attribute12expr":<String_value>,
"attribute13expr":<String_value>,
"attribute14expr":<String_value>,
"attribute15expr":<String_value>,
"attribute16expr":<String_value>,
"encryptassertion":<String_value>,
"samlspcertname":<String_value>,
"encryptionalgorithm":<String_value>,
"skewtime":<Double_value>,
"signassertion":<String_value>,
"signatureservice":<String_value>
}]}
<!--NeedCopy-->
count
URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnsamlssoprofile? 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:
{ "vpnsamlssoprofile": [ { "__count": "#no"} ] }
<!--NeedCopy-->
Share
Share
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.