Usuarios
El recurso de usuario representa el usuario final de los datos recuperados de la API. Por ejemplo, si una aplicación está utilizando la API para permitir que las personas accedan a las fotos de iCloud Photo Library, el usuario final es el usuario de esa aplicación.
Es importante identificar a los usuarios finales de manera consistente para permitir los niveles más altos de seguridad de datos y garantizar la mejor experiencia de usuario.
Atributos
| nombre | tipo | descripción |
|---|---|---|
id | ID de usuario | Identificador de recursos. |
resource | cadena, siempre user | Especificador de tipo de recurso. |
organisation | ID de organización | La organización a la que pertenece el recurso. |
key | ID de clave | La clave con la que está asociado el recurso. |
identifier | cuerda | Valor personalizado para ayudar a identificar al usuario y evitar la duplicación. Por ejemplo, esto podría configurarse para que sea la dirección de correo electrónico del usuario final. |
state | cuerda | Uno de: active , deactivated , blocked . |
date_created | fecha y hora | Cuando el recurso fue creado. |
Identificador
La API no utiliza el atributo identifier pero debe servir como un puente entre su implementación y la información almacenada en la API. El valor de este atributo debe permitir una asignación directa de un usuario de su sistema con un usuario en la API. Puede ser una ID de usuario dentro de su sistema o la dirección de correo electrónico del usuario final.
Estados
-
active - Estado estándar del usuario.
-
deactivated - La organización propietaria ha deshabilitado el acceso de este usuario.
-
blocked - un administrador de API ha deshabilitado el acceso de este usuario.
Crear POST /users
Parámetros
| nombre | tipo | descripción |
|---|---|---|
organisation | súper | Permite a los administradores de API crear usuarios en nombre de otras organizaciones. |
key | por defecto: la clave actual | Asignar un usuario a una clave separada. Tal vez uno con menos permisos, por ejemplo. |
identifier | requerido, cadena | Una información para identificar a este usuario contra un usuario final en su sistema. |
Usando 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" }'
Utilizando ricloud-py
import ricloud user = ricloud.User.create(identifier='end-user@email.com')
Recuperar GET /users/{user ID}
Usando cURL
curl https://ricloud-api.reincubate.com/users/<user ID> \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud user = ricloud.User.retrieve(<user ID>)
Lista GET /users
Parámetros
| nombre | tipo | descripción |
|---|---|---|
key | ID de clave | Filtra a los usuarios por la clave con la que están asociados. |
identifier | cuerda | Filtrar los usuarios por su identificador. |
state | cuerda | Filtra a los usuarios por su estado. |
date_created | filtro de fecha y hora | Filtrar por fecha de creación del recurso. |
Usando cURL
curl https://ricloud-api.reincubate.com/users \ -H 'Authorization: Token <your key_token>'
Utilizando ricloud-py
import ricloud users = ricloud.User.list()
Actualizar POST /users/{user ID}
Parámetros
| nombre | tipo | descripción |
|---|---|---|
key | ID de clave | Mueve al usuario para que se asocie con una clave diferente. Por ejemplo, si se actualizan desde una prueba. |
identifier | cuerda | Actualizar el identificador de los usuarios. |
state | cuerda | Actualice el estado del usuario, ya sea a deactivated o de nuevo a active . |
Usando 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" }'
Utilizando 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')
