Fetch Data

User, Auth & Access Control

#	API	Description
1	POST /api/me	Fetches the current logged-in user's profile information including login, name, role, and associated accounts.
2	POST /api/fetchUserLastLoginTs	Fetches the Unix timestamp of the current user's last login.
3	POST /api/getCustomRoles	Retrieves all custom roles defined in the system for the current account.
4	POST /api/getRoleHierarchy	Returns the role hierarchy that the current user is permitted to assign to others.
5	POST /api/getAccessTypes	Fetches access-type information (public, private, partner) for a given list of Agentic Component URLs.
6	POST /api/fetchApiTokens	Fetches all API Request tokens (including Slack webhook tokens) belonging to the current user in the current account.
7	POST /api/getCustomerStiggDetails	Fetches a signed Stigg customer token for authenticating the Stigg in-app widget on the client side.
8	POST /api/getUserAnalysis	Fetches user analysis data for a given MCP agent and device, used by the Endpoint Shield agent.

POST request for endpoint /api/me

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

objectOptional

No request body required.

Responses

200

Returns the current user's profile details.

application/json

User profile object

post

/api/me

HTTPcURLJavaScriptPython

POST /api/me HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Returns the current user's profile details.

{
  "user": {
    "login": "[email protected]",
    "name": "Alice",
    "role": "ADMIN",
    "accounts": {
      "1000000": "My Account"
    }
  }
}

POST request for endpoint /api/fetchUserLastLoginTs

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

objectOptional

No request body required.

Responses

200

Returns the last login timestamp.

application/json

lastLoginTsintegerOptional

Unix epoch timestamp (seconds) of the user's last login.

Example: 1712345678

post

/api/fetchUserLastLoginTs

HTTPcURLJavaScriptPython

POST /api/fetchUserLastLoginTs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Returns the last login timestamp.

{
  "lastLoginTs": 1712345678
}

POST request for endpoint /api/getCustomRoles

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

objectOptional

No request body required.

Responses

200

Returns the list of custom roles.

application/json

post

/api/getCustomRoles

HTTPcURLJavaScriptPython

POST /api/getCustomRoles HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Returns the list of custom roles.

{
  "roles": [
    {
      "name": "security-analyst",
      "baseRole": "MEMBER",
      "apiCollectionIds": [
        1001,
        1002
      ],
      "defaultInviteRole": false,
      "allowedFeaturesForUser": [
        "TESTING",
        "INVENTORY"
      ]
    }
  ]
}

POST request for endpoint /api/getRoleHierarchy

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

objectOptional

No request body required.

Responses

200

Returns the list of roles below the current user's role.

application/json

userRoleHierarchystring[]Optional

Array of Role enum values that the current user can assign.

Example: ["MEMBER","GUEST"]

post

/api/getRoleHierarchy

HTTPcURLJavaScriptPython

POST /api/getRoleHierarchy HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Returns the list of roles below the current user's role.

{
  "userRoleHierarchy": [
    "MEMBER",
    "GUEST"
  ]
}

POST request for endpoint /api/getAccessTypes

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

urlsstring[]Required

List of API endpoint URLs to look up access types for.

Example: ["/api/login","/api/admin/users"]

Responses

200

Returns ApiInfo objects with access type details for each URL.

application/json

post

/api/getAccessTypes

HTTPcURLJavaScriptPython

POST /api/getAccessTypes HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "urls": [
    "/api/login",
    "/api/admin/users"
  ]
}

200

Returns ApiInfo objects with access type details for each URL.

{
  "response": {
    "apiInfos": [
      {
        "url": "/api/login",
        "accessType": "PUBLIC"
      }
    ]
  }
}

POST request for endpoint /api/fetchApiTokens

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

objectOptional

No request body required.

Responses

200

Returns all API tokens for the current user.

application/json

post

/api/fetchApiTokens

HTTPcURLJavaScriptPython

POST /api/fetchApiTokens HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

200

Returns all API tokens for the current user.

{
  "apiTokenList": [
    {
      "id": 42,
      "key": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2",
      "utility": "EXTERNAL_API",
      "userId": 1001
    }
  ]
}

POST request for endpoint /api/getCustomerStiggDetails

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

customerIdstring · uuidRequired

Organisation ID in UUID format, used as the Stigg customer identifier.

Example: 550e8400-e29b-41d4-a716-446655440000

Responses

200

Returns a signed Stigg customer token.

application/json

customerTokenstringOptional

Signed JWT/signature token for authenticating with the Stigg client SDK.

Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

post

/api/getCustomerStiggDetails

HTTPcURLJavaScriptPython

POST /api/getCustomerStiggDetails HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "customerId": "550e8400-e29b-41d4-a716-446655440000"
}

200

Returns a signed Stigg customer token.

{
  "customerToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

POST request for endpoint /api/getUserAnalysis

post

Header parameters

content-typestringOptionalExample: application/json

X-API-KEYstringOptionalExample: YOUR_API_KEY from Settings > Integrations > Akto APIs

Body

application/json

agentIdstringRequired

Identifier of the MCP agent/service.

Example: agent-abc123

deviceIdstringRequired

Identifier of the device making the request.

Example: device-xyz789

Responses

200

Returns the user analysis data for the specified agent and device.

application/json

post

/api/getUserAnalysis

HTTPcURLJavaScriptPython

POST /api/getUserAnalysis HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "agentId": "agent-abc123",
  "deviceId": "device-xyz789"
}

200

Returns the user analysis data for the specified agent and device.

{
  "userAnalysis": {
    "agentId": "agent-abc123",
    "deviceId": "device-xyz789",
    "analysisData": {}
  }
}