Skip to main content
Version: 2.0.0

listTenantUsers

List users associated with a tenant.

Parameters​

tenantKey (required) - Either the unique id of the tenant, or the URL-friendly key of the tenant (i.e: the "slug"). search (optional) - Search users by key, email, first name, or last name role (optional) - Match users with a specific role page (optional) - The page number of the results to fetch, starting at page 1 perPage (optional) - The number of results per page (maximum of 100)

Implementation​

await permit.api.tenants.listTenantUsers({
  tenantKey: "default",
  search: "@permit.io",
  role: "admin",
  page: 1,
  perPage: 100,
});

Contents