API Key

API Keys are a form of authentication token that are created within Stroom for use by Stroom-Proxy instances or other clients that want to use Stroom’s API. It is an encrypted string that contains details of the user and the expiration date of the token. Possession of a valid API Key for a user account means that you can do anything that the user can do in the user interface via the API.

API Keys should therefore be protected carefully and treated like a password. If you are using an external Identity Provider then tokens for use with the Identity Provider are generated by the external Identity Provider .