Permissions required by the API user
Who is this article for?Users who need to access data via the API.
Integrationknowledge is recommended.
An external application wanting to access data via the API must log in via a user account. This article gives you an overview of available login options.
1. API User
You have two options:
- Your application could prompt the user for their Ideagen Audit FBA Identity username and password whenever they want access.
- You could configure a 'service account', which is an application user who is not a real person, but will be used by the API application.
If you wish to do this, you should ensure that you have been provided with an additional license; confirm with your Account Manager.
Whichever option you choose, it is important to note that the data visible to the external application will be determined by the roles set for that application user.
If you configure your application to log with a user's credentials, then the user will see only the data they would see if they accessed the desktop application itself.
If you use a service account, all users of the external application will see the data permitted by the service user's roles.
When thinking about access, you should consider what data you want users to see, and either use an existing role or build a new one that matches the requirement.