Generating API keys
Last updated
Last updated
Generating API keys in Citizen Space is simple and easy. Provided you have API turned on for your platform, you can navigate to the API settings under Site Settings in the dashboard.
It's highly likely you'll want to connect your Citizen Space to a number of different services be it records management software, or enhanced data analysis tools. In this instance you may want to use different API keys with unique names and permissions.
When adding a key in Citizen Space you can assign it different permissions depending on its application. As an example, when creating a key to update a document or records management system it's unlikely you would need to give that key 'write' permissions. The options available when adding or editing a key are:
activities.edit
activities.read
activities.responses.add
activities.responses.edit
activities.responses.read
activities.search
users.read users.search
Should you wish to edit a keys permissions you can do that at any time simply click the 'Edit' link and make alterations using the checkboxes.
To disable an API key simply click on the 'Disable' link. You'll be shown a warning asking to confirm your action and if you proceed the key will be shown to be disabled via a (disabled) being displayed next to the name and the color of the card border changing to red.
In the event you wish to delete an API key, simply click 'Delete' in the top right hand corner of the card. You will be prompted to confirm your choice and once selected it will be deleted.
