Types of auth links
Caylex supports two types of auth links, corresponding to the two levels of server authentication:User auth links
User auth links let individual users authenticate with their own credentials. They are designed for broad distribution.- Domain restriction — restricted by email domain (e.g., anyone with
@company.comcan use the link) - Unlimited uses — multiple users can authenticate through the same link
- User-level credentials — each user provides and stores their own credentials
Project auth links
Project auth links let a specific person provide shared credentials for the entire project. They are designed for one-time admin setup.- Email restriction — restricted to a specific email address
- Single use — the link can only be used once
- Project-level credentials — credentials are shared across all users in the project
Create an auth link
1
Navigate to your project
Go to the Projects page and select the project where you want to create the auth link.
2
Open Auth Links
Click on the Auth Links tab in the project view.
3
Create a new auth link
Click Create Auth Link and select the type:
- User auth link
- Project auth link
Configure the following:
- Servers — select which server instances to include in the link
- Domain restriction — the email domain users must belong to (e.g.,
company.com) - Expiration — when the link expires
4
Share the link
Copy the generated link and share it with the intended user(s).
The auth link is active and ready for users to authenticate.
The user authentication experience
When a user visits an auth link, they go through a guided authentication flow:1
Sign in
The user signs in with their email. The system validates that their email matches the link’s restrictions (domain for user links, exact email for project links).
2
Review servers
The user sees which servers need authentication and what method each requires:
- OAuth servers — a “Connect” button that starts the OAuth authorization flow
- Header servers — a form to enter API keys or Bearer tokens
- Path servers — a form to enter URL path parameter values
- Query servers — a form to enter query parameter values
3
Provide credentials
The user authenticates with each server:
- For OAuth — they click “Connect”, authorize with the external provider, and return to Caylex
- For Header/Path/Query — they enter the required values in the form
Users can authenticate with a subset of servers. They do not need to complete all servers at once.
4
Credentials stored securely
Once completed:
- OAuth tokens are stored by the identity provider (never in Caylex’s database)
- Header, Path, and Query values are encrypted and stored in AWS Parameter Store
Manage auth links
From the Auth Links tab in your project, you can:- View all links — see active and expired links with their type, expiration, and usage
- View authenticated users — see which users have completed authentication through each link
- Edit links — update domain/email restrictions or expiration
- Delete links — remove a link (does not revoke existing user credentials)