search-users
Search for users in your Descope project by text, email, phone, status, roles, or other criteria to manage user accounts and access.
Instructions
Search for users in Descope project
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | Text to search for in user fields | |
| emails | No | Filter by specific email addresses | |
| phones | No | Filter by specific phone numbers | |
| statuses | No | Filter by user statuses ('enabled', 'disabled', or 'invited') | |
| roles | No | Filter users by role names | |
| tenantIds | No | Filter users by specific tenant IDs | |
| ssoAppIds | No | Filter users by SSO application IDs | |
| loginIds | No | Filter by specific login IDs | |
| withTestUser | No | Include test users in results | |
| testUsersOnly | No | Return only test users | |
| page | No | Page number for pagination | |
| limit | No | Number of users per page (max 100) |
Input Schema (JSON Schema)
{
"properties": {
"emails": {
"description": "Filter by specific email addresses",
"items": {
"type": "string"
},
"type": "array"
},
"limit": {
"default": 10,
"description": "Number of users per page (max 100)",
"maximum": 100,
"minimum": 1,
"type": "number"
},
"loginIds": {
"description": "Filter by specific login IDs",
"items": {
"type": "string"
},
"type": "array"
},
"page": {
"description": "Page number for pagination",
"minimum": 0,
"type": "number"
},
"phones": {
"description": "Filter by specific phone numbers",
"items": {
"type": "string"
},
"type": "array"
},
"roles": {
"description": "Filter users by role names",
"items": {
"type": "string"
},
"type": "array"
},
"ssoAppIds": {
"description": "Filter users by SSO application IDs",
"items": {
"type": "string"
},
"type": "array"
},
"statuses": {
"description": "Filter by user statuses ('enabled', 'disabled', or 'invited')",
"items": {
"enum": [
"enabled",
"disabled",
"invited"
],
"type": "string"
},
"type": "array"
},
"tenantIds": {
"description": "Filter users by specific tenant IDs",
"items": {
"type": "string"
},
"type": "array"
},
"testUsersOnly": {
"description": "Return only test users",
"type": "boolean"
},
"text": {
"description": "Text to search for in user fields",
"type": "string"
},
"withTestUser": {
"description": "Include test users in results",
"type": "boolean"
}
},
"type": "object"
}