Gegevens uit het domein "users" stellen een gebruiker binnen een account voor. Een gebruiker vertegenwoordigt een persoon die kan aanmelden op het account.
Het is niet mogelijk om een bestaande gebruiker aan te passen via de API. Enkel de volgende acties worden ondersteund:
Alle gebruikers ophalen
Een gebruiker toevoegen
Een gebruiker verwijderen
Opbouw URL:
Domein: users
| Veldnaam | Type | Omschrijving | Voorbeeld |
| user_hash | text | unieke hash van de gebruiker | aBc4e |
| user_id | int | unieke id van de gebruiker. Niet beschikbaar in status pending. | 123 |
| name | text | Naam van de gebruiker | Jan Desmet |
| email_address | text | E-mailadres van de gebruiker | jan@domain.be |
| status | text | Status van de gebruiker. Mogelijke waarden: owner (hoofdgebruiker), active (actief), activate (wacht op activatie), pending (wacht op goedkeuring) | active |
| rights | list | Rechten van de gebruiker. Standaard "all". | all |
Voorbeeld in JSON:
{
"user_hash": "aBc4e",
"user_id": 123,
"name": "Jan Desmet",
"email_address": "jan@domain.be",
"status": "active",
"rights": [
"quotes", "projects"
]
}Gebruiker toevoegen
Gebruikers kunnen worden toegevoegd via een POST-aanvraag naar: /api/v1/users
Je kan een nieuwe gebruiker aanmaken of een bestaande gebruiker toevoegen aan een account.
Of het om een nieuwe of bestaande gebruiker gaat, wordt automatisch bepaald op basis van het opgegeven e-mailadres. Je hoeft dus enkel het e-mailadres van de gebruiker mee te geven.
Wachtwoord of activatiemail
Bij het toevoegen van een nieuwe gebruiker heb je twee mogelijkheden:
Zonder wachtwoord: de gebruiker ontvangt automatisch een activatiemail om een wachtwoord in te stellen.
Met wachtwoord: de gebruiker kan meteen inloggen met het opgegeven wachtwoord. In dit geval wordt geen activatiemail verstuurd.
Bij het toevoegen van een bestaande gebruiker:
Kan je geen wachtwoord opgeven.
Wordt er altijd een activatiemail verstuurd om toegang tot het account te bevestigen.
Voorbeelden
1. Gebruiker toevoegen met activatiemail:
{
"name": "Jan Desmet",
"email_address": "jan@domain.be"
}2. Gebruiker toevoegen met wachtwoord en rechten:
{
"name": "Jan Desmet",
"email_address": "jan@domain.be",
"password": "-MySecretPassword-",
"rights": ["invoices", "read_subscriptions", "bank"]
}3. Gebruiker toevoegen met SSO (automatische aanmelding):
{
"name": "Jan Desmet",
"email_address": "jan@domain.be",
"password": "-MySecretPassword-",
"sso": [{"identity": "1111111111111", "type": "google", "username": "Jan Desmet"}]
}Gebruiker verwijderen
Om een gebruiker te verwijderen, gebruik je de user_hash en voer je een DELETE-aanvraag uit naar: /api/v1/users/{user_hash}
Opmerking: De hoofdgebruiker van een account kan niet worden verwijderd.