utenti
La risorsa utente rappresenta l'utente finale dei dati recuperati dall'API. Ad esempio, se un'app utilizza l'API per consentire alle persone di accedere alle foto di iCloud Photo Library, l'utente finale è l'utente di tale app.
È importante identificare gli utenti finali in modo coerente per consentire i massimi livelli di sicurezza dei dati e garantire la migliore esperienza utente.
attributi
| nome | genere | descrizione |
|---|---|---|
id | ID utente | Identificatore di risorse |
resource | stringa, sempre user | Specificatore del tipo di risorsa. |
organisation | ID dell'organizzazione | L'organizzazione a cui appartiene la risorsa. |
key | ID chiave | La chiave con cui la risorsa è associata. |
identifier | stringa | Valore personalizzato per aiutare a identificare l'utente ed evitare la duplicazione. Ad esempio, questo potrebbe essere impostato per essere l'indirizzo email dell'utente finale. |
state | stringa | Uno di: active , deactivated , blocked . |
date_created | appuntamento | Quando la risorsa è stata creata. |
Identifier
L'attributo identifier non viene utilizzato dall'API ma deve fungere da ponte tra l'implementazione e le informazioni memorizzate nell'API. Il valore di questo attributo dovrebbe consentire una mappatura diretta di un utente del tuo sistema con un utente sull'API. Può trattarsi di un ID utente all'interno del sistema o dell'indirizzo email dell'utente finale.
stati
-
active - lo stato standard dell'utente.
-
deactivated - l'organizzazione proprietaria ha disabilitato l'accesso di questo utente.
-
blocked - un amministratore API ha disabilitato l'accesso di questo utente.
Crea POST /users
parametri
| nome | genere | descrizione |
|---|---|---|
organisation | super | Consente agli amministratori delle API di creare utenti per conto di altre organizzazioni. |
key | default: la chiave attuale | Assegna un utente a una chiave separata. Forse uno con meno autorizzazioni, per esempio. |
identifier | richiesto, stringa | Un pezzo di informazione per identificare questo utente contro un utente finale nel tuo sistema. |
Utilizzando 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')
Recupera GET /users/{user ID}
Utilizzando 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>)
Elenco GET /users
parametri
| nome | genere | descrizione |
|---|---|---|
key | ID chiave | Filtra gli utenti per la chiave a cui sono associati. |
identifier | stringa | Filtra gli utenti in base al loro identificatore. |
state | stringa | Filtra gli utenti in base al loro stato. |
date_created | filtro datetime | Filtra per data di creazione della risorsa. |
Utilizzando cURL
curl https://ricloud-api.reincubate.com/users \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud users = ricloud.User.list()
Aggiorna POST /users/{user ID}
parametri
| nome | genere | descrizione |
|---|---|---|
key | ID chiave | Sposta l'utente ad essere associato a una chiave diversa. Ad esempio, se si aggiornano da una versione di prova. |
identifier | stringa | Aggiorna l'identificativo dell'utente. |
state | stringa | Aggiorna lo stato dell'utente, da deactivated o active . |
Utilizzando 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')
