MATTR VII PlatformUsers
Search users
Returns a list of users from the tenant that match all the provided search criteria (all criteria are optional).
Analytics Events
USER_SEARCH_STARTUSER_SEARCH_SUCCESSUSER_SEARCH_FAIL
Roles
adminissuer
POST
/v1/users/searchAuthorizationBearer <token>
In: header
The search criteria
claims?object
Filter users by claims. Nested objects are supported. Text values must be an exact match.
Empty Object
authenticationProvider?object
Filter users by their unique identifier in the configured Authentication Provider.
limit?number
Range size of returned entries, default 100
Range
1 <= value <= 1000cursor?string
Starting point for the range of entries
Response Body
curl -X POST "https://example.vii.au01.mattr.global/v1/users/search" \ -H "Content-Type: application/json" \ -d '{}'{
"nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM",
"data": [
{
"id": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba",
"claims": {
"externalUserId": "0c3fad74-a8df-4a2d-8e75-f2d356b413ba"
},
"authenticationProvider": {
"providerId": "41458e5a-9092-40b7-9a26-d4eb43c5792f",
"url": "https://example-university.au.auth0.com",
"subjectId": "example-university-oauth2|123456789"
}
}
]
}{
"code": "string",
"message": "string",
"details": [
{
"value": "string",
"msg": "Invalid value",
"param": "id",
"location": "body"
}
]
}How would you rate this page?