API Keys

List Accessible Entities

Returns the entities your API key can access, with their IDs and names, so you know which entity ID to pass in the x-entity-id header.

get/api-keys/accessible-entities

Request

Response

Successful Response

Example response

{
  "entities": [
    {
      "access_type": "global_api_key",
      "entity_id": "94a60dc7-93ab-4fed-8b2f-4008cdf7289b",
      "entity_name": "AMITY",
      "role": "Admin"
    },
    {
      "access_type": "global_api_key",
      "entity_id": "123e4567-e89b-12d3-a456-426614174000",
      "entity_name": "Acme Corp",
      "role": "Viewer"
    },
    {
      "access_type": "entity_api_key",
      "entity_id": "123e4567-e89b-12d3-a456-426614174111",
      "entity_name": "Entity API Key Example"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.