Documentation/Studio
Back
  • Getting started
    • Key concepts
    • Sign in
    • Create and switch organisations
  • Registers
    • Create and change a register
    • Upload and download entries
    • Add, edit and deactivate entries
    • Groups
    • Challenge codes
    • Connect and test an external register
    • Register activity
  • Membership definition
    • Add and order register assignments
    • Filters and outcomes
    • Preview and test before saving
    • Save and version history
  • Communities
    • Create, rename and delete a community
    • Filter by register, status, groups and claims
  • Members directory
    • Find a member
    • Look up the checks of a member code
    • Deactivate a membership
  • Frontends
    • Create a frontend
    • Frontend keys
    • Sign-in settings
    • Sign-in branding
  • Login with appsolut
    • Sign-up and onboarding
    • Sign-in and sign-out
    • Support requests
  • Frontend users
    • Find a frontend user
    • Membership and activations
    • Block a frontend user
    • Export a frontend user's data
    • Disconnect a frontend
  • Membership check
    • Check modes
    • Results and the check log
    • Rate limits
    • Grace rule
  • Organisation settings
    • Organisation profile
    • Studio users and roles
    • Billing
    • Roadmap and feature requests

Frontend keys

Issue, rotate and revoke the keys a frontend's backend uses to call the Studio.

Studio roles: "Owner", "Administrator" and "Frontend manager".

A frontend key is a secret your organisation issues to one frontend, so that the frontend's own backend can call the Studio without a signed-in user. The backend sends the key with every call, for example when it asks whether an applicant is an eligible member. A frontend has at most two active keys, so you can switch to a new key without downtime.

If you use multi-factor authentication, issuing and revoking a key needs a session confirmed with your second factor. If the Studio refuses, sign out and sign in again with it.

Issue a key

  1. Open "Frontends" and choose the frontend.
  2. Under "Keys", choose "Issue key".
  3. The dialog "Your new key" shows the "Frontend key". Choose "Copy" and store the key in the frontend's backend, for example in its secret configuration.
  4. Choose "I have stored the key".

The key is shown only once. The Studio keeps only its first characters, which the list shows under "Key" with "Created by", "Created" and "Last used". If you lose a key, issue a new one and revoke the old one.

Rotate a key without downtime

  1. Issue a second key.
  2. Switch the frontend's backend to the new key and deploy it.
  3. Check under "Last used" that the old key is no longer used.
  4. Revoke the old key.

With two active keys, "Issue key" is unavailable until you revoke one.

Revoke a key

  1. Under "Keys", choose "Revoke" next to the key.
  2. The dialog shows when the key was last used. Choose "Revoke key".

The key stops working at once: from the next request on, the frontend's backend is refused with it. A revoked key cannot be restored.

A disconnected frontend's keys are refused too, and work again once you reconnect it.