Authorization

The Authorization feature in Avo Assure generates a token used to authenticate API requests, such as creating or validating verticals, managing users and projects, and handling SSO role mappings. (for example, Swagger UI). This token acts as a temporary digital credential and remains valid only for a specific duration (for example, 1 day or 1 week).

Key Capabilities

The Authorization Token Enables You To:

• Secure API Access: Prevent unauthorized users from performing sensitive actions.

• Enable Access: Allow to perform tasks directly via API (such as creating users or projects).

• Manage Session Duration: Control how long external access remains valid through configurable expiry settings.

This Document Includes:

Prerequisites Prerequisites for Authorization in Avo Assure.

Generating an Authorization Token Steps to generate an Authorization Token in Avo Assure.

Example: Creating a Vertical in Avo Assure Steps to use the generated token to create a new Vertical in Avo Assure.

Prerequisites

Before you generate an authorization token, ensure you fulfill the following requirements:

• Active Account: You must have a valid and active Avo Assure user account.

• Project Creation: You must have an active project created in Avo Assure to work on Webservice automation.

• Valid APIs: You should have the valid Avo Assure APIs. For example, Swagger UI.

Generating Authorization Token

To generate a new API token, perform the following actions:

1. On the Home page, select the Utilities.

2. Select the Authorization tab to generate the Auth Token.

3. Locate the Select the token expiry dropdown and choose the desired expiration (for example, 1 Day or 1 Week).

4. Select the Generate Auth Token to create a new alphanumeric token, which appears in the Generated Token field.

5. Select the Copy to Clipboard to copy the token for use in your API client.

Example: Creating a Vertical in Avo Assure

To apply the generated token in an API client, perform the following actions:

1. On the Home page, select the Design Studio button. The Element Repository page opens.

2. Create a new folder by clicking on the Create Folder (+) icon and then create a repository by selecting Webservice as the application type.

To learn more about Creating a folder and Repository for Webservice, click here.

1. Select POST as the request method from the Select dropdown.

2. Enter the Avo Assure APIs URL in the Enter URL box.

   • URL: https://avomvc.avoassurecloud.com/Vertical/createVertical

1. Select the Header and Body tab and enter the following details:

Header

1. Enter the header details in the Header tab.

Body

1. Enter the body details in the Body tab.

1. Select the Authorization tab and select the Bearer Token from the TYPE dropdown.

2. Paste the generated auth token into the Token field.

   • Example Token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoiYW5raXRhIiwiaWF0IjoxNzY1NDU1MDk2LCJleHAiOjE3NjYwNTk4OTZ9.ApLsOoGEWRbmpqkk_1codJ-LeD0M462CcQbPZpNbRcw

To learn more about Generating Authorization Token, click here.

1. Select the Save and Send button to save the request details and execute the API.

2. Select Response tab to view the Header and Body response from the system.

Body

The Body tab displays the response returned by the server. The content is displayed in JSON format.

Header

The Header tab displays the HTTP status code, Server, response time, Content-Type, and Length.

To learn more on Webservice Automation, click here.