Skip to main content

Configure the Desk application

Login with credential​

The Desk API can be configured to enable users to log in using a credential. This creates a password-free login experience for Desk users.

The following conditions must be true before the user can use a credential to log in to the Desk:

  • The Desk instance includes an OpenID Bridge license. See the product page.
  • Bridge has been integrated. See the integration guide.
  • The Desk API is configured to enable credential login. This is described here.
  • The user has enabled credential login via the profile endpoint and has accepted the issued credential into their digital wallet. See the Desk authentication page.

To configure the system to enable users to log in with a credential, add an entry for login to the application.yaml and provide basic parameters for issuing the login credential:

login:
  url: ${{YOUR-FRONTEND-URL}}/login   // Your login url
  credential:
    enabled: true                     // If true, enables users to use the login with credential feature
    issuerDid: {{UUID}}               // Specify the DID from which the login credential will be issued
    exchange: OPENID4VC
    credentialSchemaId: {{UUID}}      // Specify the schema of the credential that will be issued
    emailPath: email                  // Key of email claim

The login.credential entry determines which credential will be issued to Desk users and how. Since email is the only claim used for logging in to the Desk with a credential, it is recommended to create a new credential schema with email as the only claim.