Who can make and revoke keys
You need Configure on at least one area. Without it the page says You need admin access to at least one module to create an API key. A key can never do more than the person who makes it. In the permission grid, anything you do not have yourself is greyed out, because a key you make cannot have it either.Making a key
1
Start a new key
Press New key. The New API key card opens.
2
Say what it is for
Under What is it for?, type a name, such as Website adoptable list. It is how you tell keys apart later, up to 100 characters.
3
Choose what it may do
Under What may it do?, tick what the key may do in each area. Choose at least one.
4
Choose when it expires, if ever
Expires is optional. Leave it empty for a key that does not expire on its own.
5
Create it and copy it
Press Create key, then Copy, and keep the key somewhere safe before you press I’ve saved it.
What a key may do
The grid under What may it do? has a row for each area and three columns:
Ticking Configure ticks Change and See too, and ticking Change ticks See: a key cannot change what it cannot see. Unticking See clears the row.
A key reaches the areas, and tasks, activity, the calendar, and forms and their submissions, as far as its permissions allow. It never reaches your team members, roles, organization settings or other keys, whatever you tick.
The permissions are fixed when the key is made. If the person who made it later loses a permission, the key keeps it. Revoke the key if that matters.
The key is shown once
When you press Create key, the key appears in a panel headed Copy “Website adoptable list” now. This is the only time it is shown. RescueConsole keeps only a fingerprint of it, so it cannot be shown again or recovered. If you lose it, revoke it and make another. The panel stays until you press I’ve saved it.Where a key works
A key works only at your own organization’s address. The same key sent to any other organization’s address is not accepted.The list of keys
Each key in the list shows its name, the first few characters of the key so you can match it to the one a program holds, what it may do, who created it and when, when it was last used or that it was never used, and when it expires. A key past its expiry date is marked Expired; a revoked key is marked Revoked. A key that was never used is often one nobody needs. A key that has been used also shows how many calls it made in the last 30 days, and how many of those were refused. A key collecting refusals is usually one whose permissions do not match what the program is trying to do.What a key was told
Press What it was told under a key to read what came back to it: the answer, the address it asked for, and the sentence it was given. This is where “why has our website stopped listing animals” is answered without anybody guessing. Keep decides how much of that is written down:
Lines are kept for 90 days and then go. The counts above them are kept far longer, so a record of how much a key was used outlives the detail of what it was told.
The address is kept without its query. A program that asks for
/api/people/persons?search=dana@example.org is recorded as asking for /api/people/persons and nothing else. The part after the question mark is where the people are, and this page can be read by anybody who can see Settings, so it is never written down. Neither is anything a program sent in the body, nor any of its headers, one of which is the key itself.
