OAuthClient Component

Properties Methods Events Configuration Settings Errors

The OAuthClient component implements interaction between the client, the resource owner (end-user), and the authorization server via OAuth 2.0 protocol.

Syntax

TsbxOAuthClient

Remarks

OAuthClient implements interaction between the client (an application that needs access to a protected resource), the resource owner (end-user), and the authorization server via OAuth 2.0 (RFC 6749) protocol.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.


AccessToken	Contains the access token.
AuthURL	Specifies the URL of the authorization server.
AutoRefresh	Specifies whether access token should be automatically refreshed.
BlockedCertificates	The certificates that must be rejected as trust anchors.
ClientChain	The TLS client certificate chain.
ClientID	Client ID of the application which needs access to the protected resource.
ClientSecret	Client secret of the application which needs access to the protected resource.
ConnectionInfo	Returns the details of the underlying network connection.
CustomParameters	Contains custom parameters of the authorization request.
ExpiresAt	The expiration time of access token.
ExpiresIn	Returns access token lifetime in seconds.
ExternalCrypto	Provides access to external signing and DC parameters.
FailureResponse	The web page showed to the user by the component on authorization failure.
GrantType	Specifies which protocol flow should be used to authorize the user.
KeepAlivePolicy	Defines the keep-alive handling policy.
KnownCertificates	Additional certificates for chain validation.
KnownCRLs	Additional CRLs for chain validation.
KnownOCSPs	Additional OCSP responses for chain validation.
Password	The connecting user's authentication password.
Proxy	The proxy server settings.
RedirectURL	The URL where the user is redirected after authorization.
RefreshToken	The refresh token, to be used to automatically obtain new access token.
Scope	The scope of the request to be authorized.
ServerChain	The TLS server's certificate chain.
SocketSettings	Manages network connection settings.
State	Specifies the state parameter of the authorization request or response.
SuccessResponse	The web page showed to the user by the component on authorization success.
Timeout	Specifies waiting timeout (in milliseconds).
TLSSettings	Manages TLS layer settings.
TokenType	Returns the access token type.
TokenURL	Specifies the URL of the token endpoint.
TrustedCertificates	A list of trusted certificates for chain validation.
Username	The connecting user's username (login name).

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.


Authorize	Performs user authorization and gets an access token.
Config	Sets or retrieves a configuration setting.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.


CertificateValidate	Fires when the server's TLS certificate has to be validated.
Error	Provides information about errors during authorization operations.
ExternalSign	Handles remote or external signing initiated by the SignExternal method or other source.
LaunchBrowser	Fires to show the login page to the end-user.
Wait	Fired periodically to show how much waiting time is left.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.


CacheControl	Optional value for Cache-Control HTTP header field.
IDToken	ID Token parameter for JWT.
IgnoreSystemTrust	Whether trusted Windows Certificate Stores should be treated as trusted.
PKCEMode	Proof Key for Code Exchange method to use.
TolerateMinorChainIssues	Whether to tolerate minor chain issues.
UseMicrosoftCTL	Enables or disables automatic use of Microsoft online certificate trust list.
UseSystemCertificates	Enables or disables the use of the system certificates.
CheckKeyIntegrityBeforeUse	Enables or disable private key integrity check before use.
CookieCaching	Specifies whether a cookie cache should be used for HTTP(S) transports.
Cookies	Gets or sets local cookies for the component (supported for HTTPClient, RESTClient and SOAPClient only).
DefDeriveKeyIterations	Specifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHE	Enables or disables finite field DHE key exchange support in TLS clients.
GlobalCookies	Gets or sets global cookies for all the HTTP transports.
HttpUserAgent	Specifies the user agent name to be used by all HTTP clients.
LogDestination	Specifies the debug log destination.
LogDetails	Specifies the debug log details to dump.
LogFile	Specifies the debug log filename.
LogFilters	Specifies the debug log filters.
LogFlushMode	Specifies the log flush mode.
LogLevel	Specifies the debug log level.
LogMaxEventCount	Specifies the maximum number of events to cache before further action is taken.
LogRotationMode	Specifies the log rotation mode.
MaxASN1BufferLength	Specifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepth	Specifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithm	Specifies the hash algorithm to be used to identify certificates in OCSP requests.
UseOwnDNSResolver	Specifies whether the client components should use own DNS resolver.
UseSharedSystemStorages	Specifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSS	Enforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandom	Enables or disables the use of the OS PRNG.