Create Your First Client

To create a new client:#

1. Sign in: Navigate to https://dashboard.truevault.com.au/ and sign in with your credentials. (Use https://dashboard.sandbox.truevault.com.au/ for sandbox access)

2. Settings Once logged in, hover over Settings in the main menu.

3. OIDC Clients: Click on OAuth OIDC Clients from the drop down.

4. Add a new Client configuration: Under the OAuth Clients section (first on the page), click Create a New Client.

Configuration Guidance#

• Client Name is only shown to you internally, so you can stay organised

• Default Purpose is shown to the end user when requesting permission to share some of their data

• Enabled Rulesets are all the different rulesets that can be requested using the ruleset paramter in the authorization request

  • If a ruleset is requested and not enabled, the authorization flow will return an error

  • The string shown in quare brackets at the end of each option [like_so] is the string to use in authorization requests

• Default Ruleset is the ruleset that will apply when no ruleset argument is present in the authorization request

  • This must be one of the enabled rulesets, as above

• Scopes vary by use-case.

  • For a siple human check and no personal details you can use simply openid

  • For a complete user onboarding, select openid, email, phone and profile

  • If using the service as a login/authentication solution, select offline_access, along with the above

  • Note that address is not used in the current version

• Grants will require a minimum of authorization_code.

  • Add refresh_token if using for session management or repeats use

  • client_credentials and password are currently unused

• Token endpoint should be Cient secret basic, unless you understand how to use secret post, and have a need to do so

• Allowed redirect URLs should include the callback URL for your OAuth integration

• Allowed logout URLs is optional, and used to ensure a session logout event goes to an approved URL after logout

Quick Links#

• https://dashboard.truevault.com.au/no-code/oidc (production)

• https://dashboard.sandbox.truevault.com.au/no-code/oidc (sandbox)