Learn

Users

Search users

Returns a list of users from the tenant that match the provided search criteria.

Analytic events

  • USER_SEARCH_START
  • USER_SEARCH_SUCCESS
  • USER_SEARCH_FAIL
SecuritybearerAuth
Request
Request Body schema: application/json
required

The search criteria

claims
object

Filter users by claims. Nestsed objects are supported. Text values must be an exact match.

object

Filter users by their unique identifier in the configured Authentication Provider.

limit
number [ 1 .. 1000 ]

Range size of returned entries, default 100

cursor
string

Starting point for the range of entries

Responses
200

Users retrieved

400

Bad Request

post/core/v1/users/search
Request samples
application/json
{
  • "claims": {
    },
  • "authenticationProvider": {
    },
  • "limit": 100,
  • "cursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
}
Response samples
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}

Retrieve all users

Returns a list of all users on your tenant.

Analytic events

  • USER_RETRIEVE_LIST_START
  • USER_RETRIEVE_LIST_SUCCESS
  • USER_RETRIEVE_LIST_FAIL
SecuritybearerAuth
Request
query Parameters
limit
number [ 1 .. 1000 ]

Range size of returned entries, default 100

Example: limit=2
cursor
string

Starting point for the range of entries

Example: cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses
200

Users retrieved

400

Bad Request

get/core/v1/users
Request samples 
Response samples 
application/json
{
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
  • "data": [
    ]
}
Retrieve a user
Retrieve an existing user by providing its ID.


    

  • USER_RETRIEVE_START
    • 

  • USER_RETRIEVE_SUCCESS
    • 

  • USER_RETRIEVE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
User ID


 
 Example:  8241400f-de3b-42c5-ad7c-8a380039e796
Responses 
200
User retrieved


400
Bad Request


404
User not found


get/core/v1/users/{id}
Request samples 
Response samples 
application/json
{
  • "id": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba",
  • "claims": {
    }
}
Update a User
Updates an existing user by providing its ID.


    

  • USER_UPDATE_START
    • 

  • USER_UPDATE_SUCCESS
    • 

  • USER_UPDATE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
User ID


 
 Example:  8241400f-de3b-42c5-ad7c-8a380039e796
Request Body schema: application/json
required
Update a User


claims
required
object
User claims to be updated.


 
Responses 
200
User updated


400
Bad Request


404
User not found


put/core/v1/users/{id}
Request samples 
application/json
{
  • "claims": {
    }
}
Response samples 
application/json
{
  • "id": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba",
  • "claims": {
    }
}
Delete a user
Deletes a user and removes any persisted data related to them by providing the user ID.




Any credentials issued to the user remain valid even after the user is deleted.




Analytic events


    

  • USER_DELETE_START
    • 

  • USER_DELETE_SUCCESS
    • 

  • USER_DELETE_FAIL
    • 



SecuritybearerAuth 
Request 
path Parameters
id
required
string <uuid> 
User ID


 
 Example:  8241400f-de3b-42c5-ad7c-8a380039e796
Responses 
204
User deleted


400
Bad request


404
User not found


delete/core/v1/users/{id}
Request samples 
Response samples 
application/json
{
  • "code": "BadRequest",
  • "message": "Validation Error",
  • "details": [
    ]
}
Retrieve all user credentials data
Returns a list of metadata for all the credentials referenced by the provided userId.


SecuritybearerAuth 
Request 
path Parameters
userId
required
string <uuid> 
User ID


 
 Example:  41458e5a-9092-40b7-9a26-d4eb43c5792f
query Parameters
limit
number  [ 1 .. 1000 ] 
 Default:  100
Range size of the list, default 100


 
 Example:  limit=2
cursor
string
Starting point for the list


 
 Example:  cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h
Responses 
200
User credentials retrieved


400
Bad Request


get/core/v1/users/{userId}/credentials
Request samples 
Response samples 
application/json
{
  • "data": [
    ],
  • "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
➔ Next to Compact Credentials