Details

Get a user.

The user ID must be explicitly specified using the ecosystem ID which contains that user.

An account token or server token may be used to run this endpoint.

Parameters

path

ecosystemId (required): The ID of the ecosystem.
id (required): The unique ID of a user.

Responses

200

{
    "id": "ECOSYSTEM-ID;USER-NAME",
    "ecosystemId": "ECOSYSTEM-ID",
    "uniqueId": "USER-NAME",
    "meta": {},
    "email": "USER-EMAIL",
    "createdAt": "YYYY-MM-DD HH:MM:SS ENCODED",
    "access": [
        {
            "environmentId": "ENVIRONMENT-ID",
            "accessLevel": "ENVIRONMENT-ACCESS-LEVEL"
        }
    ]
}

400

No Query String Allowed: The standard error structure defines this error as invalid parameters, with additional parameters in the query string. In this context, it means that no query string is allowed at all when calling this endpoint.
Ecosystem Invalid: The standard error structure defines this error as invalid parameters, with an invalid ID linked to the parameter that designates the ecosystem ID. In this context, it means that the ID given for an ecosystem was not valid.

404

Ecosystem Not Found: This error means that an ecosystem with the given ID was not found. This is distinct from an invalid ecosystem ID being specified; this means that the ecosystem ID once existed, but no longer does.
User Not Found: This error means that user with the given ID was not found.

Examples

HTTP

GET https://ioe.droplit.io/api/users/ECOSYSTEM-ID;USER-ID HTTP/1.1
authorization: TOKEN

Droplit Console

droplit user read USER-ID

Droplit SDK

droplit.users.read("ECOSYSTEM-ID", "USER-ID");