Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Retrieves all user documents.

HTTP GET /ctreplay/:domain?/getUsers

Path variables:

Name

Mandatory

Type

Description

domain

NO

STRING

Unique domain identifier

Authorization: BEARER

Response:

Type: JSON

Name

Type

Description

result

BOOLEAN

If true, the service response was performed correctly

error

NULL / STRING

Contains the error description if an error has occurred in the request

documents

OBJECT

list of user objects

Example:

Request:

http://<hostname>:<port>/ctreplay/default/getUsers

Response:

{
    "result": true,
    "documents": [
        {
            "_id": "5eeb47d019eb88cfb639fecd",
            "__v": 0,
            "role": "admin",
            "profile": "5eea3d2919eb88cfb639fecb",
            "user": "admin"
        },
        {
            "_id": "5eeb856a5bdd4841745497e6",
            "__v": 0,
            "role": "user",
            "profile": "5eeb85035bdd4841745497e3",
            "user": "gverde1"
        }
    ],
    "error": null
}
  • No labels