Creating and configuring this OAuth application is the first part of the authentication process for external applications that wish to interact with the Simpplr API.
There are two parts of the authentication equation:
- First a client application must be created and configured
- Custom code must be written to properly authenticate the client application created in Simpplr
Part 1: Set Up Your Client Application
In order to authenticate you must first create an OAuth client application. Once created, the client application must be configured with information unique to your application to ensure proper and secure connections are made.
Following are the steps to create the client application:
- Log in to your Simpplr tenant as the App manager user.
- Click on your profile image top right corner.
- Select Manage → Application → Integrations → Client application
- Click the Add client application button to open the following form:
- Provide the following Information:
- Client application name
- Client application Id - you can generate any random UUID from here.
- Client application description
- Client redirect URL - The URL the browser will redirect back to after successful authorization. You will receive an authorization code that can be exchanged to get access token
- Under Authorization grant type, ensure Authorization grant codeis checked
- Optionally, check Support state parameter in case you want to verify your request. The state query param will be part for your redirect URL
- Click Save
This will create an OAuth 2.0 client application and will provide you Client Id, Client secret, OAuth authorize URL, OAuth token URL for the tenant.
It is recommended to keep the base URL configurable for the OAuth authorize URL and OAuth token URL in your custom code.