organizzazioni
La risorsa dell'organizzazione consente di collegare tra loro tutte le altre risorse API correlate a un client dell'API (qui un client è un cliente API, non un'implementazione client API).
Un'organizzazione deve essere configurata prima che le sue chiavi API possano essere utilizzate per eseguire operazioni di recupero dati contro l'API. Senza almeno una configurazione di archiviazione valida, l'API non saprà come pubblicare i risultati.
Un'organizzazione tiene traccia di un insieme di permessi di base. Questi descrivono quali chiavi operative all'interno dell'organizzazione possono eseguire contro l'API.
attributi
| nome | genere | descrizione |
|---|---|---|
id | ID dell'organizzazione | Identificatore di risorse |
resource | stringa, sempre organisation | Specificatore del tipo di risorsa. |
type | super, stringa | Uno di: standard , super . |
name | stringa | Il nome scelto per l'organizzazione. |
slug | stringa | La versione slugified del name . |
api_version | Versione API | La versione dell'API che l'organizzazione è configurata per l'uso. |
config | oggetto nidificato | Impostazioni di configurazione a livello di organizzazione. |
permissions | risorsa permessi | Risorsa permessi nidificati |
storage_configs | oggetto elenco contenente risorse di configurazione dell'archiviazione | Elenco nidificato di oggetti di configurazione dell'archiviazione associati all'organizzazione. |
storage_config_default | facoltativo, ID di configurazione di archiviazione | L'ID della configurazione di archiviazione predefinita dell'organizzazione. |
webhook_configs | oggetto elenco contenente risorse di configurazione webhook | Elenco nidificato di oggetti di configurazione webhook associati all'organizzazione. |
webhook_config_default | facoltativo, webhook config ID | L'ID della configurazione di webhook predefinita dell'organizzazione. |
state | stringa | Uno di: non unconfigured , active , deactivated , blocked . |
date_created | appuntamento | Quando la risorsa è stata creata. |
tipi
-
standard - Per i clienti dell'API.
-
super - Per i gestori interni dell'API.
Configurazione
La configurazione a livello di organizzazione può essere impostata sull'attributo config dell'organizzazione. Per il momento, questo accetta solo publish_source_files , relativo al meccanismo di pubblicazione del file sorgente .
permessi
Il valore delle permissions specifica l'insieme delle autorizzazioni di base per l'organizzazione. Queste sono le autorizzazioni meno rigide consentite a qualsiasi risorsa secondaria di tale organizzazione, ovvero una chiave o un utente non possono avere accesso a più dati rispetto all'organizzazione a cui appartiene.
stati
-
unconfigured - Ogni organizzazione è creata in questo stato. Essere in questo stato blocca l'accesso alla maggior parte delle funzionalità di recupero dei dati.
-
active - L'organizzazione è stata configurata e può utilizzare tutte le parti dell'API.
-
deactivated - L'organizzazione è stata chiusa su richiesta del proprietario.
-
blocked - L'organizzazione è stata arrestata da un amministratore API.
changelog
2020/02/20
- Maggiore Il
storage_configsewebhook_configsattributi dell'oggetto di organizzazione sono ormai un oggetto lista annidata, piuttosto che un attributo semplice elenco.
Recupera GET /organisation
Utilizzando cURL
curl https://ricloud-api.reincubate.com/organisation \ -H 'Authorization: Token <your key_token>'
Usando ricloud-py
import ricloud ricloud.Organisation.retrieve()
Risposta del campione
{ "id": 1, "resource": "organisation", "name": "My org", "slug": "my-org", "api_version": "2020-02-20", "permissions": { "id": 1, "resource": "organisation_permissions", "identifier": "default", "scopes": { "source_type:icloud.*": [], "task_type:*": [], "data_type:icloud.account.info": [], }, "date_created": "2018-11-08T13:05:29.954188Z" }, "storage_configs": { "data": [ { "id": 1, "resource": "storage_config", "type": "gs", "url": "gs://my-storage-bucket", "credentials": {}, "state": "valid", "date_created": "2018-11-08T16:47:56.849618Z" } ], "has_more": false, "total_count": 1, "url": "/configs/storage" }, "storage_config_default": 1, "webhook_configs": { "data": [ { "id": 1, "resource": "webhook_config", "url": "https://www.mywebhookendpoint.com/webhooks", "secret": "Wg69dQaffJuXckXsdoHuPYkf3VSWEGMa", "state": "valid", "date_created": "2018-11-08T13:07:59.563975Z" } ], "has_more": false, "total_count": 1, "url": "/configs/webhook" }, "webhook_config_default": 1, "state": "active", "date_created": "2018-11-08T13:05:29.784270Z" }
Aggiorna POST /organisation
parametri
| nome | genere | descrizione |
|---|---|---|
name | stringa | Cambia il nome visualizzato della tua organizzazione. |
storage_config_default | ID di configurazione di archiviazione | Modifica la configurazione di archiviazione predefinita utilizzata dalla tua organizzazione. |
webhook_config_default | ID di configurazione webhook | Modifica la configurazione di webhook predefinita utilizzata dalla tua organizzazione. |
Utilizzando cURL
curl 'https://ricloud-api.reincubate.com/organisation' \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "name": "My new organisation name" }'
Usando ricloud-py
import ricloud ricloud.Organisation.update(name='My new org')
Risposta campione Si noti che l'attributo slug non cambia, in quanto viene generato solo durante la creazione iniziale dell'organizzazione.
{ "id": 1, "resource": "organisation", "name": "My new org", "slug": "my-org", "permissions": {}, "storage_configs": { "data": [ { "id": 1, "resource": "storage_config", "type": "gs", "url": "gs://my-storage-bucket", "credentials": {}, "state": "valid", "date_created": "2018-11-08T16:47:56.849618Z" } ], "has_more": false, "total_count": 1, "url": "/configs/storage" }, "storage_config_default": 1, "webhook_configs": { "data": [ { "id": 1, "resource": "webhook_config", "url": "https://www.mywebhookendpoint.com/webhooks", "secret": "Wg69dQaffJuXckXsdoHuPYkf3VSWEGMa", "state": "valid", "date_created": "2018-11-08T13:07:59.563975Z" } ], "has_more": false, "total_count": 1, "url": "/configs/webhook" }, "webhook_config_default": 1, "state": "active", "date_created": "2018-11-08T13:05:29.784270Z" }
