Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Het systeem maakt het mogelijk om nieuwe gebruikers aan te maken in BlueDolphin. Alleen de rol Administrators geeft de gebruiker de mogelijkheid om deze actie in het systeem uit te voeren. Hieronder vind je de stappen voor het aanmaken van een nieuwe gebruiker in BlueDolphin.
HTTP-responses
HTTP response status code | Interpretatie |
201 Created | Gebruiker succesvol aangemaakt |
400 Bad Request | Eén of meer parameters ontbreken of zijn onjuist. De response body geeft een specifieke foutmelding terug:
|
401 Unauthorized | Ongeldige of ontbrekende API key secret en/of tenant |
403 Forbidden | De gebruiker heeft geen adminrechten |
Om een nieuwe gebruiker aan te maken, doe je een POST-verzoek naar de /users endpoint met daarin:
Bedrijfsmiddel/endpoint bestemmings-URL
De header voor je API-verzoek
De request body, die het volgende moet bevatten:
Parameter | Vereist | Type | Standaard | Beschrijving |
✓ | string |
| Het emailadres van de gebruiker. Dit moet uniek zijn binnen de omgeving. | |
first_name | ✓ | string |
| De voornaam van de gebruiker. Moet minimaal 1 en maximaal 255 tekens bevatten. |
last_name | ✓ | string |
| De achternaam van de gebruiker. Moet minimaal 1 en maximaal 255 tekens bevatten. |
create_bluedolphin_user | X | boolean | false | Geeft aan dat de gebruiker moet worden aangemaakt in BlueDolphin IDP. Alleen nodig als er geen SSO wordt gebruikt. |
send_email_when_created | X | boolean | false | Geeft aan dat er bij het aanmaken een email moet worden gestuurd naar het opgegeven emailadres. |
Hieronder vind je een voorbeeld van een API-verzoek om een nieuwe gebruiker aan te maken in BlueDolphin:
curl -L 'https://public-api.eu.bluedolphin.app/v1/users' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json' \-d '{ "email": "[email protected]", "first_name": "Jemma", "last_name": "Wright", "create_bluedolphin_user": "false", "send_email_when_created": "false"}'
Response-eigenschappen
Eigenschap | Type | Beschrijving |
id | string | Unieke identificatie voor de gebruiker |
first_name | string | De voornaam van de gebruiker |
last_name | string | De achternaam van de gebruiker |
string | Het emailadres van de gebruiker | |
invite_id | string | Uitnodigings-ID in GUID-formaat dat de gebruiker moet gebruiken om de registratie te voltooien. Zodra de gebruiker zich registreert, is deze niet meer actief en wordt een lege waarde teruggegeven. |
roles | array | De rollen van de gebruiker |
roles[].id | string | Unieke identificatie voor de rol |
roles[].name | string | De naam van de rol |
roles[].internal_name | string | Interne naam van de rol |
avatar | string | De URL van de avatar van de gebruiker |
default_view_mode | boolean | Geeft aan of de standaardmodus van de gebruiker werksetmodus of bewerkmodus is |
Een geslaagde call geeft een response terug met een 201 OK HTTP-statuscode en de volgende body:
{ "id": "34b5765f315cf6edc527f9a3", "first_name": "Jemma", "last_name": "Wright", "email": "[email protected]", "invite_id": "3f9cb463-0b48-4c0f-8eae-57be53c16b81", "roles": [ { "id": "52f83f88b52c4efb3d7953b3", "name": "Default users", "internal_name": "users" }, { "id": "52f83f88b52c4efb3d7953b2", "name": "Administrators", "internal_name": "administrators" } ], "avatar": "https://www.gravatar.com/avatar/bce65ae227ae45e2396b572cd5e35b3a.jpg?d=https%3A%2F%2Fcdn.domain.app%2Fmedia%2Fimages%2Fdomain%2Fdefault_avatar.png", "default_view_mode": true}Er is nu een nieuwe gebruiker aangemaakt met het id 34b5765f315cf6edc527f9a3.