-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
videooptimizationdetectionpolicylabel_videooptimizationdetectionpolicy_binding
-
videooptimizationdetectionpolicy_videooptimizationglobaldetection_binding
-
videooptimizationglobaldetection_videooptimizationdetectionpolicy_binding
-
videooptimizationglobalpacing_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicylabel_videooptimizationpacingpolicy_binding
-
videooptimizationpacingpolicy_videooptimizationglobalpacing_binding
-
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!
authenticationsamlaction
Configuration for AAA Saml action resource.
Properties
(click to see Operations )
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| name |
|
Read-write | Name for the SAML server profile (action). Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after SAML profile 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 authentication action” or ‘my authentication action’). Minimum length = 1 |
| metadataurl |
|
Read-write | This URL is used for obtaining saml metadata. Note that it fills samlIdPCertName and samlredirectUrl fields so those fields should not be updated when metadataUrl present. |
| samlidpcertname |
|
Read-write | Name of the SSL certificate used to verify responses from SAML Identity Provider (IdP). Note that if metadateURL is present then this filed should be empty.
Minimum length = 1 |
| samlsigningcertname |
|
Read-write | Name of the SSL certificate to sign requests from ServiceProvider (SP) to Identity Provider (IdP).
Minimum length = 1 |
| samlredirecturl |
|
Read-write | URL to which users are redirected for authentication. Note that if metadateURL is present then this filed should be empty.
Minimum length = 1 |
| samlacsindex |
|
Read-write | Index/ID of the metadata entry corresponding to this configuration.
Default value: 255 Minimum value = 0 Maximum value = 255 |
| samluserfield |
|
Read-write | SAML user ID, as given in the SAML assertion.
Minimum length = 1 |
| samlrejectunsignedassertion |
|
Read-write | Reject unsigned SAML assertions. ON option results in rejection of Assertion that is received without signature. STRICT option ensures that both Response and Assertion are signed. OFF allows unsigned Assertions.
Default value: ON Possible values = ON, OFF, STRICT |
| samlissuername |
|
Read-write | The name to be used in requests sent from Citrix ADC to IdP to uniquely identify Citrix ADC.
Minimum length = 1 |
| samltwofactor |
|
Read-write | Option to enable second factor after SAML.
Default value: OFF Possible values = ON, OFF |
| defaultauthenticationgroup |
|
Read-write | This is the default group that is chosen when the authentication succeeds in addition to extracted groups. |
| attribute1 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute1. Maximum length of the extracted attribute is 239 bytes. |
| attribute2 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute2. Maximum length of the extracted attribute is 239 bytes. |
| attribute3 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute3. Maximum length of the extracted attribute is 239 bytes. |
| attribute4 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute4. Maximum length of the extracted attribute is 239 bytes. |
| attribute5 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute5. Maximum length of the extracted attribute is 239 bytes. |
| attribute6 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute6. Maximum length of the extracted attribute is 239 bytes. |
| attribute7 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute7. Maximum length of the extracted attribute is 239 bytes. |
| attribute8 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute8. Maximum length of the extracted attribute is 239 bytes. |
| attribute9 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute9. Maximum length of the extracted attribute is 239 bytes. |
| attribute10 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute10. Maximum length of the extracted attribute is 239 bytes. |
| attribute11 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute11. Maximum length of the extracted attribute is 239 bytes. |
| attribute12 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute12. Maximum length of the extracted attribute is 239 bytes. |
| attribute13 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute13. Maximum length of the extracted attribute is 239 bytes. |
| attribute14 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute14. Maximum length of the extracted attribute is 239 bytes. |
| attribute15 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute15. Maximum length of the extracted attribute is 239 bytes. |
| attribute16 |
|
Read-write | Name of the attribute in SAML Assertion whose value needs to be extracted and stored as attribute16. Maximum length of the extracted attribute is 239 bytes. |
| attributes |
|
Read-write | List of attribute names separated by ‘,’ which needs to be extracted.
Note that preceeding and trailing spaces will be removed. Attribute name can be 127 bytes and total length of this string should not cross 2047 bytes. These attributes have multi-value support separated by ‘,’ and stored as key-value pair in AAA session. |
| 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 |
| requestedauthncontext |
|
Read-write | This element specifies the authentication context requirements of authentication statements returned in the response.
Default value: exact Possible values = exact, minimum, maximum, better |
| authnctxclassref | <String[]> | Read-write | This element specifies the authentication class types that are requested from IdP (IdentityProvider).
InternetProtocol: This is applicable when a principal is authenticated through the use of a provided IP address. InternetProtocolPassword: This is applicable when a principal is authenticated through the use of a provided IP address, in addition to a username/password. Kerberos: This is applicable when the principal has authenticated using a password to a local authentication authority, in order to acquire a Kerberos ticket. MobileOneFactorUnregistered: This indicates authentication of the mobile device without requiring explicit end-user interaction. MobileTwoFactorUnregistered: This indicates two-factor based authentication during mobile customer registration process, such as secure device and user PIN. MobileOneFactorContract: Reflects mobile contract customer registration procedures and a single factor authentication. MobileTwoFactorContract: Reflects mobile contract customer registration procedures and a two-factor based authentication. Password: This class is applicable when a principal authenticates using password over unprotected http session. PasswordProtectedTransport: This class is applicable when a principal authenticates to an authentication authority through the presentation of a password over a protected session. PreviousSession: This class is applicable when a principal had authenticated to an authentication authority at some point in the past using any authentication context. X509: This indicates that the principal authenticated by means of a digital signature where the key was validated as part of an X.509 Public Key Infrastructure. PGP: This indicates that the principal authenticated by means of a digital signature where the key was validated as part of a PGP Public Key Infrastructure. SPKI: This indicates that the principal authenticated by means of a digital signature where the key was validated via an SPKI Infrastructure. XMLDSig: This indicates that the principal authenticated by means of a digital signature according to the processing rules specified in the XML Digital Signature specification. Smartcard: This indicates that the principal has authenticated using smartcard. SmartcardPKI: This class is applicable when a principal authenticates to an authentication authority through a two-factor authentication mechanism using a smartcard with enclosed private key and a PIN. SoftwarePKI: This class is applicable when a principal uses an X.509 certificate stored in software to authenticate to the authentication authority. Telephony: This class is used to indicate that the principal authenticated via the provision of a fixed-line telephone number, transported via a telephony protocol such as ADSL. NomadTelephony: Indicates that the principal is “roaming” and authenticates via the means of the line number, a user suffix, and a password element. PersonalTelephony: This class is used to indicate that the principal authenticated via the provision of a fixed-line telephone. AuthenticatedTelephony: Indicates that the principal authenticated via the means of the line number, a user suffix, and a password element. SecureRemotePassword: This class is applicable when the authentication was performed by means of Secure Remote Password. TLSClient: This class indicates that the principal authenticated by means of a client certificate, secured with the SSL/TLS transport. TimeSyncToken: This is applicable when a principal authenticates through a time synchronization token. Unspecified: This indicates that the authentication was performed by unspecified means. Windows: This indicates that Windows integrated authentication is utilized for authentication. Possible values = InternetProtocol, InternetProtocolPassword, Kerberos, MobileOneFactorUnregistered, MobileTwoFactorUnregistered, MobileOneFactorContract, MobileTwoFactorContract, Password, PasswordProtectedTransport, PreviousSession, X509, PGP, SPKI, XMLDSig, Smartcard, SmartcardPKI, SoftwarePKI, Telephony, NomadTelephony, PersonalTelephony, AuthenticatedTelephony, SecureRemotePassword, TLSClient, TimeSyncToken, Unspecified, Windows |
| customauthnctxclassref |
|
Read-write | This element specifies the custom authentication class reference to be sent as a part of the Authentication Request that is sent by the SP to SAML IDP. The input string must be the body of the authentication class being requested.
Input format: Alphanumeric string or URL specifying the body of the Request.If more than one string has to be provided, then the same can be done by specifying the classes as a string of comma separated values. Example input: set authentication samlaction samlact1 -customAuthnCtxClassRef http://www.class1.com/LoA1,http://www.class2.com/LoA2 . Maximum length = 512 |
| samlbinding |
|
Read-write | This element specifies the transport mechanism of saml messages.
Default value: POST Possible values = REDIRECT, POST, ARTIFACT |
| attributeconsumingserviceindex |
|
Read-write | Index/ID of the attribute specification at Identity Provider (IdP). IdP will locate attributes requested by SP using this index and send those attributes in Assertion.
Default value: 255 Minimum value = 0 Maximum value = 255 |
| sendthumbprint |
|
Read-write | Option to send thumbprint instead of x509 certificate in SAML request.
Default value: OFF Possible values = ON, OFF |
| enforceusername |
|
Read-write | Option to choose whether the username that is extracted from SAML assertion can be edited in login page while doing second factor.
Default value: ON Possible values = ON, OFF |
| logouturl |
|
Read-write | SingleLogout URL on IdP to which logoutRequest will be sent on Citrix ADC session cleanup. |
| artifactresolutionserviceurl |
|
Read-write | URL of the Artifact Resolution Service on IdP to which Citrix ADC will post artifact to get actual SAML token. |
| skewtime |
|
Read-write | This option specifies the allowed clock skew in number of minutes that Citrix ADC ServiceProvider allows on an incoming assertion. 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 |
| logoutbinding |
|
Read-write | This element specifies the transport mechanism of saml logout messages.
Default value: POST Possible values = REDIRECT, POST |
| forceauthn |
|
Read-write | Option that forces authentication at the Identity Provider (IdP) that receives Citrix ADC’s request.
Default value: OFF Possible values = ON, OFF |
| groupnamefield |
|
Read-write | Name of the tag in assertion that contains user groups. |
| audience |
|
Read-write | Audience for which assertion sent by IdP is applicable. This is typically entity name or url that represents ServiceProvider. |
| metadatarefreshinterval |
|
Read-write | Interval in minutes for fetching metadata from specified metadata URL.
Default value: 36000 |
| storesamlresponse |
|
Read-write | Option to store entire SAML Response through the life of user session.
Default value: OFF Possible values = ON, OFF |
| metadataimportstatus |
|
Read-only | Describes metadata import status.
Default value: SUCCESS Possible values = INIT, SUCCESS, FAIL |
| __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/authenticationsamlaction
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"authenticationsamlaction":{
<b> "name":<String_value>,
</b> "metadataurl":<String_value>,
"samlidpcertname":<String_value>,
"samlsigningcertname":<String_value>,
"samlredirecturl":<String_value>,
"samlacsindex":<Double_value>,
"samluserfield":<String_value>,
"samlrejectunsignedassertion":<String_value>,
"samlissuername":<String_value>,
"samltwofactor":<String_value>,
"defaultauthenticationgroup":<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>,
"attributes":<String_value>,
"signaturealg":<String_value>,
"digestmethod":<String_value>,
"requestedauthncontext":<String_value>,
"authnctxclassref":<String[]_value>,
"customauthnctxclassref":<String_value>,
"samlbinding":<String_value>,
"attributeconsumingserviceindex":<Double_value>,
"sendthumbprint":<String_value>,
"enforceusername":<String_value>,
"logouturl":<String_value>,
"artifactresolutionserviceurl":<String_value>,
"skewtime":<Double_value>,
"logoutbinding":<String_value>,
"forceauthn":<String_value>,
"groupnamefield":<String_value>,
"audience":<String_value>,
"metadatarefreshinterval":<Double_value>,
"storesamlresponse":<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/authenticationsamlaction/ 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/authenticationsamlaction
HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"authenticationsamlaction":{
<b> "name":<String_value>,
</b> "metadataurl":<String_value>,
"samlidpcertname":<String_value>,
"samlsigningcertname":<String_value>,
"samlredirecturl":<String_value>,
"samlacsindex":<Double_value>,
"samluserfield":<String_value>,
"samlrejectunsignedassertion":<String_value>,
"samlissuername":<String_value>,
"samltwofactor":<String_value>,
"defaultauthenticationgroup":<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>,
"attributes":<String_value>,
"signaturealg":<String_value>,
"digestmethod":<String_value>,
"requestedauthncontext":<String_value>,
"authnctxclassref":<String[]_value>,
"customauthnctxclassref":<String_value>,
"samlbinding":<String_value>,
"attributeconsumingserviceindex":<Double_value>,
"sendthumbprint":<String_value>,
"enforceusername":<String_value>,
"logouturl":<String_value>,
"artifactresolutionserviceurl":<String_value>,
"skewtime":<Double_value>,
"logoutbinding":<String_value>,
"forceauthn":<String_value>,
"groupnamefield":<String_value>,
"audience":<String_value>,
"metadatarefreshinterval":<Double_value>,
"storesamlresponse":<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/authenticationsamlaction? action=unset
HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"authenticationsamlaction":{
<b> "name":<String_value>,
</b> "metadataurl":true,
"samlsigningcertname":true,
"samlredirecturl":true,
"samlacsindex":true,
"samluserfield":true,
"samlrejectunsignedassertion":true,
"samlissuername":true,
"samltwofactor":true,
"defaultauthenticationgroup":true,
"attribute1":true,
"attribute2":true,
"attribute3":true,
"attribute4":true,
"attribute5":true,
"attribute6":true,
"attribute7":true,
"attribute8":true,
"attribute9":true,
"attribute10":true,
"attribute11":true,
"attribute12":true,
"attribute13":true,
"attribute14":true,
"attribute15":true,
"attribute16":true,
"attributes":true,
"signaturealg":true,
"digestmethod":true,
"requestedauthncontext":true,
"authnctxclassref":true,
"customauthnctxclassref":true,
"samlbinding":true,
"attributeconsumingserviceindex":true,
"sendthumbprint":true,
"enforceusername":true,
"logouturl":true,
"artifactresolutionserviceurl":true,
"skewtime":true,
"logoutbinding":true,
"forceauthn":true,
"groupnamefield":true,
"audience":true,
"metadatarefreshinterval":true,
"storesamlresponse":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/authenticationsamlaction
Query-parameters:
attrs
http:// <netscaler-ip-address> /nitro/v1/config/authenticationsamlaction? 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/authenticationsamlaction? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of authenticationsamlaction resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view
http:// <netscaler-ip-address> /nitro/v1/config/authenticationsamlaction? view=summary
Use this query-parameter to get the summary output of authenticationsamlaction 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/authenticationsamlaction? pagesize=#no;pageno=#no
Use this query-parameter to get the authenticationsamlaction 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:
{ "authenticationsamlaction": [ {
"name":<String_value>,
"metadataurl":<String_value>,
"samlidpcertname":<String_value>,
"samlsigningcertname":<String_value>,
"samlredirecturl":<String_value>,
"samlacsindex":<Double_value>,
"samluserfield":<String_value>,
"samlrejectunsignedassertion":<String_value>,
"samlissuername":<String_value>,
"samltwofactor":<String_value>,
"defaultauthenticationgroup":<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>,
"attributes":<String_value>,
"signaturealg":<String_value>,
"digestmethod":<String_value>,
"requestedauthncontext":<String_value>,
"authnctxclassref":<String[]_value>,
"customauthnctxclassref":<String_value>,
"samlbinding":<String_value>,
"attributeconsumingserviceindex":<Double_value>,
"sendthumbprint":<String_value>,
"enforceusername":<String_value>,
"logouturl":<String_value>,
"artifactresolutionserviceurl":<String_value>,
"skewtime":<Double_value>,
"logoutbinding":<String_value>,
"forceauthn":<String_value>,
"groupnamefield":<String_value>,
"audience":<String_value>,
"metadatarefreshinterval":<Double_value>,
"metadataimportstatus":<String_value>,
"storesamlresponse":<String_value>
}]}
<!--NeedCopy-->
get
URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationsamlaction/ name_value<String>
Query-parameters:
attrs
http:// <netscaler-ip-address> /nitro/v1/config/authenticationsamlaction/ 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/authenticationsamlaction/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of authenticationsamlaction 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:
{ "authenticationsamlaction": [ {
"name":<String_value>,
"metadataurl":<String_value>,
"samlidpcertname":<String_value>,
"samlsigningcertname":<String_value>,
"samlredirecturl":<String_value>,
"samlacsindex":<Double_value>,
"samluserfield":<String_value>,
"samlrejectunsignedassertion":<String_value>,
"samlissuername":<String_value>,
"samltwofactor":<String_value>,
"defaultauthenticationgroup":<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>,
"attributes":<String_value>,
"signaturealg":<String_value>,
"digestmethod":<String_value>,
"requestedauthncontext":<String_value>,
"authnctxclassref":<String[]_value>,
"customauthnctxclassref":<String_value>,
"samlbinding":<String_value>,
"attributeconsumingserviceindex":<Double_value>,
"sendthumbprint":<String_value>,
"enforceusername":<String_value>,
"logouturl":<String_value>,
"artifactresolutionserviceurl":<String_value>,
"skewtime":<Double_value>,
"logoutbinding":<String_value>,
"forceauthn":<String_value>,
"groupnamefield":<String_value>,
"audience":<String_value>,
"metadatarefreshinterval":<Double_value>,
"metadataimportstatus":<String_value>,
"storesamlresponse":<String_value>
}]}
<!--NeedCopy-->
count
URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationsamlaction? 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:
{ "authenticationsamlaction": [ { "__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.