-
Notifications
You must be signed in to change notification settings - Fork 0
GetClient
Luis Huertas edited this page Feb 7, 2022
·
1 revision
Select a list of users
Base Url : http://your-app-base-url.com
Endpoint : /auth/client/
Method : GET
Auth required : Yes
header key | header value | description |
---|---|---|
Authorization | BEARER jwtToken | access_token generated using /token
|
Permissions required : Access string 'OAUTH2_user:select'
type: query
{
"itemsPerPage": 5,
"pageIndex": 0,
"order": "desc"
}
Request Fields Description
key | value | description |
---|---|---|
itemsPerPage | 5 | users per page |
pageIndex | 0 | pagination page index |
order | desc | pagination order |
{
"code": 200000,
"message": "Select completed",
"content": {
"items": [
{
"id": 1,
"subjectId": 1,
"description": "User description",
"name": "User name",
"identifier": "clientIdentifier",
"hasLongLiveToken": false,
"revoked": false,
"roles": [
{
"id": 1,
"identifier": "roleIdentifier",
"parts": [
{
"id": 1,
"applicationPartName": "applicationPartIdentifier",
"allowed": ["*", "select", "create", "update", "delete"]
}
]
}
]
}
],
"pageIndex": 0,
"itemsPerPage": 5,
"totalItems": 1,
"totalPages": 1
}
}
Response Fields Description
key | value | description |
---|---|---|
code | 200000 | result code |
message | Select completed | result message |
content | Object | the user select pagination |
pageIndex | 0 | the page position index |
itemsPerPage | 5 | users per page |
totalItems | 1 | total users |
totalPages | 1 | total pages of the pagination |
items | Array of user object | The list of users |
Response codes
- If response is success, http status will be 200 and code in body will be 200000
code | description |
---|---|
500000 | Not categorized error |
200000 | client list selected |