Viewing user list
- Print
- PDF
Viewing user list
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
You can view a user list.
Requests
- GET /users
Request parameters
| Parameters | Requirement status | Type | Description | Restrictions |
|---|---|---|---|---|
| searchColumn | N | String | Search column | loginId, status, nrn, userId |
| searchWord | N | String | Search keyword | |
| page | N | int | Page number | Default: 0 |
| size | N | int | List size | Default: 20 |
Responses
Response bodies
{
"page" : "integer",
"totalPages" : "integer",
"totalItems" : "integer",
"hasPrevious" : "boolean",
"hasNext" : "boolean",
"items" : [ {
"userId" : "string",
"loginId" : "string",
"nrn" : "string",
"userProfile" : {
"firstName" : "string",
"lastName" : "string",
"email" : "string",
"emailVerified" : "boolean",
"empNo" : "string",
"phoneCountryCode" : "string",
"phoneNo" : "string",
"phoneNoVerified" : "boolean",
"deptName" : "string"
},
"accessRules" : {
"consoleAccessAllowed" : "boolean",
"apiAccessAllowed" : "boolean"
},
"status" : "string",
"description" : "string",
"lastLoginAt" : "string",
"createdAt" : "string",
"updatedAt" : "string"
} ],
"isFirst" : "boolean",
"isLast" : "boolean"
}
| Parameters | Type | Description | Restrictions |
|---|---|---|---|
| page | Number | Page of the returned result | |
| totalPages | Number | totalPage of the returned result | |
| totalItems | Number | totalItems of the returned result | |
| hasPrevious | Boolean | Whether the current page has a previous page | |
| hasNext | Boolean | Whether the current page has a next page | |
| isFirst | Boolean | Whether the current page is the first page | |
| isLast | Boolean | Whether the current page is the last page | |
| items.[].userId | String | User ID | |
| items.[].loginId | String | Login ID (email) | |
| items.[].nrn | String | nrn of the created user | |
| items.[].userProfile | Object | User profile | |
| items.[].userProfile.firstName | String | First name | |
| items.[].userProfile.lastName | String | Last name | |
| items.[].userProfile.email | String | ||
| items.[].userProfile.emailVerified | Boolean | Email verification status | |
| items.[].userProfile.empNo | String | Employee number | |
| items.[].userProfile.phoneCountryCode | String | Country code for mobile phone number | |
| items.[].userProfile.phoneNo | String | Mobile phone number | |
| items.[].userProfile.phoneNoVerified | Boolean | Mobile phone number verification status | |
| items.[].userProfile.deptName | String | Department name | |
| items.[].accessRules | Object | Access rules | |
| accessRules.consoleAccessAllowed | Boolean | Whether console access is allowed | |
| items.[].accessRules.apiAccessAllowed | Boolean | Whether API access is allowed | |
| items.[].status | String | User status (active, suspended, deleted) | |
| items.[].lastLoginAt | String | Last login time (UTC, e.g., 2023-04-25T13:11:50Z) | |
| items.[].createdAt | String | Creation time (UTC, e.g., 2023-04-25T13:11:50Z) | |
| items.[].updatedAt | String | Edit time (UTC, e.g., 2023-04-25T13:11:50Z) | |
| items.[].description | String | User description |
Errors
Errors that may occur while using this action are listed below. For error response format, see ErrorResponse.
For more information on common errors, see NAVER Cloud Platform API.
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | 400 | Invalid request. |
Was this article helpful?