Saltar al contenido principal

kobana dashboards settings

Consultar configuración de la organización

Comandos de kobana dashboards settings. Toda opción global (Opciones globales) vale aquí.

ComandoHTTPDescripción
settingsGET /v1/settingsConsultar configuración de la organización
settings updatePUT /v1/settingsActualizar configuración de la organización

settings​

Consultar configuración de la organización

kobana dashboards settings [OPCIONES] [COMANDO]

GET /v1/settings

Nombre, correo de soporte, zona horaria y las opciones de registros de la organización. Recurso de la organización.

Encabezados

NombreTipoObligatorioDescripción
X-Workspace-IdstringnoWorkspace en el que actúa la llamada: el id o el public_id que se muestran en Workspaces en el panel. Dentro de la organización del token, los datos viven en workspaces. Puede omitirse mientras la organización tenga un único workspace; con dos o más, omitirlo devuelve 400 workspace_required. Un workspace que no es de la organización devuelve 403 unknown_workspace. Con un token de persona, solo los workspaces a los que ella tiene acceso (los propietarios de la organización alcanzan todos); los demás devuelven 403 workspace_access_denied.

Respuestas

HTTPDescripción
200La configuración.
404Recurso no encontrado en la organización actual.

settings update​

Actualizar configuración de la organización

kobana dashboards settings update [OPCIONES]

PUT /v1/settings

Cambia parcialmente la configuración: envíe solo lo que cambia. Los campos desconocidos se rechazan (400).

Encabezados

NombreTipoObligatorioDescripción
X-Workspace-IdstringnoWorkspace en el que actúa la llamada: el id o el public_id que se muestran en Workspaces en el panel. Dentro de la organización del token, los datos viven en workspaces. Puede omitirse mientras la organización tenga un único workspace; con dos o más, omitirlo devuelve 400 workspace_required. Un workspace que no es de la organización devuelve 403 unknown_workspace. Con un token de persona, solo los workspaces a los que ella tiene acceso (los propietarios de la organización alcanzan todos); los demás devuelven 403 workspace_access_denied.

Cuerpo de la solicitud

NombreTipoObligatorioDescripción
namestringno
support_emailstring (email)no
timezonestringnoZona horaria IANA, p. ej. America/Sao_Paulo.
crm_uppercase_namesbooleannoGuardar nombres en MAYÚSCULAS.
crm_allow_edit_public_idbooleanno
crm_allow_edit_documentbooleanno
crm_allow_create_customersbooleanno
crm_allow_create_portal_usersbooleannoPermitir crear usuarios del portal desde el panel y por importación.
crm_allow_edit_portal_user_emailbooleanno

Otros campos y objetos anidados: kobana schema dashboards.settings.update.

Respuestas

HTTPDescripción
200La configuración.
400El cuerpo de la solicitud falló en la validación.
404Recurso no encontrado en la organización actual.