Q Keys¶
The Q Keys screen is where organization Owners and Admins create keys for apps and integrations. Open it from Q Keys in the organization sidebar (the same sidebar that lists Dashboard, Agents, and Users).
Note
The User role does not see Q Keys. A global super user can open the screen as well.
Overview¶
The page introduces keys with this text:
Q Keys let apps and integrations connect to this organization. Copy the key when you create or replace it — we can’t show it again. You can turn a key off at any time by revoking it.
From here you can:
Create a key with Create Q Key
Replace an active key so the old one stops working
Revoke one key, or several at once
See whether a key is Active, Expired, or Revoked
An organization can have 10 active Q Keys. At that limit, Create Q Key is turned off and the page says: “This organization has reached the limit of 10 active Q Keys. Revoke an unused key before creating a new one.”
Revoked keys stay on the list so you can see that they were turned off. The organization keeps 10 revoked Q Keys. When 10 revoked keys already exist, revoking another one permanently deletes the oldest revoked key. The page says: “This organization has reached the limit of 10 revoked Q Keys. Revoking another key permanently removes the oldest revoked key.”
Creating a Q Key¶
Click Create Q Key.
The dialog says: “You’ll see the key only once. Give it only the access it needs.”
Fill in the fields below, then click Create.
Field | Description |
|---|---|
Name | A name you’ll recognize later, like WordPress or Nightly report. Up to 100 characters. |
What this key can do | One of the four scopes in the next section. |
Agent | Shown only for View one agent and Edit one agent. Pick the agent this key can access. If the organization has no agents yet, the form says “Create an agent first to use this option.” |
How long it lasts | Choose how long this key stays valid. You can always turn it off later. |
What this key can do¶
Choose one scope:
Scope | What it can do |
|---|---|
View organization | Can see your agents and organization details. |
Edit organization | Can see and change agents in this organization. |
View one agent | Can see this agent, its knowledge sources, and its status. |
Edit one agent | Can see and change this agent, including knowledge sources, training, and connections. |
How long it lasts¶
The choices are:
90 days (selected when you open the form)
180 days
365 days
Custom — enter a Number of days from 1 to 365, or pick a date in that range
Never expires
A key past its expiration stops working. The list shows Expired. When the key has an end date, the row also shows Expires and that date, including after it has expired. Never expires is shown when you chose that option.
The key is shown only once¶
After you create or replace a key, a dialog titled Copy your Q Key opens. It says: “This is the only time you’ll see this key. Copy or download it now — we can’t show it again.”
CrafterQ also tries to copy the key to the clipboard. Use Copy if you need to copy it again, or Download to save a text file. A warning on the dialog says to treat the key like a password: anyone who has it can use the access you gave it, and it cannot be shown again after you click Done.
Replacing and revoking¶
Each key that has not been revoked has a menu with Replace and Revoke. That includes a key the list marks Expired.
Replace asks you to confirm with Replace this Q Key? The old key stops working right away. The name and access stay the same. You choose How long it lasts for the new key, then click Replace. The new key is shown only once, in the same Copy your Q Key dialog.
Revoke asks Revoke this Q Key? The key stops working right away. This can’t be undone. Create a new key if you still need access.
Bulk revoke¶
Active keys have a checkbox. Select all selects every active key.
When one or more keys are selected, click Revoke. The confirmation is Revoke this Q Key? for one key, or Revoke N Q Keys? for several. Several keys at once use this text: “The selected keys will stop working right away. This can’t be undone.”
If that revoke would leave more than 10 revoked keys, the confirmation also says the oldest revoked keys are permanently removed. Revoking one more key adds: “This organization has reached the limit of 10 revoked Q Keys. Revoking another key permanently removes the oldest revoked key.” Revoking several at once says how many oldest revoked keys will be removed, for example: “Revoking these keys permanently removes the 1 oldest revoked key to stay within the limit of 10 revoked Q Keys.”