get https://{application_vanity_domain}/api/v1/tenants//clients
Queries clients, scoped to a tenant, based on a query expression.
Query Filter Attributes
Name | Type | Case Sensitive | Supported Comparison Operators |
---|---|---|---|
id | String | Yes | eq, ne, in, nin |
type | String | No | eq, ne, in, nin |
name | String | No | eq, ne, sw, lt, le, gt, ge, in, nin |
Sort Attributes
id
type
name
Required Permissions
Below is the list of required permissions needed to interact with this API. For each permission, the allowed permission boundaries are also specified.
Permission | Boundary | Description |
---|---|---|
client:read | Application | The subject can perform this query if the tenant specified in the URL path belongs to the subject's associated application. |
Tenant | The subject can perform this query if they are associated with the tenant specified in the URL path. | |
Tenant Inclusion List | The subject can perform this query if the tenant specified in the URL path is included in the tenant inclusion list. | |
Tenant Exclusion List | The subject can perform this query if the tenant specified in the URL path belongs to the subject's associated application and is not included in the tenant exclusion list. |