Authentication

Overview

Use the following API request to get access_token

Endpoint

POST https://<your URL name>.octopai.com/api/UserAccount/Login

Request Body

{
"Username": "<YOUR USER EMAIL>",
"Password": "<YOUR PASSWORD>"
}

 

Request Body Parameters

Parameter	Type	Description
userName	string	Octopai user name. Example: [e-mail]
password	string	Octopai user password. Example: Pas$w@rd

Sample Response

{
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6InN1cHBvcnRAb2N0b3BhaS5jb20iLCJ1bmlxdWVfbmFtZSI6Ik9jdG9wYWkgU3VwcG9ydCIsInJvbGUiOiJJc0FkbWluIiwiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvYXV0aGVudGljYXRpb24iOiJhZG1pbiIsIm5iZiI6MTcxNzY1ODI5OSwiZXhwIjoxNzE3NjY1NTU5LCJpYXQiOjE3MTc2NTgzNTksImlzcyI6IkRlbW9Jc3N1ZXIiLCJhdWQiOiJEZW1vQXVkaWVuY2UifQ.gj-cJ3Hj8S4SJ31be6dRx_sjxLUkLDZ9Td56wA7Bu9A",
    "expiration": "2024-06-06T09:19:19.9616294Z",
    "refreshToken": {
        "token": "cBmuYt+l9KDSn2iqR+xtqoX42LoKBSCJGD98DrpD4snvH2A9rcm5c+afgl/Il2XeBAtL4b3eVrgkud5kxfsj/w==",
        "expiration": "2024-07-06T07:19:19.9616467Z"
    },
    "userName": "[e-mail]",
    "displayName": "Some User",
    "userEmail": null,
    "isAdmin": true,
    "error": null,
    "groupMember": [],
    "authLevel": "ADMIN",
    "displayModules": "lineage;e2e;discovery;compare;adc;adc dashboard;livelineage"
}

Use access_token for all following API requests

Postman Example