OAuth template files

These files support OAuth.

OAuth template files

These files support OAuth. For more information, see OAuth 2.0 and OIDC Support.

Table 1. Default files in the oauth20/ directory
Page name	File name and macros	Description
OAuth 2.0 Trusted Clients Manager	oauth20/clients_manager.html Macros: @USERNAME@ @OAUTH_CLIENT_COMPANY_NAME@ @PERMITTED_SCOPES@ @OAUTH_CUSTOM_MACRO@	Used by resource owners to show and manage trusted clients information.
OAuth 2.0 - Consent to Authorize	oauth20/user_consent.html Macros: @USERNAME@ @OAUTH_CLIENT_COMPANY_NAME@ @PERMITTED_SCOPES@ @OAUTH_CUSTOM_MACRO@	Used by the authorization server to determine and store user consent information about which OAuth clients are authorized to access the protected resource. The page also lists of scopes that the OAuth client requests. These lists are shown in the consent page and can be of indeterminate length. The template supports multiple copies of stanzas that are repeated once for each scope in the lists.
OAuth 2.0 - Error	oauth20/user_error.html Macros: @OAUTH_CLIENT_COMPANY_NAME@ @CLIENT_TYPE@ @CLIENT_ID@ @REDIRECT_URI@ @STATE@ @RESPONSE_TYPE@ @USERNAME@ @OAUTH_TOKEN_SCOPE_REPEAT@ @OAUTH_OTHER_PARAM_REPEAT@ @OAUTH_OTHER_PARAM_VALUE_REPEAT@	Shows detailed text information when an error occurs in an OAuth 2.0 flow.
OAuth - Response	oauth20/user_response.html Macros: @OAUTH_CODE@	Displays the authorization code of an OAuth client that did not specify a client redirection URI upon registration. When the OAuth client does not specify a client redirection URI or cannot receive redirects, the authorization server does not know where to send the resource owner after authorization. As a result, the OAuth client does not receive the authorization code that is required to exchange for an access token or refresh token. The page includes several codes: The authorization code that the resource owner can provide to the trusted OAuth client. The authorization code as machine-readable Quick Response (QR) code. Note: The encoder that creates the QR code follows the ISO/IEC 18004:2006 specification. Scanners that support this specification can read the generated QR code.