Users API

Manage user accounts, roles, and configurations in your Kordon instance.

GET /users

Get a list of all users in your organisation.

curl --location GET \
--url "https://YOUR_KORDON_DOMAIN/api/v1/users" \
--header "Authorization: Bearer YOUR-TOKEN"

Example Response

Status: 200

{
    "data": [
        {
            "id": "98dcb717-al70-4c89-8246-0bb026wc215b",
            "active": true,
            "email": "jaana@example.com",
            "name": "Jaana Manana",
            "picture": null,
            "role": "user"
        }
    ]
}

POST /settings/users

Create a new user in your organisation.

Field	Type	Required	Description
email	string	Yes	User’s email address used for login and notifications.
name	string	Yes	Full name shown in the UI and notifications.
role	string	No	Role to assign, such as user, manager, auditor or admin. Defaults to user.
picture	string	No	URL to the user’s profile picture.
active	boolean	No	Set to true or false to activate or suspend the user. Defaults to true.

curl --location --request POST 'https://YOUR_KORDON_DOMAIN/api/v1/settings/users' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-TOKEN' \
--data '{
    "name": "Jaana Banana",
    "email":"jaana+todododo@example.com"
}'

Example Response

Status: 200

{
    "data": {
        "id": "cbb02894-b4f0-49de-8561-2fe91daa4a37",
        "active": true,
        "email": "jaana+todododo@example.com",
        "name": "Jaana Banana",
        "picture": null,
        "role": "user"
    },
    "meta": {
        "total_count": 1,
        "page": 1,
        "permissions": {
            "create": true
        },
        "per_page": 10
    }
}

PATCH /settings/users/:id:

Update an existing user.

{
    "user":
    {
        "name":"Let's Change The Name"
    }
}

Response

{
    "data": {
        "id": "cbb02894-b4f0-49de-8561-2fe91daa4a37",
        "active": true,
        "email": "jaana+todododo@example.com",
        "name": "Let's Change The Name",
        "picture": null,
        "role": "user"
    },
    "meta": {
        "total_count": 1,
        "page": 1,
        "permissions": {
            "create": true
        },
        "per_page": 10
    }
}

DEL /settings/users/:id:

It is not possible to delete users. You should deactivate users instead.

PATCH /settings/users/:id:

Deactivate an user.

{
    "id": "cbb02894-b4f0-49de-8561-2fe91daa4a37",
    "active":false
}