Skip to main content
Version: 2.0.0

listTenantUsers

Get all the users inside a specific tenant.

Path Parameters​

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

Query Parameters​

role - Match users with a specific role.
page - The page number of the results to fetch, starting at page 1.
per_page - The number of results per page (maximum of 100)

Implementation​

const user = await permit.api.tenants.listTenantUsers({
  tenantKey: "default",
  page: 1,
  perPage: 100,
});

Contents