Dit artikel is vertaald met behulp van AI en kan kleine onnauwkeurigheden bevatten. Raadpleeg de Engelse versie voor volledige nauwkeurigheid.
Dit zijn de stappen om een specifieke gebruiker te vinden in BlueDolphin. Alleen de Admin-rol in BlueDolphin kan andere gebruikers uit het systeem ophalen.
HTTP-responses
HTTP response status code | Interpretatie |
200 OK | Gebruiker succesvol opgehaald |
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 specifieke gebruiker uit het systeem op te halen, doe je een GET-verzoek naar de /users/{id} endpoint met:
Resource/endpoint bestemming URL. Vervang de padparameter {id} door de ID van de bestaande gebruiker die je wilt ophalen.
De header voor je API-verzoek
In dit voorbeeld willen we de gebruiker met de gebruikers-ID 41b4433f326cf6efc524f7b7 ophalen. Om de gebruiker op te halen, sturen we een GET-verzoek naar de URI https://public-api.eu.bluedolphin.app/v1/users/41b4433f326cf6efc524f7b7.
curl -L 'https://public-api.eu.bluedolphin.app/v1/users/41b4433f326cf6efc524f7b7' \-H 'x-api-key: YOURAPIKEYSECRET' \-H 'tenant: yourtenantname' \-H 'Content-Type: application/json'
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 | De email van de gebruiker | |
invite_id | string | Invite ID die 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 | De 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 oproep geeft een response met een 200 OK HTTP-statuscode en de volgende body terug:
{ "id": "41b4433f326cf6efc524f7b7", "first_name": "Jack", "last_name": "White", "email": "[email protected]", "invite_id": "", "roles": [ { "id": "52f83f88b52c4efb3d7953b3", "name": "Standaard gebruikers", "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}