Prerequisites & Setup
Prerequisites & Setup
Before configuring your identity provider, complete the prerequisites below. Your Deque representative can help provision the SCIM subscription and generate your API key.
Prerequisites
SCIM subscription
Your axe Account enterprise must have an active SCIM subscription. Without it, SCIM requests return:
402 "Subscription required"Contact your Deque representative to add the SCIM subscription to your enterprise.
SCIM works alongside Single Sign-On. When SCIM provisions a new user, the account is linked to your organization's identity provider so the user can sign in.
Generating a SCIM API key
Your identity provider authenticates to axe using a SCIM API key scoped to your enterprise.
- Sign in to the axe Account Portal as an administrator.
- Navigate to Settings > Manage API Keys.
- Generate a new SCIM API key.
- Copy the key and store it securely — you will enter it into your identity provider's SCIM connector.
Treat the API key like a password. Share it only through a secure channel (for example, your organization's secrets manager), never in plain email or chat. If a key is exposed, revoke it and generate a new one.
Base URL
Use the base URL for your region or private instance:
| Environment | Base URL |
|---|---|
| US (SaaS) | https://axe.deque.com |
| Paris (SaaS) | https://axe-eu.deque.com |
| Australia (SaaS) | https://axe-au.deque.com |
| Frankfurt (SaaS) | https://axe-frankfurt.deque.com |
| Private cloud / on-prem | Your dedicated instance URL |
The SCIM endpoints are served under the /api/scim/v2 path — for example:
https://axe.deque.com/api/scim/v2/UsersAuthentication
Include the API key on every request. Both of the following are accepted:
# Preferred
-H "X-API-Key: <API_KEY>"
# Also accepted (with or without a "Bearer " prefix)
-H "Authorization: <API_KEY>"Next
Once the prerequisites are met and you have your API key and base URL, continue to Configuring Your Identity Provider.