Skip to main content

Identity providers configuration | Templates edition

Identity provider templates are to be seen by the end-user, they are editable using Mustache templating engine helping to get access to global and page-specific variables. You can at any moment reset your changes to go back to a default template. User navigation help going through the customized templates giving the best user experience.

Parameters sections

Identity providers can be customized through either the Administration API or the user interface providing 2 categories of settings:

  • General configuration
  • Templates edition
  • Features

Global templates variables​

{federated server name}.login_url gives the login URL in case of identity federation helping to implement "login with" button. That variable is associated with the configuration of a federated server.

messages gives the server messages array having for each of them type and content attributes.

_csrf_token gives the anti request forgery token that is to be sent along with each end-user form.

errors gives the current errors array having for each of them a message attribute.

client gives the current client associated to the request, it has all the corresponding client attributes.

The server URL that the end-user can navigate to​

delete_user_session_path accessible through DELETE

edit_user_path accessible through GET

destroy_user_path accessible through POST

new_user_totp_registration_path accessible through GET

create_user_totp_registration_path accessible through POST

new_user_webauthn_registration_path accessible through GET

create_user_webauthn_registration_path accessible through POST

new_user_registration_path accessible through GET

new_user_reset_password_path accessible through GET

new_user_session_path accessible through GET

update_user_reset_password_path accessible through POST

update_user_path accessible through POST

Identity provider configurations​

registrable? equals to true if the identity provider user registration feature is enabled.

totpable? equals to true if the identity provider Time base One Time Password feature is enabled.

user_editable? equals to true if the identity provider user edition feature is enabled.

Page specific variables​

current_user the current user object navigating on the interface. The username, webauthn_registered_at, totp_registered_at and metadata attributes are exposed.

client the current oauth client the user is navigating to. The name attribute is exposed.

scopes the list of requested scopes objects. The name, label and public attributes are exposed.

webauthn_options the webauthn option to be given to given to the browser API. The rp, user, challenge, credential_id and publicKeyCredParams attributes are exposed.

base64_credential_offer_qr_code the base64 encoded credential offer QR code image.

credential_offer_deeplink the credential offer deeplink text.

base64_presentation_qr_code the base64 encoded verifiable presentation QR code image.

presentation_deeplink the verifiable presentation deeplink text.

code the credential offer or verifiable presentation code used to trigger presentation server sent events.