Generic Auth (REST) is a REST API based authentication system used to manage authentication of users in applications. This structure allows an application to receive an Access Token via a specific REST API and perform the authentication process.
You can easily add a Generic Auth (REST) authentication provider in the applications you develop with Kuika with the following steps.
Adding Generic Auth (REST) Provider
Open Configuration Manager:
Click the Configuration Manager view mode in the top menu.
Name Configuration Manager to create a new configuration.
Switch to Authentication & Authorization:
On the App Settings screen, navigate to the Authentication & Authorization tab.
Select ADD NEW from the drop-down menu under the Authentication Provider heading.
Select Generic Auth (REST):
In the modal screen that opens, select Generic Auth (REST) from the Type field.
Fill in the Name field to give the provider a name.
Making Token Settings
Add REST API URL:
REST API URL: Specify the URL to be used for token retrieval. You can access it from Swagger or Rest API documentation to learn more.
Content Type Selection:
Content Type: Select the data format of the API returning the token. (For example: application/json or application/x-www-form-urlencoded)
Set Expiration Time:
Expiration in Minutes: Enter the validity period of the token in minutes (e.g. 30 minutes). Kuika defaults to 30 minutes where not specified.
Adding Parameters:
Extra Parameters:
Header: For example, authentication information can be sent using the Authorization header.
Query: You can carry authentication information on the URL.
Body: Data transmission can be done with POST or PUT requests. For example, you can send data in application/json format.
User Parameters:
Username and Password:
Kuika can automatically add username and password parameters.
Specify the parameter type (Header, Query, Body) and key information.
Refresh Token Settings
Enter Refresh Token URL:
Token URL: Specify the URL to be used for the Refresh Token operation.
Content Type Selection:
Content Type: Select the URL content type (e.g. application/json).
Adding Parameters:
Extra Parameters:
Refresh Token You can add Header, Query or Body parameters on the URL.
Kuika automatically adds Token and Refresh Token parameters. Specify the appropriate parameters with the ADD PARAMETERS option.
Making Response Settings
Access Token and Other Information:
Response Mapping: Define the following fields to map the incoming response:
Access Token
User Name
First Name
Last Name
Refresh Token
Refresh Token:
Add the Refresh Token information to the field specified under Response.
Create the Provider
After filling in the required information, you can create your Generic Auth (REST) authentication provider by clicking the CREATE button.
