The xkit Developer Hub

Welcome to the xkit developer hub. You'll find comprehensive guides and documentation to help you start working with xkit as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    


Authenticating users with FusionAuth

If you use FusionAuth to authenticate your users, you can use the same authentication to log users into Xkit to connect other apps to yours.


Scopes not supported

Xkit's token authentication does not validate the scopes field, so any valid token, regardless of scopes will be accepted.

To set up FusionAuth with Xkit, use the following steps:

  1. Log in to your FusionAuth admin screen.
  2. If you haven’t set up an RSA signing key, go to “Key Master” and generate a new RSA key.
  3. Go to “Tenants” and edit the tenant you wish to use with xkit.
  4. Navigate to the “JWT” tab and update the “Access Token signing key” and “ID Token signing key” to be the RSA key you just created (or an existing one).
  5. Navigate to the “General” tab and update or note the “Issuer” value. This is your “iss” claim.
  6. Navigate to the “Applications” section.
  7. Create a new application, if needed.
  8. Note the application id. This is your “aud” claim.
  9. Click on Settings in the left sidebar of the Xkit dashboard and scroll down to "User Tokens".
  10. Click "Add Custom Issuer".
  11. For the "iss Claim", use the value you found in #5 (for example: example.com).
  12. For the "aud Claim", use the API Identifier you noted in #8.
  13. For the "User ID Claim", keep it as sub to use the standard FusionAuth identifier, or if you have included your User ID as a separate, custom claim, input that field here.
  14. For the "JSON Web Key Set URL", use the value https://<YOUR_DOMAIN>/.well-known/jwks.json where <YOUR_DOMAIN> is the hostname of your FusionAuth instance.
  15. Click "Save".

Your Xkit installation will now be able to use your FusionAuth ID tokens to login to Xkit.

User Groups

To take advantage of the User Groups feature, you'll need add a custom claim to your FusionAuth tokens indicating the group that your user belongs to. You can then supply that claim as the "Group ID Claim".

Updated 7 months ago


Authenticating users with FusionAuth

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.