This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

A

Account

API

API Key

Application permission

1 - Account

Refers to a user account in Stroom’s internal Identity Provider. An Account holds the credentials a person authenticates with, and exists only where Stroom is its own Identity Provider, unlike a User which exists in every deployment.

2 - API

Application Programming Interface. An interface that one system can present so other systems can use it to communicate. Stroom has a number of APIs, e.g. its many REST APIs and its /datafeed interface for data receipt.

3 - 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 .

4 - Application permission

This is a permission that is not specific to a single document. It applies to all documents or is not related to documents in any way.

Application permissions are generally associated with a screen or functional area of the Stroom application. A lot of the application permissions tend to be more applicable to system administrators but allow fine grained control of the different functional areas in Stroom so these functions can be devolved to other users.

Examples of application permissions are Manage Users, Pipeline Stepping and Data - View.