Tenants
List Tenants
Changed onLists all the tenants defined within an env.
get/v2/facts/{proj_id}/{env_id}/tenants
Request
- Base URLhttps://api.permit.io (the document declares no server; this is the origin it was published from)
- AuthHTTP bearer
Path parameters
proj_idstring required
Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_idstring required
Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
Query parameters
searchstring
Text search for the tenant name or key
include_total_countboolean
Include total count in response
pageinteger
Page number of the results to fetch, starting at 1.
per_pageinteger
The number of results per page (max 100).
Response
Successful Response
Example response
{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"last_action_at": "2019-08-24T14:15:22Z",
"key": "stripeinc",
"name": "Stripe Inc",
"attributes": {
"allowed_locations": [
"US",
"CA"
]
}
}
]
}Changes
- info
queryrequest parameterinclude_total_countwas deprecated
- info