How to verify authorised Organisations with access permissions
To determine which Organisations the Account Owner has authorised, you can make a call to the /companies endpoint
using the received token. In response, you will receive a list of Organisations UUIDs to which access has been granted.
To retrieve information about the authorised connections in the current authentication flow, you can visit the Connections list page on the ApprovalMax main application page.
This page will provide you with details of the connections that have been authorised during the authentication process.
Please note: if you wish to revoke access to a particular Organisation through the Public API, or add a new Organisation to the list of accessible entities, you will need to create a new connection by initiating the authorisation flow again. This is necessary to ensure the security and integrity of sensitive data managed by ApprovalMax.
If you wish to disable or remove a connection to revoke access to your data via the ApprovalMax Public API, you also need to visit the Connections list page on the ApprovalMax main application page.
To delete a connection, the Account Owner or Account Manager has the authority to remove it. Deleting the connection will revoke any associated access tokens and refresh tokens.
Please note: this action can only be performed by an Account Owner or Account Manager, and once a connection is deleted, it cannot be restored. If the user wishes to use your application again, they will need to reauthorise the connection.
The disabling process also involves the Account Owner or Account Manager, who has the ability to change the connection's status.
How to grant access to an Organisation in the ApprovalMax Public API
The process of granting access to an Organisation consists of the following steps: 1. Initiate user authorisation: generate an URL with the necessary parameters. This URL will direct account owners/ account managers to the ApprovalMax Public API ...
The list of endpoints available in Public API
To make calls against the APIs, please refer to the endpoints below or to the swagger: Endpoints Description GET /ping In the ApprovalMax Public API, the GET /ping endpoint is a simple endpoint used for checks the overall availability and ...
How to grant access to an Organisation via the Consent page
During the authorisation flow, having initiated the process, the Account Owner or Account Manager is redirected to a Consent page. Here, they can manually select the Organisation(s) they wish to grant access to. The Consent page displays a list of ...
Prerequisites for using the Public API
Before proceeding with the authorisation process for the ApprovalMax Public API feature, there are certain prerequisites that need to be met. These include: 1. Granting access to the Developer Portal: in order to access the Developer Portal and ...
How can I offboard an Organisation?
Organisation retirement As time goes by, it might be required to offboard particular Organisations while keeping others live in ApprovalMax. For this purpose, ApprovalMax allows the retirement of Organisations. A retired Organisation will be moved ...