Grant Permissions

Access to API endpoints is controlled by users. Access can be controlled in two ways.

User Permissions at the Application Level

In the first option, a user is assigned to the API endpoint.

You can do this in the properties of the application to which the API endpoint belongs. The assigned user can access the API endpoint if authentication on the portal is performed using the default API login endpoint and cookies (without an API key).

Administrator

The "Administrator" user is automatically assigned to every API endpoint.

You can find detailed information about this option in the following sections:

User Permissions at the API Key Level

In the second option, a user is assigned via an API key, which is (in turn) associated with the API endpoint. This also grants the user access to the API endpoint.

You can assign a user to an API key in the "Integration" module. When accessing an API endpoint using an API key, the corresponding user does not need to explicitly log in to the portal.

You can find detailed information about this option in the following sections:

Interaction between users at the API endpoint and API key levels

If a user has access to an API endpoint via an API key, they do not need any (additional) mapping at the application level. Assigning it at the API key level is sufficient.