getauthenticationoauthactionResult Structure Definition

The getauthenticationoauthactionResult structure defines the return type for getauthenticationoauthaction API.

Syntax



Members

rc

If the method succeeds, rc is 0 else rc > 0. Values above 0x8000 indicate Warnings.

message

If the method succeeds, message is NULL else message contains Error/Warning message.

authenticationoauthactionList

List of authenticationoauthactions


authenticationoauthaction Structure Definition

The authenticationoauthaction structure defines the actual return type values for getauthenticationoauthaction API.

Syntax



Members

name

Name of the OAuth authentication action to display.

authorizationendpoint

Authorization endpoint/url to which unauthenticated user will be redirected. Citrix ADC redirects user to this endpoint by adding query parameters including clientid. If this parameter not specified then as default value we take Token Endpoint/URL value. Please note that Authorization Endpoint or Token Endpoint is mandatory for oauthAction

tokenendpoint

URL to which OAuth token will be posted to verify its authenticity. User obtains this token from Authorization server upon successful authentication. Citrix ADC will validate presented token by posting it to the URL configured

idtokendecryptendpoint

URL 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, Citrix ADC posts request to the URL configured

clientid

Unique identity of the client/user who is getting authenticated. Authorization server infers client configuration using this ID

clientsecret

Secret string established by user and authorization server

defaultauthenticationgroup

This is the default group that is chosen when the authentication succeeds in addition to extracted groups.

oauthmiscflags

Option to set/unset miscellaneous feature flags. Available values function as follows: * Base64Encode_Authorization_With_Padding - On setting this value, for endpoints (token and introspect), basic authorization header will be base64 encoded with padding. * EnableJWTRequest - By enabling this field, Authorisation request to IDP will have jwt signed 'request' parameter

attribute1

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute1

attribute2

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute2

attribute3

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute3

attribute4

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute4

attribute5

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute5

attribute6

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute6

attribute7

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute7

attribute8

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute8

attribute9

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute9

attribute10

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute10

attribute11

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute11

attribute12

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute12

attribute13

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute13

attribute14

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute14

attribute15

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute15

attribute16

Name of the attribute to be extracted from OAuth Token and to be stored in the attribute16

attributes

List of attribute names separated by ',' which needs to be extracted. Note that preceding and trailing spaces will be removed. Attribute name can be 127 bytes and total length of this string should not cross 1023 bytes. These attributes have multi-value support separated by ',' and stored as key-value pair in AAA session

tenantid

TenantID of the application. This is usually specific to providers such as Microsoft and usually refers to the deployment identifier.

graphendpoint

URL of the Graph API service to learn Enterprise Mobility Services (EMS) endpoints.

refreshinterval

Interval at which services are monitored for necessary configuration.

certendpoint

URL of the endpoint that contains JWKs (Json Web Key) for JWT (Json Web Token) verification.

oauthtype

Type of the OAuth implementation. Default value is generic implementation that is applicable for most deployments.

audience

Audience for which token sent by Authorization server is applicable. This is typically entity name or url that represents the recipient

usernamefield

Attribute in the token from which username should be extracted.

skewtime

This option specifies the allowed clock skew in number of minutes that Citrix ADC allows on an incoming token. 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.

issuer

Identity of the server whose tokens are to be accepted.

oauthstatus

Describes status information of oauth server.

userinfourl

URL to which OAuth access token will be posted to obtain user information.

certfilepath

Path to the file that contains JWKs (Json Web Key) for JWT (Json Web Token) verification.

granttype

Grant type support. value can be code or password

authentication

If authentication is disabled, password is not sent in the request.

introspecturl

URL to which access token would be posted for validation

allowedalgorithms

Multivalued option to specify allowed token verification algorithms.

pkce

Option to enable/disable PKCE flow during authentication.

tokenendpointauthmethod

Option to select the variant of token authentication method. This method is used while exchanging code with IdP.

metadataurl

Well-known configuration endpoint of the Authorization Server. Citrix ADC fetches server details from this endpoint.

resourceuri

Resource URL for Oauth configuration.

requestattribute

Name-Value pairs of attributes to be inserted in request parameter. 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.

intunedeviceidexpression

The expression that will be evaluated to obtain IntuneDeviceId for compliance check against IntuneNAC device compliance endpoint. The expression is applicable when the OAuthType is INTUNE. The maximum length allowed to be used as IntuneDeviceId for the device compliance check from the computed response after the expression evaluation is 41. Examples: add authentication oauthAction -intuneDeviceIdExpression 'AAA.LOGIN.INTUNEURI.AFTER_STR("IntuneDeviceId://")'

_nextgenapiresource


See Also