IClientFacade Interface

Provides information about an OAuth client.

Syntax

Unit: Sphinx.ClientFacade

IClientFacade = interface(IInterface);

Methods

Name	Description
GetClientId	Provides the client id.
GetDisplayName	The user-friendly name of the client, to be displayed in the UI when needed.
GetLogoUrl	Provides an URL to an image contaning the client logo.
GetLogoLinkUrl	Provides the URL to be followed when the end-user clicks the client logo in the UI.
GetClientAppUrl	Provides the URL of the client application for users to return to.
GetTermsOfServiceUrl	Provides an URL pointing to an HTML page showing the terms of the service for this client.
GetSupportUrl	Provides an URL pointing to an HTML page showing information about how to get support for this client.
GetFaviconUrl	Provides the URL of the image to be used as favicon in the login app page.
GetDefaultRedirectUri	Provides the default redirect URI to be used in case the authorization request doesn't include one.
IsValidRedirectUri	Validates the redirect URI sent in the authorization request.
IsSecretValid	Checks if the provided client secret is valid.
IsGrantTypeAllowed	Checks if this client allows the provided OAuth 2 grant type to be used.
DefaultScope	Indicates the scope to be allowed in the token in case the OAuth request doesn't provide one.
GetValidScope	Checks if the provided requested scope can be granted to the requester.
GetAuthorization​Code​Lifetime	When OAuth authorization code is created, this method is called as an opportunity to modify the code lifetime.
GetAccessToken​Lifetime	When an access token created, this method is called as an opportunity to modify the token lifetime.
GetIdentityToken​Lifetime	When an identity token created, this method is called as an opportunity to modify the token lifetime.
GetRefreshToken​Lifetime	When a refresh token created, this method is called as an opportunity to modify the token lifetime.
GetLoginTimeout	This method is called to modify the idle timeout value for the login app transaction.
GetLoginAbsolute​Timeout	This method is called to modify the absolute lifetime limit for the login app transaction.
GetParam	Returns a value for a custom named parameter.
RequirePkce	Indicates if PKCE will be required by this client when authorization code flow is used.
AllowPkcePlainMethod	Indicates if plain method (less secure) is allowed by the server when using PKCE.
RequireClientSecret	Indicates client authentication using secret is required to provide tokens.