organizzazioni

aggiornato

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 .
permissions risorsa permessi Risorsa permessi nidificati
storage_configs elenco delle risorse di configurazione della memoria Elenco annidato di oggetti di configurazione di archiviazione associati all'organizzazione.
storage_config_default facoltativo, ID di configurazione di archiviazione L'ID della configurazione di archiviazione predefinita dell'organizzazione.
webhook_configs elenco delle risorse di configurazione di webhook Elenco annidato 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.

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.

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 campione

{
  "id": 1,
  "resource": "organisation",
  "name": "My org",
  "slug": "my-org",
  "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": [
    {
      "id": 1,
      "resource": "storage_config",
      "type": "gs",
      "url": "gs://my-storage-bucket",
      "credentials": {},
      "state": "valid",
      "date_created": "2018-11-08T16:47:56.849618Z"
    }
  ],
  "storage_config_default": 1,
  "webhook_configs": [
    {
      "id": 1,
      "resource": "webhook_config",
      "url": "https://www.mywebhookendpoint.com/webhooks",
      "secret": "Wg69dQaffJuXckXsdoHuPYkf3VSWEGMa",
      "state": "valid",
      "date_created": "2018-11-08T13:07:59.563975Z"
    }
  ],
  "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": [
    {
      "id": 1,
      "resource": "storage_config",
      "type": "gs",
      "url": "gs://my-storage-bucket",
      "credentials": {},
      "state": "valid",
      "date_created": "2018-11-08T16:47:56.849618Z"
    }
  ],
  "storage_config_default": 1,
  "webhook_configs": [
    {
      "id": 1,
      "resource": "webhook_config",
      "url": "https://www.mywebhookendpoint.com/webhooks",
      "secret": "Wg69dQaffJuXckXsdoHuPYkf3VSWEGMa",
      "state": "valid",
      "date_created": "2018-11-08T13:07:59.563975Z"
    }
  ],
  "webhook_config_default": 1,
  "state": "active",
  "date_created": "2018-11-08T13:05:29.784270Z"
}

Come possiamo aiutare?

Il nostro team di supporto è qui per aiutarti!

I nostri orari di ufficio sono dal lunedì al venerdì, dalle 9:00 alle 17:00 GMT. L'ora è attualmente 4:15 PM GMT.

Miriamo a rispondere a tutti i messaggi entro un giorno lavorativo.

Vai alla sezione di supporto › Contatta il team aziendale ›
Il nostro fantastico team di supporto

Possiamo migliorare questo articolo?

Ci piace ascoltare gli utenti: perché non mandarci un'email, lasciare un commento o twittare @reincubate?

© 2008 - 2019 Reincubate Ltd. Tutti i diritti riservati. Registrato in Inghilterra e Galles #5189175, VAT GB151788978. Reincubate® è un marchio registrato. Termini e Condizioni. Raccomandiamo 2FA. Costruito con a Londra.