API keys
Create an API key so another program can call the platform. Choose its permissions, set an expiry date and replace the key.
This page creates an API key so another program can call the platform without a person signing in, for example a script that imports data every night.
Your role needs Can create credential, Can edit credential or Can delete credential, depending on the task.
Create an API key
- Open API keys and press Add API key.
- Fill in Name so you know which program this key belongs to.
- If the key should stop working one day, set the expiry date.
- Under Scopes, tick only what the program needs (Scopes).
- For Restriction type, choose None (Restrictions).
- Press Save. The Key box appears at the top.
- Press the copy icon at the end of the Key box and send the key to whoever looks after that program.
Anyone who can open this page can read the key, so give the credential permissions only to people you trust.
Scopes
A scope says what the key can do. The text on the screen is always in English.
| Text on the screen | What the key can do |
|---|---|
| Read any public content | Read public content |
| Read any admin data such as users, roles, clients and api-keys | Read data about users, roles, clients and API keys |
| Manage any admin data such as users, roles, clients and api-keys | Manage users, roles, clients and API keys |
| Read any items there owned by and shared with user | Read the Items the user owns or that are shared with them |
| Manage any items there owned by and shared with user | Manage the Items the user owns or that are shared with them |
| Read any groups where user are owned and joined | Read the groups the user owns or has joined |
| Manage any groups where user are owned and joined | Manage the groups the user owns or has joined |
Expiry date
Press the Expires box, choose a day in the calendar, press OK and then Save. After that day, the platform no longer accepts this key. Take care not to choose a day that has already passed, because the key stops working at once. To remove the expiry date, press Clear in the calendar.
Restrictions
Choose None. The other options, IP address, HTTP referrer, Android and iOS, can store a list with the key, but this Release does not use them for any check. For example, a key limited to one IP address still works from other IP addresses.
Replace a key
The value of a key cannot be edited. If a key leaks or you want to change it, do this.
- Create a new API key with the same scopes.
- Ask whoever looks after the program to switch to the new key.
- Delete the old key.
Edit or delete a key
Find the key in the Search API keys box and press Edit or Delete in its row. If you delete, press Delete again in the confirmation box. Programs that still use this key can then no longer call the platform.
If you cannot find a key, it may be a personal key a user made in the Account App, which this page does not show.