Download full document:

vpnsamlssoprofile

Configuration for SAML sso action resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
name<String>Read-writeName 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.<br><br>The following requirement applies only to the NetScaler CLI:<br>If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, "my action" or my action).<br>Minimum length = 1
samlsigningcertname<String>Read-writeName of the signing authority as given in the SAML servers SSL certificate.<br>Minimum length = 1
assertionconsumerserviceurl<String>Read-writeURL to which the assertion is to be sent.<br>Minimum length = 1
relaystaterule<String>Read-writeExpression 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<String>Read-writeOption to send password in assertion.<br>Default value: OFF<br>Possible values = ON, OFF
samlissuername<String>Read-writeThe name to be used in requests sent from Netscaler to IdP to uniquely identify Netscaler.<br>Minimum length = 1
signaturealg<String>Read-writeAlgorithm to be used to sign/verify SAML transactions.<br>Default value: RSA-SHA1<br>Possible values = RSA-SHA1, RSA-SHA256
digestmethod<String>Read-writeAlgorithm to be used to compute/verify digest for SAML transactions.<br>Default value: SHA1<br>Possible values = SHA1, SHA256
audience<String>Read-writeAudience for which assertion sent by IdP is applicable. This is typically entity name or url that represents ServiceProvider.
nameidformat<String>Read-writeFormat of Name Identifier sent in Assertion.<br>Default value: transient<br>Possible values = Unspecified, emailAddress, X509SubjectName, WindowsDomainQualifiedName, kerberos, entity, persistent, transient
nameidexpr<String>Read-writeExpression that will be evaluated to obtain NameIdentifier to be sent in assertion.<br>Maximum length = 128
attribute1<String>Read-writeName of attribute1 that needs to be sent in SAML Assertion.
attribute1expr<String>Read-writeExpression that will be evaluated to obtain attribute1s value to be sent in Assertion.<br>Maximum length = 128
attribute1friendlyname<String>Read-writeUser-Friendly Name of attribute1 that needs to be sent in SAML Assertion.
attribute1format<String>Read-writeFormat of Attribute1 to be sent in Assertion.<br>Possible values = URI, Basic
attribute2<String>Read-writeName of attribute2 that needs to be sent in SAML Assertion.
attribute2expr<String>Read-writeExpression that will be evaluated to obtain attribute2s value to be sent in Assertion.<br>Maximum length = 128
attribute2friendlyname<String>Read-writeUser-Friendly Name of attribute2 that needs to be sent in SAML Assertion.
attribute2format<String>Read-writeFormat of Attribute2 to be sent in Assertion.<br>Possible values = URI, Basic
attribute3<String>Read-writeName of attribute3 that needs to be sent in SAML Assertion.
attribute3expr<String>Read-writeExpression that will be evaluated to obtain attribute3s value to be sent in Assertion.<br>Maximum length = 128
attribute3friendlyname<String>Read-writeUser-Friendly Name of attribute3 that needs to be sent in SAML Assertion.
attribute3format<String>Read-writeFormat of Attribute3 to be sent in Assertion.<br>Possible values = URI, Basic
attribute4<String>Read-writeName of attribute4 that needs to be sent in SAML Assertion.
attribute4expr<String>Read-writeExpression that will be evaluated to obtain attribute4s value to be sent in Assertion.<br>Maximum length = 128
attribute4friendlyname<String>Read-writeUser-Friendly Name of attribute4 that needs to be sent in SAML Assertion.
attribute4format<String>Read-writeFormat of Attribute4 to be sent in Assertion.<br>Possible values = URI, Basic
attribute5<String>Read-writeName of attribute5 that needs to be sent in SAML Assertion.
attribute5expr<String>Read-writeExpression that will be evaluated to obtain attribute5s value to be sent in Assertion.<br>Maximum length = 128
attribute5friendlyname<String>Read-writeUser-Friendly Name of attribute5 that needs to be sent in SAML Assertion.
attribute5format<String>Read-writeFormat of Attribute5 to be sent in Assertion.<br>Possible values = URI, Basic
attribute6<String>Read-writeName of attribute6 that needs to be sent in SAML Assertion.
attribute6expr<String>Read-writeExpression that will be evaluated to obtain attribute6s value to be sent in Assertion.<br>Maximum length = 128
attribute6friendlyname<String>Read-writeUser-Friendly Name of attribute6 that needs to be sent in SAML Assertion.
attribute6format<String>Read-writeFormat of Attribute6 to be sent in Assertion.<br>Possible values = URI, Basic
attribute7<String>Read-writeName of attribute7 that needs to be sent in SAML Assertion.
attribute7expr<String>Read-writeExpression that will be evaluated to obtain attribute7s value to be sent in Assertion.<br>Maximum length = 128
attribute7friendlyname<String>Read-writeUser-Friendly Name of attribute7 that needs to be sent in SAML Assertion.
attribute7format<String>Read-writeFormat of Attribute7 to be sent in Assertion.<br>Possible values = URI, Basic
attribute8<String>Read-writeName of attribute8 that needs to be sent in SAML Assertion.
attribute8expr<String>Read-writeExpression that will be evaluated to obtain attribute8s value to be sent in Assertion.<br>Maximum length = 128
attribute8friendlyname<String>Read-writeUser-Friendly Name of attribute8 that needs to be sent in SAML Assertion.
attribute8format<String>Read-writeFormat of Attribute8 to be sent in Assertion.<br>Possible values = URI, Basic
attribute9<String>Read-writeName of attribute9 that needs to be sent in SAML Assertion.
attribute9expr<String>Read-writeExpression that will be evaluated to obtain attribute9s value to be sent in Assertion.<br>Maximum length = 128
attribute9friendlyname<String>Read-writeUser-Friendly Name of attribute9 that needs to be sent in SAML Assertion.
attribute9format<String>Read-writeFormat of Attribute9 to be sent in Assertion.<br>Possible values = URI, Basic
attribute10<String>Read-writeName of attribute10 that needs to be sent in SAML Assertion.
attribute10expr<String>Read-writeExpression that will be evaluated to obtain attribute10s value to be sent in Assertion.<br>Maximum length = 128
attribute10friendlyname<String>Read-writeUser-Friendly Name of attribute10 that needs to be sent in SAML Assertion.
attribute10format<String>Read-writeFormat of Attribute10 to be sent in Assertion.<br>Possible values = URI, Basic
attribute11<String>Read-writeName of attribute11 that needs to be sent in SAML Assertion.
attribute11expr<String>Read-writeExpression that will be evaluated to obtain attribute11s value to be sent in Assertion.<br>Maximum length = 128
attribute11friendlyname<String>Read-writeUser-Friendly Name of attribute11 that needs to be sent in SAML Assertion.
attribute11format<String>Read-writeFormat of Attribute11 to be sent in Assertion.<br>Possible values = URI, Basic
attribute12<String>Read-writeName of attribute12 that needs to be sent in SAML Assertion.
attribute12expr<String>Read-writeExpression that will be evaluated to obtain attribute12s value to be sent in Assertion.<br>Maximum length = 128
attribute12friendlyname<String>Read-writeUser-Friendly Name of attribute12 that needs to be sent in SAML Assertion.
attribute12format<String>Read-writeFormat of Attribute12 to be sent in Assertion.<br>Possible values = URI, Basic
attribute13<String>Read-writeName of attribute13 that needs to be sent in SAML Assertion.
attribute13expr<String>Read-writeExpression that will be evaluated to obtain attribute13s value to be sent in Assertion.<br>Maximum length = 128
attribute13friendlyname<String>Read-writeUser-Friendly Name of attribute13 that needs to be sent in SAML Assertion.
attribute13format<String>Read-writeFormat of Attribute13 to be sent in Assertion.<br>Possible values = URI, Basic
attribute14<String>Read-writeName of attribute14 that needs to be sent in SAML Assertion.
attribute14expr<String>Read-writeExpression that will be evaluated to obtain attribute14s value to be sent in Assertion.<br>Maximum length = 128
attribute14friendlyname<String>Read-writeUser-Friendly Name of attribute14 that needs to be sent in SAML Assertion.
attribute14format<String>Read-writeFormat of Attribute14 to be sent in Assertion.<br>Possible values = URI, Basic
attribute15<String>Read-writeName of attribute15 that needs to be sent in SAML Assertion.
attribute15expr<String>Read-writeExpression that will be evaluated to obtain attribute15s value to be sent in Assertion.<br>Maximum length = 128
attribute15friendlyname<String>Read-writeUser-Friendly Name of attribute15 that needs to be sent in SAML Assertion.
attribute15format<String>Read-writeFormat of Attribute15 to be sent in Assertion.<br>Possible values = URI, Basic
attribute16<String>Read-writeName of attribute16 that needs to be sent in SAML Assertion.
attribute16expr<String>Read-writeExpression that will be evaluated to obtain attribute16s value to be sent in Assertion.<br>Maximum length = 128
attribute16friendlyname<String>Read-writeUser-Friendly Name of attribute16 that needs to be sent in SAML Assertion.
attribute16format<String>Read-writeFormat of Attribute16 to be sent in Assertion.<br>Possible values = URI, Basic
encryptassertion<String>Read-writeOption to encrypt assertion when Netscaler sends one.<br>Default value: OFF<br>Possible values = ON, OFF
samlspcertname<String>Read-writeName of the SSL certificate of peer/receving party using which Assertion is encrypted.<br>Minimum length = 1
encryptionalgorithm<String>Read-writeAlgorithm to be used to encrypt SAML assertion.<br>Default value: AES256<br>Possible values = DES3, AES128, AES192, AES256
skewtime<Double>Read-writeThis 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.<br>Default value: 5
__count<Double>Read-onlycount 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":{
      "name":<String_value>,
      "samlsigningcertname":<String_value>,
      "assertionconsumerserviceurl":<String_value>,
      "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>
}}

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":{
      "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>,
      "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>
}}

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":{
      "name":<String_value>,
      "samlsigningcertname":true,
      "sendpassword":true,
      "samlissuername":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
}}

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

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 errorResponse Headers:

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>
}]}

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

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 errorResponse Headers:

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>
}]}

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

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