Actualizar configuración de SAML

Versión 3.1.23.4

Actualiza la configuración de SAML.

La configuración de SAML afecta la autenticación para todos los usuarios. Esta configuración debe hacerse con cuidado.

Solo los administradores de Looker pueden leer y actualizar la configuración de SAML.

SAML está habilitado o inhabilitado para Looker con el campo enabled.

Se recomienda que todos los cambios en la configuración de SAML se prueben con las siguientes APIs antes de que se establezcan de forma global.

Solicitud

PATCH /saml_config
Tipo de datos
Descripción
Solicitud
HTTPRequest
body
Cuerpo HTTP
Expandir la definición HTTPBody...
body
Configuración de SAML
Expandir la definición de SamlConfig...
que pueden
objeto
Operaciones que el usuario actual puede realizar en este objeto
habilitada
booleano
Habilitar o inhabilitar la autenticación Saml para el servidor
id_cert
string
Certificado de proveedor de identidad (proporcionado por IdP)
idp_url
string
URL del proveedor de identidad (proporcionada por IdP)
idp_issuer
string
Emisor de proveedores de identidad (proporcionado por IdP)
público de idp
string
Público del proveedor de identidad (configurado en la configuración del IdP). Opcional en Looker. Establece esta opción solo si deseas que Looker valide el valor de público que muestra el IdP.
desvío_reloj_permitido
integer
Recuento de segundos de desvío del reloj para permitir marcas de tiempo de validación de aserciones.
user_attribute_map_email
string
Nombre de los atributos de registro de usuario que se usan para indicar el campo de la dirección de correo electrónico
user_attribute_map_first_name
string
Nombre de los atributos del registro de usuarios que se usan para indicar el nombre
user_attribute_map_last_name
string
Nombre de los atributos del registro de usuarios que se usan para indicar el apellido
tipos_de_migración_de_nuevos usuarios
string
Combina el primer acceso de saml a la cuenta de usuario existente por direcciones de correo electrónico. Cuando un usuario accede por primera vez a través de saml, esta opción lo conecta con su cuenta existente; para ello, busca la cuenta con una dirección de correo electrónico que coincida. Para ello, pruebe los tipos de credenciales proporcionados para los usuarios existentes. De lo contrario, se creará una nueva cuenta de usuario. Esta lista (si se proporciona) debe ser una lista de strings separadas por comas, como “email,ldap,google”.
alt_email_login_allowed
booleano
Permitir el acceso alternativo basado en el correo electrónico a través de "/login/email" para los administradores y para los usuarios especificados con el permiso "login_special_email". Esta opción es útil como resguardo durante la configuración de LDAP, si los problemas de configuración de LDAP se producen más adelante o si necesita admitir algunos usuarios que no están en el directorio de LDAP. Los accesos de Looker por correo electrónico o contraseña siempre están inhabilitados para los usuarios normales cuando está habilitado LDAP.
prueba_slug
string
Babosa para identificar configuraciones que se crean a fin de ejecutar una prueba de configuración de Saml
modificado_en
string
La fecha de la última modificación de esta configuración
modificado_por
string
ID de usuario del último usuario que modificó este archivo de configuración
funciones_nuevas_predeterminadas
Rol[]
grupos_de_usuarios_nuevos
Grupo[]
id_nuevo_rol_de_usuario_predeterminado
Número entero
id_nuevo_grupo_usuario_predeterminado
Número entero
set_roles_from_groups
booleano
Configura los roles de los usuarios en Looker según los grupos de Saml
grupo_atributo
string
Nombre de los atributos de registro de usuario que se usan para indicar los grupos. Se usa cuando el valor de "groups_finder_type" se establece como "grouped_attribute_values"
grupos
grupos_con_ID_de_función
autenticación_requiere_función
booleano
No se permitirá el acceso a los usuarios a menos que se encuentre un rol para ellos en Saml si está configurado como verdadero.
atributos_usuario
user_attributes_with_ids
grupo_buscador_tipo
string
Identificador para una estrategia de cómo Looker encontrará grupos en la respuesta de SAML. Uno de los ['grouped_attribute_values', 'individual_attributes']
valor_de_grupos_de_miembros
string
Valor del atributo de grupo que se usa para indicar la membresía. Se usa cuando el valor de "groups_finder_type" se establece como "individual_attributes"
página_de_acceso_sin_acceso
booleano
Omite la página de acceso cuando se requiere la autenticación del usuario. En su lugar, redireccione al IdP de inmediato.
permitir_grupo_normal_membresía
booleano
Permitir que los usuarios autenticados de SAML sean miembros de grupos de Looker no reflejados. Si la estableces como "false", se quitará al usuario de los grupos no reflectados durante el acceso.
allow_roles_from_normal_groups
booleano
Los usuarios autenticados de SAML heredarán roles de grupos de Looker no reflejados.
roles_directos
booleano
Permite que las funciones se asignen directamente a usuarios con autenticación de SAML.
url
string
Vínculo para obtener este elemento

