Benutzer
Die Benutzerressource repräsentiert den Endbenutzer der von der API abgerufenen Daten. Wenn eine App beispielsweise die API verwendet, um Benutzern den Zugriff auf iCloud Photo Library-Fotos zu ermöglichen, ist der Endbenutzer der Benutzer dieser App.
Es ist wichtig, Endbenutzer konsistent zu identifizieren, um ein Höchstmaß an Datensicherheit zu gewährleisten und die bestmögliche Benutzererfahrung zu gewährleisten.
Attribute
| Name | Art | Beschreibung |
|---|---|---|
id | Benutzeridentifikation | Ressourcenkennung. |
resource | Zeichenfolge, immer user | Ressourcentypbezeichner. |
organisation | Organisations-ID | Die Organisation, zu der die Ressource gehört. |
key | Schlüssel-ID | Der Schlüssel, dem die Ressource zugeordnet ist. |
identifier | Zeichenfolge | Benutzerdefinierter Wert zur Identifizierung des Benutzers und zur Vermeidung von Duplikaten. Dies kann beispielsweise die E-Mail-Adresse des Endbenutzers sein. |
state | Zeichenfolge | Einer von: active , deactivated , blocked . |
date_created | Terminzeit | Wann wurde die Ressource erstellt. |
Kennung
Das identifier wird von der API nicht verwendet, sollte jedoch als Brücke zwischen Ihrer Implementierung und den in der API gespeicherten Informationen dienen. Der Wert dieses Attributs sollte eine direkte Zuordnung eines Benutzers Ihres Systems zu einem Benutzer auf der API ermöglichen. Dies kann eine Benutzer-ID in Ihrem System oder die E-Mail-Adresse des Endbenutzers sein.
Zustände
-
active - der Standardzustand des Benutzers.
-
deactivated - Die Eigentümerorganisation hat den Zugriff dieses Benutzers deaktiviert.
-
blocked - Ein API-Administrator hat den Zugriff dieses Benutzers deaktiviert.
Erstellen Sie POST /users
Parameter
| Name | Art | Beschreibung |
|---|---|---|
organisation | Super | Ermöglicht es API-Administratoren, Benutzer im Namen anderer Organisationen zu erstellen. |
key | Standard: Der aktuelle Schlüssel | Weisen Sie einen Benutzer einem separaten Schlüssel zu. Zum Beispiel eine mit weniger Berechtigungen. |
identifier | erforderlich, Zeichenfolge | Eine Information, um diesen Benutzer gegen einen Endbenutzer in Ihrem System zu identifizieren. |
CURL verwenden
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" }'
Mit Ricloud-Py
import ricloud user = ricloud.User.create(identifier='end-user@email.com')
GET /users/{user ID}
CURL verwenden
curl https://ricloud-api.reincubate.com/users/<user ID> \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud user = ricloud.User.retrieve(<user ID>)
Liste GET /users
Parameter
| Name | Art | Beschreibung |
|---|---|---|
key | Schlüssel-ID | Filtern Sie die Benutzer nach dem Schlüssel, dem sie zugeordnet sind. |
identifier | Zeichenfolge | Filtern Sie die Benutzer nach ihrer Kennung. |
state | Zeichenfolge | Filtern Sie die Benutzer nach ihrem Status. |
date_created | Datum / Uhrzeit-Filter | Filtern nach Erstellungsdatum der Ressource. |
CURL verwenden
curl https://ricloud-api.reincubate.com/users \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud users = ricloud.User.list()
POST /users/{user ID}
Parameter
| Name | Art | Beschreibung |
|---|---|---|
key | Schlüssel-ID | Bewegen Sie den Benutzer, der einem anderen Schlüssel zugeordnet werden soll. Zum Beispiel, wenn sie von einer Testversion aktualisieren. |
identifier | Zeichenfolge | Aktualisieren Sie die Benutzerkennung. |
state | Zeichenfolge | Aktualisieren Sie den Status des Benutzers, entweder deactivated oder zurück zu active . |
CURL verwenden
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" }'
Mit Ricloud-Py
import ricloud user = ricloud.User.update_with_id(<user ID>, state='deactivated') # OR user = ricloud.User.retrieve(<user ID>) user.update(state='deactivated')
