Developer Documentation
ADC CLI Commands
Current Release 13.1 13.0 12.1

authentication-OAuthIDPProfile

June 28, 2023
Contributed by: 
C

The following operations can be performed on “authentication-OAuthIDPProfile”:

unset show set rm add

unset authentication OAuthIDPProfile

Use this command to remove authentication OAuthIDPProfile settings.Refer to the set authentication OAuthIDPProfile command for meanings of the arguments.

Synopsis

unset authentication OAuthIDPProfile [-issuer] [-audience] [-skewTime] [-defaultAuthenticationGroup] [-relyingPartyMetadataURL] [-refreshInterval] [-encryptToken] [-sendPassword] [-Attributes]

show authentication OAuthIDPProfile

Displays information about all configured OAuth IdP profiles, or displays detailed information about the specified action.

Synopsis

show authentication OAuthIDPProfile []

Arguments

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’).

Output

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 fromCitrix ADC to IdP to uniquely identify Citrix ADC.

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.

defaultAuthenticationGroup 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 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.

encryptToken Option to encrypt token when Citrix ADC IDP sends one.

OAuthStatus Describes status information of oauth idp metadata fetch process.

sendPassword Option to send encrypted password in idtoken.

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.

devno count stateflag

set authentication OAuthIDPProfile

Modifies the specified attributes of a OAuth IdP profile.

Synopsis

set authentication OAuthIDPProfile \[-clientID ] \[-clientSecret ] \[-redirectURL ] \[-issuer ] \[-audience ] \[-skewTime ] \[-defaultAuthenticationGroup ] \[-relyingPartyMetadataURL ] \[-refreshInterval <positive\_integer>] \[-encryptToken \( ON | OFF )] \[-sendPassword \( ON | OFF )] \[-Attributes ]

Arguments

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’).

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 fromCitrix ADC to IdP to uniquely identify Citrix ADC.

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 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 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 Minimum value: 0

encryptToken Option to encrypt token when Citrix ADC IDP sends one.

Possible values: ON, OFF Default value: OFF

sendPassword Option to send encrypted password in idtoken.

Possible values: ON, OFF Default value: OFF

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.

rm authentication OAuthIDPProfile

Deletes an existing OAuth IdP profile.

Synopsis

rm authentication OAuthIDPProfile

Arguments

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’).

add authentication OAuthIDPProfile

Creates a OAuth IdP profile. This profile is used in verifying incoming authentication request from Reousece Server, and sending token.

Synopsis

add authentication OAuthIDPProfile \[-clientID ] \[-clientSecret ] \[-redirectURL ] \[-issuer ] \[-audience ] \[-skewTime ] \[-defaultAuthenticationGroup ] \[-relyingPartyMetadataURL ] \[-refreshInterval <positive\_integer>] \[-encryptToken \( ON | OFF )] \[-sendPassword \( ON | OFF )] \[-Attributes ]

Arguments

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’).

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 fromCitrix ADC to IdP to uniquely identify Citrix ADC.

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 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 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 Minimum value: 0

encryptToken Option to encrypt token when Citrix ADC IDP sends one.

Possible values: ON, OFF Default value: OFF

sendPassword Option to send encrypted password in idtoken.

Possible values: ON, OFF Default value: OFF

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.

authentication-OAuthIDPProfile
June 28, 2023
Contributed by: 
C
June 28, 2023
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.