Respuesta

200: Nuevo estado para la configuración de SAML.

Tipo de datos
Descripción
que pueden
objeto
Operaciones que el usuario actual puede realizar en este objeto
habilitada
booleano
Habilitar o inhabilitar la autenticación Saml para el servidor
id_cert
string
Certificado de proveedor de identidad (proporcionado por IdP)
idp_url
string
URL del proveedor de identidad (proporcionada por IdP)
idp_issuer
string
Emisor de proveedores de identidad (proporcionado por IdP)
público de idp
string
Público del proveedor de identidad (configurado en la configuración del IdP). Opcional en Looker. Establece esta opción solo si deseas que Looker valide el valor de público que muestra el IdP.
desvío_reloj_permitido
integer
Recuento de segundos de desvío del reloj para permitir marcas de tiempo de validación de aserciones.
user_attribute_map_email
string
Nombre de los atributos de registro de usuario que se usan para indicar el campo de la dirección de correo electrónico
user_attribute_map_first_name
string
Nombre de los atributos del registro de usuarios que se usan para indicar el nombre
user_attribute_map_last_name
string
Nombre de los atributos del registro de usuarios que se usan para indicar el apellido
tipos_de_migración_de_nuevos usuarios
string
Combina el primer acceso de saml a la cuenta de usuario existente por direcciones de correo electrónico. Cuando un usuario accede por primera vez a través de saml, esta opción lo conecta con su cuenta existente; para ello, busca la cuenta con una dirección de correo electrónico que coincida. Para ello, pruebe los tipos de credenciales proporcionados para los usuarios existentes. De lo contrario, se creará una nueva cuenta de usuario. Esta lista (si se proporciona) debe ser una lista de strings separadas por comas, como “email,ldap,google”.
alt_email_login_allowed
booleano
Permitir el acceso alternativo basado en el correo electrónico a través de "/login/email" para los administradores y para los usuarios especificados con el permiso "login_special_email". Esta opción es útil como resguardo durante la configuración de LDAP, si los problemas de configuración de LDAP se producen más adelante o si necesita admitir algunos usuarios que no están en el directorio de LDAP. Los accesos de Looker por correo electrónico o contraseña siempre están inhabilitados para los usuarios normales cuando está habilitado LDAP.
prueba_slug
string
Babosa para identificar configuraciones que se crean a fin de ejecutar una prueba de configuración de Saml
modificado_en
string
La fecha de la última modificación de esta configuración
modificado_por
string
ID de usuario del último usuario que modificó este archivo de configuración
funciones_nuevas_predeterminadas
Rol[]
Expandir la definición del rol...
que pueden
objeto
Operaciones que el usuario actual puede realizar en este objeto
id
integer
ID único
del espacio
string
Nombre del rol
conjunto_de_permisos
(Solo lectura) Conjunto de permisos
Expandir la definición de PermissionSet...
que pueden
objeto
Operaciones que el usuario actual puede realizar en este objeto
todo_acceso
booleano
integrado
booleano
id
integer
ID único
del espacio
string
Nombre del PermissionSet
permisos
string[]
url
string
Vínculo para obtener este elemento
id_conjunto_permiso
integer
(Solo escritura) ID del permiso establecido
conjunto_modelo
(Solo lectura) Conjunto de modelos
Expandir definición de ModelSet...
que pueden
objeto
Operaciones que el usuario actual puede realizar en este objeto
todo_acceso
booleano
integrado
booleano
id
integer
ID único
modelos
string[]
del espacio
string
Nombre del conjunto de modelos
url
string
Vínculo para obtener este elemento
modelo_conjunto_ID
integer
(Solo escritura) ID del conjunto de modelos
url
string
Vínculo para obtener este elemento
usuarios_url
string
Vínculo para obtener una lista de los usuarios que tienen este rol
grupos_de_usuarios_nuevos
Grupo[]
Expandir definición del grupo...
que pueden
objeto
Operaciones que el usuario actual puede realizar en este objeto
can_add_to_content_metadata
booleano
El grupo se puede usar en los controles de acceso al contenido
contiene_usuario_actual
booleano
El usuario que accedió es miembro del grupo
id_grupo_externo
string
Grupo de ID externo si se incorpora el grupo
administrada externamente
booleano
La membresía del grupo se controla fuera de Looker
id
integer
ID único
include_by_default
booleano
Se agregan usuarios nuevos a este grupo de forma predeterminada
del espacio
string
Nombre del grupo
cantidad_de_usuarios
integer
Cantidad de usuarios incluidos en este grupo
id_nuevo_rol_de_usuario_predeterminado
Número entero
id_nuevo_grupo_usuario_predeterminado
Número entero
set_roles_from_groups
booleano
Configura los roles de los usuarios en Looker según los grupos de Saml
grupo_atributo
string
Nombre de los atributos de registro de usuario que se usan para indicar los grupos. Se usa cuando el valor de "groups_finder_type" se establece como "grouped_attribute_values"
grupos
Expandir la definición de SamlGroupRead...
id
integer
ID único
id_grupo_mirador
integer
ID único del grupo en Looker
nombre_grupo_mirador
string
Nombre del grupo en Looker
del espacio
string
Nombre del grupo en Saml
roles
Rol[]
Expandir la definición del rol...
que pueden
objeto
Operaciones que el usuario actual puede realizar en este objeto
id
integer
ID único
del espacio
string
Nombre del rol
conjunto_de_permisos
(Solo lectura) Conjunto de permisos
id_conjunto_permiso
integer
(Solo escritura) ID del permiso establecido
conjunto_modelo
(Solo lectura) Conjunto de modelos
modelo_conjunto_ID
integer
(Solo escritura) ID del conjunto de modelos
url
string
Vínculo para obtener este elemento
usuarios_url
string
Vínculo para obtener una lista de los usuarios que tienen este rol
url
string
Vínculo a la configuración de SAML
grupos_con_ID_de_función
Expandir la definición de SamlGroupWrite...
id
integer
ID único
id_grupo_mirador
integer
ID único del grupo en Looker
nombre_grupo_mirador
string
Nombre del grupo en Looker
del espacio
string
Nombre del grupo en Saml
ID de función
Número entero
url
string
Vínculo a la configuración de SAML
autenticación_requiere_función
booleano
No se permitirá el acceso a los usuarios a menos que se encuentre un rol para ellos en Saml si está configurado como verdadero.
atributos_usuario
Expandir la definición de SamlUserAttributeRead...
del espacio
string
Nombre del atributo del usuario en Saml
obligatorio
booleano
Debe estar en la aserción de Saml para que el acceso sea exitoso
atributos_usuario
Expandir definición del atributo de usuario...
que pueden
objeto
Operaciones que el usuario actual puede realizar en este objeto
id
integer
ID único
del espacio
string
Nombre del atributo del usuario
label
string
Etiqueta sencilla para el atributo de usuario
tipo
string
Tipo de atributo de usuario ("string", "número", "fecha y hora", "sí", "código postal")
default_value
string
Valor predeterminado cuando no se establece ningún valor en el usuario
es_sistema
booleano
El atributo es un valor predeterminado del sistema.
es_permanente
booleano
El atributo es permanente y no se puede borrar
valor_está_oculto
booleano
Si es verdadero, los usuarios no podrán ver los valores de este atributo
usuario_puede_ver
booleano
Los usuarios que no son administradores pueden ver los valores de sus atributos y usarlos en filtros
usuario_puede_editar
booleano
Los usuarios pueden cambiar el valor de este atributo por sí mismos
oculto_value_domain_whitelist
string
Destinos a los que se puede enviar un atributo oculto. Una vez establecido, no se puede editar.
url
string
Vínculo a la configuración de SAML
user_attributes_with_ids
Expandir la definición de SamlUserAttributeWrite...
del espacio
string
Nombre del atributo del usuario en Saml
obligatorio
booleano
Debe estar en la aserción de Saml para que el acceso sea exitoso
ID de atributo de usuario
Número entero
url
string
Vínculo a la configuración de SAML
grupo_buscador_tipo
string
Identificador para una estrategia de cómo Looker encontrará grupos en la respuesta de SAML. Uno de los ['grouped_attribute_values', 'individual_attributes']
valor_de_grupos_de_miembros
string
Valor del atributo de grupo que se usa para indicar la membresía. Se usa cuando el valor de "groups_finder_type" se establece como "individual_attributes"
página_de_acceso_sin_acceso
booleano
Omite la página de acceso cuando se requiere la autenticación del usuario. En su lugar, redireccione al IdP de inmediato.
permitir_grupo_normal_membresía
booleano
Permitir que los usuarios autenticados de SAML sean miembros de grupos de Looker no reflejados. Si la estableces como "false", se quitará al usuario de los grupos no reflectados durante el acceso.
allow_roles_from_normal_groups
booleano
Los usuarios autenticados de SAML heredarán roles de grupos de Looker no reflejados.
roles_directos
booleano
Permite que las funciones se asignen directamente a usuarios con autenticación de SAML.
url
string
Vínculo para obtener este elemento

400: Bad Request

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

403: Permiso denegado

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

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