Kasutajate API

Siin saab hallata Kordoni kasutajakontosid, rolle ja seadistusi.

GET /users

Kõikide organisatsiooni kasutajate nimekiri.

curl --location GET \
--url "https://SINU_KORDONI_DOMEEN/api/v1/users" \
--header "Authorization: Bearer SINU_VÕTI"

Vastuse näide

Staatus: 200

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

POST /settings/users

Uue kasutaja loomine organisatsioonis.

Väli	Tüüp	Kohustuslik	Kirjeldus
email	string	Jah	Kasutaja e-posti aadress sisselogimiseks ja teavitusteks.
name	string	Jah	Täisnimi, mida kuvatakse kasutajaliideses ja teadetes.
role	string	Ei	Määratav roll: user (tavakasutaja), manager (haldur), auditor (audiitor) või admin (administraator). Vaikimisi user.
picture	string	Ei	URL kasutaja profiilipildile.
active	boolean	Ei	Määra true või false, et aktiveerida või peatada kasutaja konto. Vaikimisi true.

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

Vastuse näide

Staatus: 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

Olemasoleva kasutaja uuendamine.

{
    "user":
    {
        "name":"Uus Nimi"
    }
}

Vastus

{
    "data": {
        "id": "cbb02894-b4f0-49de-8561-2fe91daa4a37",
        "active": true,