Search Users | API Reference | Descope Documentation

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired

loginIdstring

Search for specific login ID

tenantIdsarray<string>

If not empty then users must be members of at least one of these tenants

roleNamesarray<string>

If not empty then users must have one of the specified roles

limitinteger

Default is 100 if not specified

Format: "int32"

textstring

Full text search across relevant columns

pageinteger

Page number starting with 0 for the first page

Format: "int32"

ssoOnlyboolean

Bring only users that have SSO external IDs

Default: false

withTestUserboolean

Return also users which are test users

testUsersOnlyboolean

Return only test users

Default: false

customAttributesobject

Search for users with these custom attributes. Custom attributes filter should have string keys (attribute names that were configured for the user). Values should be either strings, ints or bools or lists (arrays) of strings, ints or bools for multiple matches.

statusesarray<string>

If not empty then users must be in one of those statuses

emailsarray<string>

phonesarray<string>

ssoAppIdsarray<string>

sortarray<object>

loginIdsarray<string>

fromCreatedTimestring

toCreatedTimestring

fromModifiedTimestring

toModifiedTimestring

userIdsarray<string>

scimOnlyboolean

Bring only users that provisioned or updated by SCIM

curl -X POST "https://api.descope.com/v2/mgmt/user/search" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "loginId": "string",
    "tenantIds": [
      "string"
    ],
    "roleNames": [
      "string"
    ],
    "limit": 0,
    "text": "string",
    "page": 0,
    "ssoOnly": false,
    "withTestUser": true,
    "testUsersOnly": false,
    "customAttributes": {},
    "statuses": [
      "string"
    ],
    "emails": [
      "string"
    ],
    "phones": [
      "string"
    ],
    "ssoAppIds": [
      "string"
    ],
    "sort": [
      {
        "field": "string",
        "desc": true
      }
    ],
    "loginIds": [
      "string"
    ],
    "fromCreatedTime": "string",
    "toCreatedTime": "string",
    "fromModifiedTime": "string",
    "toModifiedTime": "string",
    "userIds": [
      "string"
    ],
    "scimOnly": true
  }'

{
  "users": [
    {
      "loginIds": [
        "string"
      ],
      "userId": "string",
      "name": "string",
      "email": "string",
      "phone": "string",
      "verifiedEmail": true,
      "verifiedPhone": true,
      "roleNames": [
        "string"
      ],
      "userTenants": [
        {
          "tenantId": "string",
          "roleNames": [
            "string"
          ],
          "tenantName": "string"
        }
      ],
      "status": "string",
      "externalIds": [
        "string"
      ],
      "picture": "string",
      "test": false,
      "customAttributes": {},
      "createdTime": 0,
      "TOTP": false,
      "SAML": false,
      "OAuth": {
        "property1": false,
        "property2": false
      },
      "webauthn": true,
      "password": true,
      "ssoAppIds": [
        "string"
      ],
      "givenName": "string",
      "middleName": "string",
      "familyName": "string",
      "editable": true,
      "SCIM": true
    }
  ],
  "total": 0
}

Was this helpful?

Authorization

Request Body

Response

TypeScript