Get All Users

Get All Users

Use this endpoint to retrieve list of all the users
Authorized Roles : PROVIDER or ORG_ADMIN

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

Zero-based page index (0..N)

integer
size
Optional

The size of the page to be returned

string of array
sort
Optional

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

string
tenantId
Optional

Filter based on organization ID

string
userSearchInput
Optional

Filter based on email/firstname/lastname


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedModelDmsUserResponseDto of type(s) application/vnd.vmware.dms-v1+json
{
    "links": [
        {
            "rel": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string"
        }
    ],
    "content": [
        {
            "id": 0,
            "firstName": "string",
            "lastName": "string",
            "contactNumber": "string",
            "email": "string",
            "tenantId": "string",
            "companyName": "string",
            "roles": [
                "string"
            ],
            "type": "string",
            "links": [
                {
                    "rel": "string",
                    "href": "string",
                    "hreflang": "string",
                    "media": "string",
                    "title": "string",
                    "type": "string",
                    "deprecation": "string",
                    "profile": "string",
                    "name": "string"
                }
            ]
        }
    ],
    "page": {
        "size": 0,
        "totalElements": 0,
        "totalPages": 0,
        "number": 0
    }
}
array of Link
links
Optional

links

content
Optional

content


400

Bad Request

Operation doesn't return any data structure