Skip to content

authentication OAuthIdPPolicy

The following operations can be performed on "authentication OAuthIdPPolicy":

add| rm| set| unset| show| stat| rename

add authentication OAuthIdPPolicy

p{white-space: pre-wrap;}

Adds a OAuth Identity Provider (IdP) policy to use for use in authentication.

Synopsys

add authentication OAuthIdPPolicy <name> -rule <expression> -action <string> [-undefAction <string>] [-comment <string>] [-logAction <string>]

Arguments

name

Name for the OAuth Identity Provider (IdP) authentication policy. This is used for configuring Citrix ADC as OAuth Identity Provider. 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.

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 policy" or 'my policy').

rule

Expression that the policy uses to determine whether to respond to the specified request.

action

Name of the profile to apply to requests or connections that match this policy.

undefAction

Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition. Only DROP/RESET actions can be used.

comment

Any comments to preserve information about this policy.

logAction

Name of messagelog action to use when a request matches this policy.

rm authentication OAuthIdPPolicy

p{white-space: pre-wrap;}

Removes an existing OAuth Identity Provider (IdP) policy.

Synopsys

rm authentication OAuthIdPPolicy <name>

Arguments

name

Name of the authentication policy to remove.

set authentication OAuthIdPPolicy

p{white-space: pre-wrap;}

Modifies the specified parameters of an existing OAuth IdentityProvider (IdP) policy.

Synopsys

set authentication OAuthIdPPolicy <name> [-rule <expression>] [-action <string>] [-undefAction <string>] [-comment <string>] [-logAction <string>]

Arguments

name

Name of the OAuth Identity Provider (IdP) authentication policy to modify.

rule

Expression that the policy uses to determine whether to respond to the specified request.

action

Name of the profile to apply to requests or connections that match this policy.

undefAction

Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition. Only DROP/RESET actions can be used.

comment

Any comments to preserve information about this policy.

logAction

Name of messagelog action to use when a request matches this policy.

unset authentication OAuthIdPPolicy

p{white-space: pre-wrap;}

Removes the settings of an existing OAuth IdentityProvider (IdP) policy. Attributes for which a default value is available revert to their default values. See the set OAuthIdPPolicy command for a description of the parameters..Refer to the set authentication OAuthIdPPolicy command for meanings of the arguments.

Synopsys

unset authentication OAuthIdPPolicy <name> [-undefAction] [-comment] [-logAction]

Example

unset OAuthlIdpPolicy pol9 -undefAction

show authentication OAuthIdPPolicy

p{white-space: pre-wrap;}

Displays information about all configured OAuth Identity Provider (IdP) authentication policies, or displays detailed information about the specified policy.

Synopsys

show authentication OAuthIdPPolicy [<name>]

Arguments

name

Name of the OAuth IdentityProvider (IdP) policy for which to display detailed information.

Outputs

rule

The rule used by the OAuth Identity Provider (IdP) authentication policy. Rules are combinations of Expressions. Expressions are simple conditions, such as a test for equality, applied to operands, such as a URL string or an IP address. Expression syntax is described in the Installation and Configuration Guide

action

The action to be performed when the rule is matched.

stateflag

undefAction

Action to perform if the result of policy evaluation is undefined (UNDEF). An UNDEF event indicates an internal error condition. Only DROP/RESET actions can be used.

comment

Any comments to preserve information about this policy.

logAction

Name of messagelog action to use when a request matches this policy.

boundTo

The entity name to which policy is bound

activePolicy

priority

gotoPriorityExpression

Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.

hits

Number of hits.

bindPolicyType

vserverType

devno

count

stat authentication OAuthIdPPolicy

p{white-space: pre-wrap;}

Display OAUTH Identity Provider (IdP) policy statistics.

Synopsys

stat authentication OAuthIdPPolicy [<name>] [-detail] [-fullValues] [-ntimes <positive_integer>] [-logFile <input_filename>] [-clearstats ( basic | full )]

Arguments

name

The name of the OAuth Identity Provider (IdP) policy for which statistics will be displayed. If not given statistics are shown for all policies.

detail

Specifies detailed output (including more statistics). The output can be quite voluminous. Without this argument, the output will show only a summary.

fullValues

Specifies that numbers and strings should be displayed in their full form. Without this option, long strings are shortened and large numbers are abbreviated

ntimes

The number of times, in intervals of seven seconds, the statistics should be displayed.

Default value: 1

Minimum value: 0

logFile

The name of the log file to be used as input.

clearstats

Clear the statsistics / counters

Possible values: basic, full

Outputs

count

devno

stateflag

Outputs

Policy hits (Hits)

Number of hits on the policy

Policy undef hits (Undefhits)

Number of undef hits on the policy

Example

stat authentication oauthidppolicy.

rename authentication OAuthIdPPolicy

p{white-space: pre-wrap;}

Renames the specified OAuth IdentityProvider (IdP) policy. You must restart the Citrix ADC to put new name in effect.

Synopsys

rename authentication OAuthIdPPolicy <name>@ <newName>@

Arguments

name

Existing name of the OAuth IdentityProvider policy.

newName

New name for the OAuth IdentityProvider policy.

Must begin with a letter, number, or the underscore character (_), and must contain only letters, numbers, and the hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.

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 oauthidppolicy policy" or 'my oauthidppolicy policy').

Example

rename oauthidppolicy policy oldname newname