Users

Get Users

Endpoint:

URL	`/api/v2/users/`
Method	`GET`
Expected response code	`200`
Expected response type	`JSON`

Example:

BASH

curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/users/

Example response:

User list JSON

JSON

{
    "meta": {
        "limit": 20,
        "next": "/api/v2/users/?limit=20&offset=20",
        "offset": 0,
        "previous": null,
        "total_count": 3
    },
    "objects": [
        {
            "first_name": "John",
            "last_name": "Doe",
            "resource_uri": "/api/v2/users/johndoe/",
            "user_type": "Internal user",
            "username": "johndoe"
        },
        {
            "first_name": "John",
            "last_name": "Snow",
            "resource_uri": "/api/v2/users/johnsnow/",
            "user_type": "Internal user",
            "username": "johnsnow"
        },
        {
            "first_name": "John",
            "last_name": "Wick",
            "resource_uri": "/api/v2/users/johnwick/",
            "user_type": "Internal user",
            "username": "johnwick"
        }
    ]
}

Get User details

Endpoint:

URL	`/api/v2/user/$username/`
Method	`GET`
Expected response code	`200`
Expected response type	`JSON`

URL parameters:

username – is a unique username of a CoreData user.

Example:

BASH

username=Administrator

curl -v \
    -H "Authorization: apikey $API_USER:$API_KEY" \
    $COREDATA_BASE_URL/api/v2/user/$username/

Example response:

User details JSON

JSON

{
    "first_name": "Administrator",
    "last_name": "Administrator",
    "resource_uri": "/api/v2/user/Administrator/",
    "user_type": "Administrator",
    "username": "Administrator"
}

Current User

For more information see Current User.

Other operations on users

The other HTTP methods like POST and DELETE are forbidden, so it is not possible to modify or delete a user via CoreData API.