ListUsers
Search Users
Search for users. By default, we will return all users of your instance that you have permission to read. Make sure to include a limit and sorting for pagination.
Request Body
application/json
query?
list limitations and ordering
sortingColumn?string
the field the result is sorted
Value in
"USER_FIELD_NAME_UNSPECIFIED" | "USER_FIELD_NAME_USER_NAME" | "USER_FIELD_NAME_FIRST_NAME" | "USER_FIELD_NAME_LAST_NAME" | "USER_FIELD_NAME_NICK_NAME" | "USER_FIELD_NAME_DISPLAY_NAME" | "USER_FIELD_NAME_EMAIL" | "USER_FIELD_NAME_STATE" | "USER_FIELD_NAME_TYPE" | "USER_FIELD_NAME_CREATION_DATE"queries?
criteria the client is looking for
[key: string]?never
Response Body
application/json
application/json
curl -X POST "https://loading/v2/users" \ -H "Content-Type: application/json" \ -d '{}'{
"details": {
"totalResult": 0,
"processedSequence": 0,
"timestamp": "1s"
},
"sortingColumn": "USER_FIELD_NAME_UNSPECIFIED",
"result": [
{
"userId": "string",
"details": {
"sequence": 0,
"changeDate": "1s",
"resourceOwner": "string",
"creationDate": "1s"
},
"state": "USER_STATE_UNSPECIFIED",
"username": "string",
"loginNames": [
"string"
],
"preferredLoginName": "string",
"human": {
"userId": "string",
"state": "USER_STATE_UNSPECIFIED",
"username": "string",
"loginNames": [
"string"
],
"preferredLoginName": "string",
"profile": {
"givenName": "string",
"familyName": "string",
"nickName": "string",
"displayName": "string",
"preferredLanguage": "string",
"gender": "GENDER_UNSPECIFIED",
"avatarUrl": "string"
},
"email": {
"email": "string",
"isVerified": true
},
"phone": {
"phone": "string",
"isVerified": true
},
"passwordChangeRequired": true,
"passwordChanged": "1s",
"mfaInitSkipped": "1s"
}
}
]
}{
"code": "not_found",
"message": "string",
"detail": {
"type": "string",
"value": "string",
"debug": {}
}
}Was this page helpful?