get
https://{application_vanity_domain}/api/v1/applications//users
Queries users, scoped to an application, based on a query expression.
Query Filter Attributes
| Name | Type | Case Sensitive | Supported Comparison Operators |
|---|---|---|---|
id | String | Yes | eq, ne, in, nin |
username | String | No | eq, ne, sw, lt, le, gt, ge, in, nin |
email | String | No | eq, ne, sw, lt, le, gt, ge, in, nin |
emailVerified | Boolean | N/A | eq, ne, in, nin |
externalId | String | Yes | eq, ne, sw, lt, le, gt, ge, in, nin |
familyName | String | No | eq, ne, sw, lt, le, gt, ge, in, nin |
givenName | String | No | eq, ne, sw, lt, le, gt, ge, in, nin |
fullName | String | No | eq, ne, sw, lt, le, gt, ge, in, nin |
status | String | No | eq, ne, in, nin |
identityProviderName | String | No | eq, ne, sw, lt, le, gt, ge, in, nin |
identityProviderType | String | No | eq, ne, in, nin |
Sort Attributes
idusernameemailexternalIdfamilyNamegivenNamefullNamestatusidentityProviderNameidentityProviderType
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 |
|---|---|---|
| user:read | Application | The subject can perform this query if they are associated with the application specified in the URL path. |