Web API with AIM Authentication

Web API with Access Token Authentication or AIM Integration

The following image shows the sequence of the Web API Authentication :

1. The workflow engine server is registered in the AIM server. The registered workflow engine server acts as a client and requests the AIM server for an access token through the Invoke Web API Activity.

   This is applicable only if the Use System Authentication option in Web API Activity Configuration page is selected. If this option is not selected, then the current logged in user's access token is used.

2. The AIM server sends the access token to the client through the Invoke Web API Activity.

3. The Invoke Web API Activity invokes the Web API using the access token. It sends the access token in the authorization or bearer header for the Web API request.

4. The access token passed through the Web API request is validated internally in the AIM server.If the access token is valid, then the Web API request is executed successfully.

5. If the access token is invalid, then the AIM server responds with a 401 Unauthorized Error.

For information about registering a client in the AIM server, see Token Service.

For more information about Web API authentication, see Web APIs topic in the Use Forms and Lists section.