Comercial
O recurso do usuário representa o usuário final dos dados recuperados da API. Por exemplo, se um aplicativo estiver usando a API para permitir que as pessoas acessem as fotos da iCloud Photo Library, o usuário final será o usuário desse aplicativo.
É importante identificar os usuários finais consistentemente para permitir os mais altos níveis de segurança de dados e garantir a melhor experiência do usuário.
Atributos
| nome | tipo | descrição |
|---|---|---|
id | ID do usuário | Identificador de recursos. |
resource | string, sempre user | Especificador de tipo de recurso. |
organisation | ID da organização | A organização a que o recurso pertence. |
key | ID da chave | A chave à qual o recurso está associado. |
identifier | corda | Valor personalizado para ajudar a identificar o usuário e evitar duplicação. Por exemplo, isso pode ser definido como o endereço de e-mail do usuário final. |
state | corda | Um de: active , deactivated , blocked . |
date_created | data hora | Quando o recurso foi criado. |
Identificador
O atributo identifier não é usado pela API, mas deve servir como uma ponte entre sua implementação e as informações armazenadas na API. O valor desse atributo deve permitir um mapeamento direto de um usuário do seu sistema com um usuário na API. Pode ser um ID de usuário no sistema ou o endereço de e-mail do usuário final.
Estados
-
active - o estado padrão do usuário.
-
deactivated - a organização proprietária desativou o acesso desse usuário.
-
blocked - um administrador da API desativou o acesso deste usuário.
Criar POST /users
Parâmetros
| nome | tipo | descrição |
|---|---|---|
organisation | super | Permite que os administradores de API criem usuários em nome de outras organizações. |
key | padrão: a chave atual | Atribuir um usuário a uma chave separada. Talvez um com menos permissões, por exemplo. |
identifier | obrigatório, string | Um pedaço de informação para identificar este usuário contra um usuário final em seu 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" }'
Usando 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>'
Usando ricloud-py
import ricloud user = ricloud.User.retrieve(<user ID>)
Listar GET /users
Parâmetros
| nome | tipo | descrição |
|---|---|---|
key | ID da chave | Filtre os usuários pela chave à qual eles estão associados. |
identifier | corda | Filtrar os usuários por seu identificador. |
state | corda | Filtrar os usuários por seu estado. |
date_created | filtro de data e hora | Filtrar por data de criação do recurso. |
Usando cURL
curl https://ricloud-api.reincubate.com/users \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud users = ricloud.User.list()
Atualizar POST /users/{user ID}
Parâmetros
| nome | tipo | descrição |
|---|---|---|
key | ID da chave | Mova o usuário para ser associado a uma chave diferente. Por exemplo, se eles atualizarem de uma avaliação. |
identifier | corda | Atualize o identificador de usuários. |
state | corda | Atualize o estado do usuário, seja para deactivated ou de volta para 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" }'
Usando 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')
