REST API for SSO Authentication
API Authentication for 3. Party Organizations
This section will provide detailed guidance on how to authorize 3rd Party Organizations (Reseller or strategic partners) with Platform API keys.
Go to the Dashboard and follow the Company > Company List path and select the company you will authorise to use Platform. Then click the Edit icon in the Action column for the edit page.
On the Company Edit page, copy the Company API Key and OAuth ID values to use them for authorisation operations.
In order to create a Platform Authentication Key, you must fulfil the requests in the table below:
Title | Description |
API URL | /api/Oauth/OAuthKeyGenerate? |
Method | POST |
Parameters | ApiKey= String = Company Api Key OAuthID = String = Company OAuth ID Email = String = User who will login to the system with API |
ApiKey (String) | Company Api Key |
OAuthID(String) | Company OAuth ID |
Email(String) | The user who will login to the system with API |
Table 1. Authentication Key Generating Table |
3. For Party organizations, a request is sent to the Platform application as following, and an OAuthKey is created for the relevant user. This key is included in the response.
Example Request:
curl -XPOST -v -i 'https://dashboard.keepnetlabs.com/api/Oauth/OAuthKeyGenerate?ApiKey={ApiKey}&OAuthID={OAuthID}&Email={Email}'
Example Response:
In order to login into the application, you must fulfil the requests in the table below.
Title | Description |
Api URL | /api/Oauth/Authentication? |
Method | GET |
Parameters | ApiKey= String = Company Api Key OAuthKey = String = 1. OAuth Key obtained on the previous table Email = String = User Email address Name = String = User Name information Surname = String= User Surname information |
ApiKey (String) | Company API Key |
OAuthKey(String) | OAuthKey |
Email(String) | The user who will login to the system with API |
Name(String) | Name |
Surname | Surname |
Table 2. Platform OAuth Authentication Table |
Example Request:
In order to perform the authentication process, send a GET request is via the relevant URL browser.
https://dashboard.keepnetlabs.com/api/Oauth/Authentication?apikey={ApiKey}&OAuthKey={OAuthKey}&Email={Email}&Name={Name}&Surname={Surname}
Result:
Following the Request process mentioned above, the user will be directed to dashboard.keepnetlabs.com and will be logged into the system automatically.
Last updated
