ADC NITRO APIs

authenticationoauthidpprofile

August 17, 2023

Contributed by:

Configuration for OAuth Identity Provider (IdP) profile resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name for the new OAuth Identity Provider (IdP) 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 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
clientid	Read-write	Unique identity of the relying party requesting for authentication. Minimum length = 1
clientsecret	Read-write	Unique secret string to authorize relying party at authorization server. Minimum length = 1
redirecturl	Read-write	URL endpoint on relying party to which the OAuth token is to be sent. Minimum length = 1
issuer	Read-write	The name to be used in requests sent from Citrix ADC to IdP to uniquely identify Citrix ADC. Minimum length = 1
configservice	Read-write	Name of the entity that is used to obtain configuration for the current authentication request. It is used only in Citrix Cloud. Minimum length = 1
audience	Read-write	Audience for which token is being sent by Citrix ADC IdP. This is typically entity name or url that represents the recipient.
skewtime	Read-write	This option specifies the duration for which the token sent by Citrix ADC IdP is valid. For example, if skewTime is 10, then token would be valid from (current time - 10) min to (current time + 10) min, ie 20min in all. Default value: 5
defaultauthenticationgroup	Read-write	This is the group that is added to user sessions that match current IdP policy. It can be used in policies to identify relying party trust.
relyingpartymetadataurl	Read-write	This is the endpoint at which Citrix ADC IdP can get details about Relying Party (RP) being configured. Metadata response should include endpoints for jwks_uri for RP public key(s).
refreshinterval	Read-write	Interval at which Relying Party metadata is refreshed. Default value: 50
encrypttoken	Read-write	Option to encrypt token when Citrix ADC IDP sends one. Default value: OFF Possible values = ON, OFF
signatureservice	Read-write	Name of the service in cloud used to sign the data. This is applicable only if signature if offloaded to cloud. Minimum length = 1
signaturealg	Read-write	Algorithm to be used to sign OpenID tokens. Default value: RS256 Possible values = RS256, RS512
attributes	Read-write	Name-Value pairs of attributes to be inserted in idtoken. Configuration format is name=value_expr@@@name2=value2_expr@@@. ’@@@’ is used as delimiter between Name-Value pairs. name is a literal string whose value is 127 characters and does not contain ‘=’ character. Value is advanced policy expression terminated by @@@ delimiter. Last value need not contain the delimiter.
sendpassword	Read-write	Option to send encrypted password in idtoken. Default value: OFF Possible values = ON, OFF
oauthstatus	Read-only	Describes status information of oauth idp metadata fetch process. Default value: INIT Possible values = INIT, CERTFETCH, AADFORGRAPH, GRAPH, AADFORMDM, MDMINFO, COMPLETE
__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/authenticationoauthidpprofile

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"authenticationoauthidpprofile":{
<b>      "name":<String_value>,
</b>      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "redirecturl":<String_value>,
      "issuer":<String_value>,
      "configservice":<String_value>,
      "audience":<String_value>,
      "skewtime":<Double_value>,
      "defaultauthenticationgroup":<String_value>,
      "relyingpartymetadataurl":<String_value>,
      "refreshinterval":<Double_value>,
      "encrypttoken":<String_value>,
      "signatureservice":<String_value>,
      "signaturealg":<String_value>,
      "attributes":<String_value>,
      "sendpassword":<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/authenticationoauthidpprofile/ 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/authenticationoauthidpprofile

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"authenticationoauthidpprofile":{
<b>      "name":<String_value>,
</b>      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "redirecturl":<String_value>,
      "issuer":<String_value>,
      "configservice":<String_value>,
      "audience":<String_value>,
      "skewtime":<Double_value>,
      "defaultauthenticationgroup":<String_value>,
      "relyingpartymetadataurl":<String_value>,
      "refreshinterval":<Double_value>,
      "encrypttoken":<String_value>,
      "signatureservice":<String_value>,
      "signaturealg":<String_value>,
      "attributes":<String_value>,
      "sendpassword":<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/authenticationoauthidpprofile? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"authenticationoauthidpprofile":{
<b>      "name":<String_value>,
</b>      "issuer":true,
      "configservice":true,
      "audience":true,
      "skewtime":true,
      "defaultauthenticationgroup":true,
      "relyingpartymetadataurl":true,
      "refreshinterval":true,
      "encrypttoken":true,
      "signatureservice":true,
      "signaturealg":true,
      "attributes":true,
      "sendpassword":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/authenticationoauthidpprofile

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/authenticationoauthidpprofile? 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/authenticationoauthidpprofile? filter=property-name1:property-val1,property-name2:property-val2

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

view

http:// <netscaler-ip-address> /nitro/v1/config/authenticationoauthidpprofile? view=summary

Use this query-parameter to get the summary output of authenticationoauthidpprofile 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/authenticationoauthidpprofile? pagesize=#no;pageno=#no

Use this query-parameter to get the authenticationoauthidpprofile 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:

{ "authenticationoauthidpprofile": [ {
      "name":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "redirecturl":<String_value>,
      "issuer":<String_value>,
      "configservice":<String_value>,
      "audience":<String_value>,
      "skewtime":<Double_value>,
      "defaultauthenticationgroup":<String_value>,
      "relyingpartymetadataurl":<String_value>,
      "refreshinterval":<Double_value>,
      "encrypttoken":<String_value>,
      "signatureservice":<String_value>,
      "signaturealg":<String_value>,
      "oauthstatus":<String_value>,
      "attributes":<String_value>,
      "sendpassword":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationoauthidpprofile/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/authenticationoauthidpprofile/ 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/authenticationoauthidpprofile/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of authenticationoauthidpprofile 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:

{  "authenticationoauthidpprofile": [ {
      "name":<String_value>,
      "clientid":<String_value>,
      "clientsecret":<String_value>,
      "redirecturl":<String_value>,
      "issuer":<String_value>,
      "configservice":<String_value>,
      "audience":<String_value>,
      "skewtime":<Double_value>,
      "defaultauthenticationgroup":<String_value>,
      "relyingpartymetadataurl":<String_value>,
      "refreshinterval":<Double_value>,
      "encrypttoken":<String_value>,
      "signatureservice":<String_value>,
      "signaturealg":<String_value>,
      "oauthstatus":<String_value>,
      "attributes":<String_value>,
      "sendpassword":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/authenticationoauthidpprofile? 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:

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

authenticationoauthidpprofile

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

authenticationoauthidpprofile

Properties

Operations

add

delete

update

unset

get (all)

get

count

In this article