Guides
API keys
Where to issue an organization key for the Umbreta API, what that key sees and who owns the profiles created through the API.
After this page you have an organization key that other services use to create profiles and run scenarios, through the same API the app uses.
You need
- The Admin role in the organization.
Steps
- In the app, open API and keys.
- Press Keys in the console. The API keys section of the organization’s console opens.
- Issue a key and save it. It starts with
vk_.
Result
The organization key is ready. The app holds no keys: they are issued, limited and revoked in the console, under API keys. An example request that creates a profile is on the right of the API and keys screen: Copy the example.
A key sees what the person who issued it sees: their profiles and their rights. When the person leaves the organization, their keys are revoked. Profiles created through the API belong to whoever issued the key and show in Profiles like any other; access for other people is granted in People and access.
If it didn’t work
- There is no API and keys section: only the organization’s admin has it.
- Requests with the key are refused: the key was revoked, or its owner left the organization. Issue a new one.