Utilisateurs
La ressource utilisateur représente l'utilisateur final des données extraites de l'API. Par exemple, si une application utilise l'API pour permettre aux utilisateurs d'accéder aux photos iCloud Photo Library, l'utilisateur final est l'utilisateur de cette application.
Il est important d'identifier systématiquement les utilisateurs finaux afin de garantir les plus hauts niveaux de sécurité des données et de garantir la meilleure expérience utilisateur.
Les attributs
| prénom | type | la description |
|---|---|---|
id | identifiant d'utilisateur | Identifiant de ressource. |
resource | chaîne, toujours user | Spécificateur de type de ressource. |
organisation | ID d'organisation | L'organisation à laquelle la ressource appartient. |
key | ID clé | La clé à laquelle la ressource est associée. |
identifier | chaîne | Valeur personnalisée permettant d'identifier l'utilisateur et d'éviter les doublons. Par exemple, il peut s'agir de l'adresse de messagerie de l'utilisateur final. |
state | chaîne | Un des éléments suivants: active , deactivated , blocked . |
date_created | date / heure | Quand la ressource a été créée. |
Identifiant
L'attribut identifier n'est pas utilisé par l'API mais doit servir de pont entre votre implémentation et les informations stockées dans l'API. La valeur de cet attribut doit permettre un mappage direct d'un utilisateur de votre système avec un utilisateur sur l'API. Il peut s’agir d’un ID utilisateur de votre système ou de l’adresse électronique de l’utilisateur final.
États
-
active - l'état standard de l'utilisateur.
-
deactivated - l'organisation propriétaire a désactivé l'accès de cet utilisateur.
-
blocked - un administrateur de l'API a désactivé l'accès de cet utilisateur.
Créer POST /users
Paramètres
| prénom | type | la description |
|---|---|---|
organisation | super | Permet aux administrateurs d'API de créer des utilisateurs pour le compte d'autres organisations. |
key | défaut: la clé courante | Affecter un utilisateur à une clé distincte. Peut-être un avec moins d'autorisations, par exemple. |
identifier | obligatoire, chaîne | Une information permettant d'identifier cet utilisateur par rapport à un utilisateur final de votre système. |
Utiliser cURL
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" }'
Utiliser ricloud-py
import ricloud user = ricloud.User.create(identifier='end-user@email.com')
Récupérer GET /users/{user ID}
Utiliser cURL
curl https://ricloud-api.reincubate.com/users/<user ID> \ -H 'Authorization: Token <your key_token>'
Utiliser ricloud-py
import ricloud user = ricloud.User.retrieve(<user ID>)
Liste GET /users
Paramètres
| prénom | type | la description |
|---|---|---|
key | ID clé | Filtrez les utilisateurs en fonction de la clé à laquelle ils sont associés. |
identifier | chaîne | Filtrer les utilisateurs par leur identifiant. |
state | chaîne | Filtrer les utilisateurs par leur état. |
date_created | filtre datetime | Filtrer par date de création de la ressource. |
Utiliser cURL
curl https://ricloud-api.reincubate.com/users \ -H 'Authorization: Token <your key_token>'
Utiliser ricloud-py
import ricloud users = ricloud.User.list()
Mise à jour du POST /users/{user ID}
Paramètres
| prénom | type | la description |
|---|---|---|
key | ID clé | Déplacez l'utilisateur pour qu'il soit associé à une autre clé. Par exemple, s’ils mettent à jour à partir d’un essai. |
identifier | chaîne | Mettez à jour l'identifiant de l'utilisateur. |
state | chaîne | Mettez à jour l'état de l'utilisateur, soit deactivated soit active . |
Utiliser cURL
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" }'
Utiliser 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')
