Home > Configuration > Authentication > addauthenticationoauthidpprofile

addauthenticationoauthidpprofile

Use this method to creates a OAuth IdP profile. This profile is used in verifying incoming authentication request from Reousece Server, and sending token.

Syntax



Parameters

name

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').
This is mandatory parameter.

clientid

Unique identity of the relying party requesting for authentication.

clientsecret

Unique secret string to authorize relying party at authorization server.

redirecturl

URL endpoint on relying party to which the OAuth token is to be sent.

issuer

The name to be used in requests sent from Citrix ADC to IdP to uniquely identify Citrix ADC.

configservice

Name of the entity that is used to obtain configuration for the current authentication request. It is used only in Citrix Cloud.

audience

Audience for which token is being sent by Citrix ADC IdP. This is typically entity name or url that represents the recipient

skewtime

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

This group will be part of AAA session's internal group list. This will be helpful to admin in Nfactor flow to decide right AAA configuration for Relaying Party. In authentication policy AAA.USER.IS_MEMBER_OF("") is way to use this feature.

relyingpartymetadataurl

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

Interval at which Relying Party metadata is refreshed.
Default value = 50.

encrypttoken

Option to encrypt token when Citrix ADC IDP sends one.
Default value = OFF.

signatureservice

Name of the service in cloud used to sign the data. This is applicable only if signature if offloaded to cloud.

signaturealg

Algorithm to be used to sign OpenID tokens.
Default value = OAUTH_RSA_SHA256.

attributes

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

Option to send encrypted password in idtoken.
Default value = OFF.

Return Value

Returns simpleResult

See Also