Organisationen
Die Organisationsressource hilft bei der Verknüpfung aller anderen API-Ressourcen, die sich auf einen Client der API beziehen (hier ist ein Client ein API-Kunde und keine API-Client-Implementierung).
Eine Organisation muss konfiguriert werden, bevor ihre API-Schlüssel zum Ausführen von Datenabrufvorgängen für die API verwendet werden können. Ohne mindestens eine gültige Speicherkonfiguration kann die API keine Ergebnisse veröffentlichen.
Eine Organisation verwaltet eine Reihe von Basisberechtigungen. Diese beschreiben, welche Operationsschlüssel innerhalb der Organisation für die API ausgeführt werden dürfen.
Attribute
| Name | Art | Beschreibung |
|---|---|---|
id | Organisations-ID | Ressourcenkennung. |
resource | String, immer organisation | Ressourcentypbezeichner. |
type | Super, Schnur | Eines von: standard , super . |
name | Zeichenfolge | Der gewählte Name für die Organisation. |
slug | Zeichenfolge | Die verschlüsselte Version des name . |
api_version | API-Version | Die API-Version, für die die Organisation konfiguriert ist. |
config | verschachteltes Objekt | Organisationsweite Konfigurationseinstellungen. |
permissions | Berechtigungsressource | Ressource für verschachtelte Berechtigungen . |
storage_configs | Listenobjekt mit Speicherkonfigurationsressourcen | Verschachtelte Liste der der Organisation zugeordneten Speicherkonfigurationsobjekte. |
storage_config_default | Optional, Speicherkonfigurations-ID | Die ID der Standardspeicherkonfiguration der Organisation. |
webhook_configs | Listenobjekt mit Webhook-Konfigurationsressourcen | Verschachtelte Liste der Webhook-Konfigurationsobjekte, die der Organisation zugeordnet sind. |
webhook_config_default | Optional, Webhook-Konfigurations-ID | Die ID der Standard-Webhook-Konfiguration der Organisation. |
state | Zeichenfolge | Einer von: nicht unconfigured , active , deactivated , blocked . |
date_created | Terminzeit | Wann wurde die Ressource erstellt. |
Typen
-
standard - Für Kunden der API.
-
super - Für interne Manager der API.
Aufbau
Die Konfiguration auf Organisationsebene kann für das config der Organisation festgelegt werden. Im Moment akzeptiert dies nur publish_source_files , die sich auf den Mechanismus zur Veröffentlichung von Quelldateien beziehen.
Berechtigungen
Die permissions Wert gibt den Satz von Basisberechtigungen für die Organisation. Dies sind die am wenigsten strengen Berechtigungen, die einer Subressource dieser Organisation gewährt werden, dh ein Schlüssel oder ein Benutzer kann nicht auf mehr Daten zugreifen als die Organisation, zu der er gehört.
Zustände
-
unconfigured - Jede Organisation wird in diesem Zustand erstellt. In diesem Status wird der Zugriff auf die meisten Funktionen zum Abrufen von Daten blockiert.
-
active - Die Organisation wurde konfiguriert und kann alle Teile der API verwenden.
-
deactivated - Die Organisation wurde auf Anfrage des Eigentümers geschlossen.
-
blocked - Die Organisation wurde von einem API-Administrator heruntergefahren.
Änderungsprotokoll
2020-02-20
- Major Die Attribute
storage_configsundwebhook_configsdes Organisationsobjekts sind jetzt ein verschachteltesstorage_configsundwebhook_configsstorage_configswebhook_configs.
GET /organisation
CURL verwenden
curl https://ricloud-api.reincubate.com/organisation \ -H 'Authorization: Token <your key_token>'
Mit Ricloud-Py
import ricloud ricloud.Organisation.retrieve()
Beispielantwort
{ "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" }
POST /organisation
Parameter
| Name | Art | Beschreibung |
|---|---|---|
name | Zeichenfolge | Ändern Sie den Anzeigenamen Ihrer Organisation. |
storage_config_default | Speicherkonfigurations-ID | Ändern Sie die von Ihrer Organisation verwendete Standardspeicherkonfiguration. |
webhook_config_default | Webhook-Konfigurations-ID | Ändern Sie die von Ihrer Organisation verwendete Standard-Webhook-Konfiguration. |
CURL verwenden
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" }'
Mit Ricloud-Py
import ricloud ricloud.Organisation.update(name='My new org')
Beispielantwort. Beachten Sie, dass sich das slug Attribut nicht ändert, da es nur bei der erstmaligen Erstellung der Organisation generiert wird.
{ "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" }
