Get Users
Get a list of all users
Request
URI
GET
https://{api_host}/v1/users
COPY
Responses
200
OK
Returns
PageOfUser
of type(s)
application/json
{
"elements": [
{
"id": "string",
"name": "string",
"domain": "string",
"type": "One among: USER, GROUP, SERVICE",
"apiKey": "string",
"role": {
"id": "string"
},
"creationTimestamp": "string"
}
],
"pageMetadata": {
"pageNumber": 0,
"pageSize": 0,
"totalElements": 0,
"totalPages": 0
}
}
array of
object
elements
Optional
The list of elements included in this page
object
pageMetadata
Optional
Represents pageable elements pagination metadata
400
Bad request
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
string
errorCode
Optional
errorCode
array of
string
arguments
Optional
arguments
object
context
Optional
context
string
message
Optional
message
string
remediationMessage
Optional
remediationMessage
array of
object
cause
Optional
Describes a single error cause
string
referenceToken
Optional
referenceToken
401
Unauthorized Request
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
string
errorCode
Optional
errorCode
array of
string
arguments
Optional
arguments
object
context
Optional
context
string
message
Optional
message
string
remediationMessage
Optional
remediationMessage
array of
object
cause
Optional
Describes a single error cause
string
referenceToken
Optional
referenceToken
500
Internal Server Error
Returns
ErrorResponse
of type(s)
application/json
"ErrorResponse Object"
string
errorCode
Optional
errorCode
array of
string
arguments
Optional
arguments
object
context
Optional
context
string
message
Optional
message
string
remediationMessage
Optional
remediationMessage
array of
object
cause
Optional
Describes a single error cause
string
referenceToken
Optional
referenceToken
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/v1/users