Organizaciones

Actualizado

El recurso de la organización ayuda a vincular todos los demás recursos de la API relacionados con un cliente de la API (en este caso, un cliente es un cliente de la API, no una implementación del cliente de la API).

Una organización debe configurarse antes de que sus claves de API puedan usarse para realizar operaciones de recuperación de datos contra la API. Sin al menos una configuración de almacenamiento válida, la API no sabrá cómo publicar los resultados.

Una organización realiza un seguimiento de un conjunto de permisos de base. Estos describen qué claves de operaciones dentro de la organización pueden realizar contra la API.

Atributos

nombre tipo descripción
id ID de organización Identificador de recursos.
resource cadena, siempre organisation Especificador de tipo de recurso.
type super, cadena Uno de: standard , super .
name cuerda El nombre elegido para la organización.
slug cuerda La versión slugificada de name .
permissions recurso de permisos Recurso de permisos anidados.
storage_configs lista de recursos de configuración de almacenamiento Lista anidada de objetos de configuración de almacenamiento asociados con la organización.
storage_config_default opcional, ID de configuración de almacenamiento El ID de la configuración de almacenamiento por defecto de la organización.
webhook_configs lista de recursos de configuración de webhook Lista anidada de objetos de configuración de webhook asociados con la organización.
webhook_config_default opcional, ID de configuración de webhook El ID de la configuración de webhook por defecto de la organización.
state cuerda Uno de: no unconfigured , active , deactivated , blocked .
date_created fecha y hora Cuando el recurso fue creado.

Los tipos

standard
Para clientes de la API.
super
Para los gestores internos de la API.

Permisos

El valor de los permissions especifica el conjunto de permisos básicos para la organización. Estos son los permisos menos estrictos otorgados a cualquier sub-recurso de esa organización, es decir, una clave o un usuario no puede tener acceso a más datos que la organización a la que pertenece.

Estados

unconfigured
Cada organización se crea en este estado. Estar en este estado bloquea el acceso a la mayoría de las funciones de recuperación de datos.
active
La organización ha sido configurada y puede usar todas las partes de la API.
deactivated
La organización ha sido cerrada a petición del propietario.
blocked
La organización ha sido cerrada por un administrador de API.

Recuperar GET /organisation

Usando cURL

curl https://ricloud-api.reincubate.com/organisation \
  -H 'Authorization: Token <your key_token>'

Utilizando ricloud-py

import ricloud

ricloud.Organisation.retrieve()

Respuesta de muestra

{
  "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"
}

Actualizar POST /organisation

Parámetros

nombre tipo descripción
name cuerda Cambia el nombre para mostrar de tu organización.
storage_config_default ID de configuración de almacenamiento Cambie la configuración de almacenamiento predeterminada utilizada por su organización.
webhook_config_default ID de configuración de webhook Cambie la configuración de webhook predeterminada utilizada por su organización.

Usando 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"
}'

Utilizando ricloud-py

import ricloud

ricloud.Organisation.update(name='My new org')

Respuesta de muestra. Tenga en cuenta que el atributo slug no cambia, ya que solo se genera en la creación inicial de la organización.

{
  "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"
}

¿Cómo podemos ayudar?

¡Nuestro equipo de soporte está aquí para ayudar!

Nuestro horario de atención es de lunes a viernes de 9 a.m. a 5 p.m. GMT. El tiempo es actualmente 7:55 PM GMT.

Intentamos responder todos los mensajes en un plazo de un día laboral.

Ir a la sección de soporte › Póngase en contacto con el equipo de la empresa. ›
Nuestro increíble equipo de soporte.

¿Podemos mejorar este artículo?

Nos encanta escuchar de los usuarios: ¿por qué no enviarnos un correo electrónico, dejar un comentario o tuitear? @reincubate?

© 2008 - 2019 Reincubate Ltd. Todos los derechos reservados. Registrado en Inglaterra y Gales #5189175, VAT GB151788978. Reincubate® es una marca registrada. Términos y privacidad. Recomendamos la autenticación de múltiples factores. Construido con en Londres.