Get Users

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 User
elements
Optional

The list of elements included in this page

PageMetadata
pageMetadata
Optional

Represents pageable elements pagination metadata


400

Bad request

Returns ErrorResponse of type(s) application/json 
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken


401

Unauthorized Request

Returns ErrorResponse of type(s) application/json 
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken


500

Internal Server Error

Returns ErrorResponse of type(s) application/json 
{
    "errorCode": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "cause": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "ErrorResponse Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

errorCode

array of string
arguments
Optional

arguments

object
context
Optional

context

string
message
Optional

message

string
remediationMessage
Optional

remediationMessage

array of ErrorCause
cause
Optional

cause

array of ErrorResponse
nestedErrors
Optional

nestedErrors

string
referenceToken
Optional

referenceToken


On This Page
Users Operations
POST
Add Users
DELETE
Disable Local Account
GET
Get Local Account
GET
Get Roles
GET
Get SSO Domain Entities
GET
Get SSO Domains
GET
Get Ui Users
GET
Get Users
DELETE
Remove User
PATCH
Update Local User Password