Crear URL de incorporación de SSO

Versión 4.0.23.6 (más reciente)

Crear URL de incorporación de SSO

Crea una URL de incorporación de SSO y la firma de manera criptográfica con un secreto de incorporación. Esta URL firmada se puede usar para crear una instancia de una sesión de incorporación de Looker en una aplicación web de PBL. No realices modificaciones en esta URL, ya que cualquier cambio puede invalidar la firma y provocar que la URL no cargue una sesión de incorporación de Looker.

Una URL de incorporación de SSO firmada solo se puede usar una vez. Después de utilizarla para solicitar una página al servidor de Looker, la URL no es válida. Fallarán las solicitudes futuras que usen la misma URL. Esto se hace para evitar ataques de repetición.

La propiedad target_url debe ser una URL completa de una página de IU de Looker (parámetros de esquema, nombre de host, ruta de acceso y búsqueda). Para cargar un panel con el ID 56 y un filtro de Date=1 years, la URL de visualización se verá como https:/myname.looker.com/dashboards/56?Date=1%20years. La mejor manera de obtener este target_url es navegar a la página de Looker deseada en tu navegador web, copiar la URL que se muestra en la barra de direcciones del navegador y pegarla en la propiedad target_url como valor de string entrecomillado en esta solicitud a la API.

Los permisos para el usuario incorporado se definen según los grupos en los que este es miembro (propiedad group_ids) y las listas de modelos y permisos asignados al usuario incorporado. Como mínimo, debes proporcionar valores para la propiedad group_ids o para las propiedades de modelos y permisos. Estas propiedades son aditivas; un usuario incorporado puede ser miembro de ciertos grupos Y tener acceso a modelos y permisos.

El acceso del usuario de incorporación es la unión de los permisos que otorgan los group_ids, los modelos y las propiedades de permisos.

Esta función no requiere estrictamente que todos los ID de grupo, nombres de atributos de usuario o nombres de modelos existan en el momento en que se crea la URL de incorporación de SSO. El valor de group_id desconocido, los nombres de atributos de usuario o los nombres de modelos se pasarán a la URL de salida. Para diagnosticar posibles problemas con una URL de incorporación de SSO, puedes copiar la URL firmada en el cuadro de texto del Validador de URI de incorporación en <your looker instance>/admin/embed.

El parámetro secret_id es opcional. Si se especifica, su valor debe ser el ID de un secreto activo definido en la instancia de Looker. Si no se especifica, la URL se firmará con el secreto activo más reciente definido en la instancia de Looker.

Nota de seguridad

Protege esta URL firmada como lo harías con un token de acceso o credenciales de contraseña. No la escribas en un disco, no la pases a un tercero y solo la pases mediante un transporte seguro HTTPS encriptado.

Solicitud

POST /embed/sso_url
Tipo de datos
Descripción
Solicitud
HTTPRequest
body
Cuerpo HTTP
Expandir la definición HTTPBody...
body
Parámetros de SSO
Expandir la definición EmbedSsoParams...
target_url
string
Es la URL completa de la página de la IU de Looker que se mostrará en el contexto de incorporación. Por ejemplo, para mostrar el panel con el ID 34, `target_url` se vería así: `https://mycompany.looker.com:9999/dashboards/34`. `target_uri` DEBE contener un esquema (HTTPS), el nombre del dominio y la ruta de la URL. Se debe incluir el puerto si es necesario para llegar al servidor de Looker desde clientes de navegador. Si la instancia de Looker está detrás de un balanceador de cargas o algún otro proxy, “target_uri” debe ser el nombre de dominio público y el puerto necesarios para llegar a la instancia de Looker, no el nombre real de la máquina de red interna de la instancia de Looker.
Duración de la sesión
integer
Cantidad de segundos que será válida la sesión de incorporación de SSO después de que se inicie. La configuración predeterminada es 300 segundos. La duración máxima de la sesión es de 259,200 segundos (30 días).
forzar_logout_acceso
booleano
Si es verdadero, la sesión de incorporación borrará definitivamente cualquier estado de acceso residual de Looker (como en las cookies del navegador) antes de crear un nuevo estado de acceso con la información del usuario incorporada. El valor predeterminado es verdadero.
id_usuario_externo
string
Un valor de un sistema externo que identifica de forma exclusiva al usuario incorporado. Dado que los user_ids de los usuarios incorporados de Looker pueden cambiar en cada sesión de incorporación, external_user_id proporciona una forma de asignar un identificador de usuario estable y conocido en varias sesiones incorporadas.
first_name
string
Nombre del usuario de incorporación. Si no se especifica, la configuración predeterminada es “Embed”.
last_name
string
Apellido del usuario de incorporación Si no se especifica, el valor predeterminado es "User".
user_timezone
string
Establece la zona horaria del usuario para la sesión incorporada del usuario, si el parámetro de configuración de zonas horarias específicas del usuario está habilitado en la configuración del administrador de Looker. Un valor “null” obliga al usuario de incorporación a usar la zona horaria predeterminada de la aplicación de Looker. DEBE omitir esta propiedad de la solicitud si está inhabilitada la configuración de zonas horarias específicas del usuario. Los valores de zona horaria se validan según el estándar de la IANA y se pueden ver en la lista desplegable de la zona horaria de la aplicación en la página de administrador de la configuración general de Looker.
permisos
string[]
modelos
string[]
id de grupo
string[]
id_grupo_externo
string
Un valor único que identifica un grupo exclusivo para incorporaciones. Varios usuarios incorporados que tengan el mismo valor de "external_group_id" podrán compartir contenido de Looker entre sí. Los usuarios de Looker normales y aquellos que estén asociados con el campo “external_group_id” no podrán acceder al contenido ni a los usuarios asociados con “external_group_id”.
atributos_usuario
objeto
Un diccionario de pares nombre-valor que asocia un nombre de atributo de usuario de Looker con un valor.
id_secreto
string
ID del secreto de incorporación que se usará para firmar esta URL de SSO. Si se especifica, el valor debe ser el ID de un secreto válido (activo) definido en la instancia de Looker. Si no se especifica, la URL se firmará con el secreto de incorporación activo más reciente definido en la instancia de Looker.

Respuesta

200: URL de SSO firmada

Tipo de datos
Descripción
(objeto)
url
string
La URL incorporada Cualquier modificación que realices en esta string hará que la URL quede inutilizable.

400: Bad Request

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación

404: No encontrado

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación

409: El recurso ya existe

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación

422: Error de validación

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
Expandir la definición de ValidationErrorDetail...
campo
string
Campo con error
código
string
Código de error
mensaje,
string
Mensaje de información de error
url_documentación
string
Vínculo a la documentación
url_documentación
string
Vínculo a la documentación

429: Demasiadas solicitudes

Tipo de datos
Descripción
(objeto)
mensaje,
string
Detalles del error
url_documentación
string
Vínculo a la documentación