Download full document:

authenticationoauthaction

Configuration for OAuth authentication action resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
name<String>Read-writeName for the OAuth Authentication 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 the profile is created. The following requirement applies only to the NetScaler 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).<br>Minimum length = 1
authorizationendpoint<String>Read-writeAuthorization endpoint/url to which unauthenticated user will be redirected. Netscaler appliance redirects user to this endpoint by adding query parameters including clientid.
tokenendpoint<String>Read-writeURL to which OAuth token will be posted to verify its authenticity. User obtains this token from Authorization server upon successful authentication. Netscaler appliance will validate presented token by posting it to the URL configured.
idtokendecryptendpoint<String>Read-writeURL to which obtained idtoken will be posted to get a decrypted user identity. Encrypted idtoken will be obtained by posting OAuth token to token endpoint. In order to decrypt idtoken, Netscaler appliance posts request to the URL configured.
clientid<String>Read-writeUnique identity of the client/user who is getting authenticated. Authorization server infers client configuration using this ID.
clientsecret<String>Read-writeSecret string established by user and authorization server.
defaultauthenticationgroup<String>Read-writeThis is the default group that is chosen when the authentication succeeds in addition to extracted groups.
attribute1<String>Read-writeExpression that would be evaluated to extract attribute1 from the oauth response.
attribute2<String>Read-writeExpression that would be evaluated to extract attribute2 from the oauth response.
attribute3<String>Read-writeExpression that would be evaluated to extract attribute3 from the oauth response.
attribute4<String>Read-writeExpression that would be evaluated to extract attribute4 from the oauth response.
attribute5<String>Read-writeExpression that would be evaluated to extract attribute5 from the oauth response.
attribute6<String>Read-writeExpression that would be evaluated to extract attribute6 from the oauth response.
attribute7<String>Read-writeExpression that would be evaluated to extract attribute7 from the oauth response.
attribute8<String>Read-writeExpression that would be evaluated to extract attribute8 from the oauth response.
attribute9<String>Read-writeExpression that would be evaluated to extract attribute9 from the oauth response.
attribute10<String>Read-writeExpression that would be evaluated to extract attribute10 from the oauth response.
attribute11<String>Read-writeExpression that would be evaluated to extract attribute11 from the oauth response.
attribute12<String>Read-writeExpression that would be evaluated to extract attribute12 from the oauth response.
attribute13<String>Read-writeExpression that would be evaluated to extract attribute13 from the oauth response.
attribute14<String>Read-writeExpression that would be evaluated to extract attribute14 from the oauth response.
attribute15<String>Read-writeExpression that would be evaluated to extract attribute15 from the oauth response.
attribute16<String>Read-writeExpression that would be evaluated to extract attribute16 from the oauth response.
__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://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"authenticationoauthaction":{
      "name":<String_value>,
      "authorizationendpoint":<String_value>,
      "tokenendpoint":<String_value>,
      "idtokendecryptendpoint":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<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>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/authenticationoauthaction/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/authenticationoauthaction/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload: 

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"authenticationoauthaction":{
      "name":<String_value>,
      "authorizationendpoint":<String_value>,
      "tokenendpoint":<String_value>,
      "idtokendecryptendpoint":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<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>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"authenticationoauthaction":{
      "name":<String_value>,
      "idtokendecryptendpoint":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,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/authenticationoauthaction

Query-parameters:

filter

http://<NSIP>/nitro/v1/config/authenticationoauthaction?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<NS_IP>/nitro/v1/config/authenticationoauthaction?view=summary

Use this query-parameter to get the summary output of authenticationoauthaction resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/authenticationoauthaction?pagesize=#no;pageno=#no

Use this query-parameter to get the authenticationoauthaction resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/authenticationoauthaction?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "authenticationoauthaction": [ {
      "name":<String_value>,
      "authorizationendpoint":<String_value>,
      "tokenendpoint":<String_value>,
      "idtokendecryptendpoint":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<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>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/authenticationoauthaction/name_value<String>

HTTP Method: GET

Response Payload: 

{ "errorcode": 0, "message": "Done", "authenticationoauthaction": [ {
      "name":<String_value>,
      "authorizationendpoint":<String_value>,
      "tokenendpoint":<String_value>,
      "idtokendecryptendpoint":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<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>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/authenticationoauthaction?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",authenticationoauthaction: [ { "__count": "#no"} ] }