Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Tenants

List Tenant Users

get/v2/facts/{proj_id}/{env_id}/tenants/{tenant_id}/users

Path parameters

tenant_idstring required

Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the "slug").

Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the "slug").

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

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").

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 email field

Text search for the email field

rolestring

Match users with a specific role

Match users with a specific role

include_resource_instance_rolesboolean

Should add resource instance roles

Should add resource instance roles

pageinteger

Page number of the results to fetch, starting at 1.

Page number of the results to fetch, starting at 1.

per_pageinteger

The number of results per page (max 100).

The number of results per page (max 100).

Response

Successful Response

total_countinteger required
page_countinteger

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",
      "key": "user|892179821739812389327",
      "email": "jane@coolcompany.com",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "first_name": "Jane",
      "last_name": "Doe",
      "attributes": {
        "department": "marketing",
        "age": 30,
        "subscription": {
          "tier": "pro",
          "expired": false
        }
      },
      "associated_tenants": [
        {
          "tenant": "stripe-inc",
          "roles": [
            "admin"
          ],
          "status": "active"
        },
        {
          "tenant": "othercompany.com",
          "roles": [
            "viewer"
          ],
          "status": "pending"
        }
      ],
      "roles": [
        {
          "role": "admin",
          "tenant": "stripe-inc"
        },
        {
          "role": "viewer",
          "tenant": "othercompany.com"
        }
      ]
    }
  ]
}