gebruikers
De gebruikersresource vertegenwoordigt de eindgebruiker van de gegevens die zijn opgehaald uit de API. Als een app bijvoorbeeld de API gebruikt om mensen toegang te geven tot de iCloud-fotobibliotheek, is de eindgebruiker de gebruiker van die app.
Het is belangrijk om eindgebruikers consistent te identificeren om de hoogste niveaus van gegevensbeveiliging mogelijk te maken en de beste gebruikerservaring te garanderen.
attributen
| naam | type | Omschrijving |
|---|---|---|
id | gebruikersnaam | Bron-ID. |
resource | string, altijd user | Specificatie middelenbron. |
organisation | organisatie ID | De organisatie waartoe de resource behoort. |
key | sleutel ID | De sleutel waaraan de resource is gekoppeld. |
identifier | draad | Aangepaste waarde om de gebruiker te helpen identificeren en duplicatie te voorkomen. Dit kan bijvoorbeeld zijn ingesteld als het e-mailadres van de eindgebruiker. |
state | draad | Eén van: active , deactivated , blocked . |
date_created | datum Tijd | Wanneer de resource is gemaakt. |
Identifier
Het identifier kenmerk wordt niet door de API gebruikt, maar dient als brug tussen uw implementatie en de informatie die in de API is opgeslagen. De waarde van dit kenmerk moet het mogelijk maken om een gebruiker van uw systeem rechtstreeks in kaart te brengen met een gebruiker in de API. Dit kan een gebruikers-ID in uw systeem zijn of het e-mailadres van de eindgebruiker.
Staten
-
active - de standaardstatus van de gebruiker.
-
deactivated - de eigenaar heeft de toegang van deze gebruiker uitgeschakeld.
-
blocked - een API-beheerder heeft de toegang van deze gebruiker uitgeschakeld.
Maak POST /users
parameters
| naam | type | Omschrijving |
|---|---|---|
organisation | super | Laat API-beheerders gebruikers maken namens andere organisaties. |
key | standaard: de huidige sleutel | Wijs een gebruiker toe aan een afzonderlijke sleutel. Misschien eentje met minder rechten, bijvoorbeeld. |
identifier | vereist, string | Een stuk informatie om deze gebruiker te identificeren tegen een eindgebruiker in uw systeem. |
CURL gebruiken
curl https://ricloud-api.reincubate.com/users \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "identifier": "end-user@email.com" }'
Ricloud-py gebruiken
import ricloud user = ricloud.User.create(identifier='end-user@email.com')
Ophalen GET /users/{user ID}
CURL gebruiken
curl https://ricloud-api.reincubate.com/users/<user ID> \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
import ricloud user = ricloud.User.retrieve(<user ID>)
Lijst GET /users
parameters
| naam | type | Omschrijving |
|---|---|---|
key | sleutel ID | Filter de gebruikers op de sleutel waaraan ze zijn gekoppeld. |
identifier | draad | Filter de gebruikers op hun ID. |
state | draad | Filter de gebruikers op hun staat. |
date_created | datetime filter | Filter op resource-aanmaakdatum. |
CURL gebruiken
curl https://ricloud-api.reincubate.com/users \ -H 'Authorization: Token <your key_token>'
Ricloud-py gebruiken
import ricloud users = ricloud.User.list()
Update POST /users/{user ID}
parameters
| naam | type | Omschrijving |
|---|---|---|
key | sleutel ID | Verplaats de gebruiker om aan een andere sleutel te worden gekoppeld. Bijvoorbeeld als ze updaten vanuit een proefversie. |
identifier | draad | Update de gebruikers-ID. |
state | draad | Werk de status van de gebruiker bij, ofwel deactivated of weer active . |
CURL gebruiken
curl https://ricloud-api.reincubate.com/users/<user ID> \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "state": "deactivated" }'
Ricloud-py gebruiken
import ricloud user = ricloud.User.update_with_id(<user ID>, state='deactivated') # OR user = ricloud.User.retrieve(<user ID>) user.update(state='deactivated')
