listUsersNode.js,latest
Go to NPMLists all users.
Parameters
input
object
Represents the input parameters for listing users.
from
string
Start time of the query, inclusive.
pageAfter
string
Used to return items after the specified item exclusively.
SHOULD NOT be used in conjunction with pageBefore.
pageBefore
string
Used to return items before the specified item exclusively.
SHOULD NOT be used in conjunction with pageAfter.
pageSize
number
The number of items to return.
to
string
End time of the query, inclusive. Defaults to the current time.
Responses
Example
1const response = await client.listUsers()
2console.log(response.data?.users)ResponseChoose an example
1{
2 "data": {
3 "users": [
4 {
5 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
6 "createDate": "2023-01-01T12:04:05Z",
7 "pinStatus": "ENABLED",
8 "status": "ENABLED",
9 "securityQuestionStatus": "ENABLED",
10 "pinDetails": {
11 "failedAttempts": 0,
12 "lockedDate": "2023-01-01T12:04:05Z",
13 "lockedExpiryDate": "2023-01-01T12:04:05Z",
14 "lastLockOverrideDate": "2023-01-01T12:04:05Z"
15 },
16 "securityQuestionDetails": {
17 "failedAttempts": 0,
18 "lockedDate": "2023-01-01T12:04:05Z",
19 "lockedExpiryDate": "2023-01-01T12:04:05Z",
20 "lastLockOverrideDate": "2023-01-01T12:04:05Z"
21 }
22 }
23 ]
24 }
25}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
