Get All Users

Get All Users

This endpoint retrieves a list of all users in the system.
Authorized Roles : SYSTEM_ADMIN or INFRA_ADMIN or DSM_ADMIN

Request
URI
GET
https://{api_host}/provider/users
COPY
Query Parameters
page
Optional
Constraints: default: 0

Zero-based page index (0..N)

size
Optional
Constraints: default: 20

The size of the page to be returned

sort
Optional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

string
userSearchInput
Optional

Filter based on email


Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved the list of users.

Returns PagedModel of type(s) application/vnd.vmware.dms-v1+json
{
    "_embedded": {
        "objects": [
            {}
        ]
    },
    "_links": {
        "_links": {
            "href": "string",
            "hreflang": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string",
            "templated": false
        }
    },
    "page": {
        "size": 0,
        "totalElements": 0,
        "totalPages": 0,
        "number": 0
    }
}
object
_embedded
Optional

_embedded

object
_links
Optional

_links

page
Optional

page


400

Bad request. The provided input data is invalid.

Returns ErrorDto of type(s) application/vnd.vmware.dms-v1+json
"ErrorDto Object"
string
message
Optional

message

object
errorCodes
Optional

errorCodes


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/provider/users