Version 4.0.24.18
Update the LDAP configuration.
Configuring LDAP impacts authentication for all users. This configuration should be done carefully.
Only Looker administrators can read and update the LDAP configuration.
LDAP is enabled or disabled for Looker using the enabled field.
It is highly recommended that any LDAP setting changes be tested using the APIs below before being set globally.
See the Looker LDAP docs for additional information.
Calls to this endpoint may be denied by Looker (Google Cloud core).
Request
PATCH
/ldap_config
Datatype
Description
Request
body
Expand HTTP Body definition...
body
LDAP Config
Expand LDAPConfig definition...
can
lock
Operations the current user is able to perform on this object
alternate_email_login_allowed
Allow alternate email-based login via '/login/email' for admins and for specified users with the 'login_special_email' permission. This option is useful as a fallback during ldap setup, if ldap config problems occur later, or if you need to support some users who are not in your ldap directory. Looker email/password logins are always disabled for regular users when ldap is enabled.
auth_password
(Write-Only) Password for the LDAP account used to access the LDAP server
auth_requires_role
Users will not be allowed to login at all unless a role for them is found in LDAP if set to true
auth_username
Distinguished name of LDAP account used to access the LDAP server
connection_host
LDAP server hostname
connection_port
LDAP host port
connection_tls
Use Transport Layer Security
connection_tls_no_verify
Do not verify peer when using TLS
default_new_user_group_ids
default_new_user_groups
default_new_user_role_ids
default_new_user_roles
enabled
Enable/Disable LDAP authentication for the server
force_no_page
Don't attempt to do LDAP search result paging (RFC 2696) even if the LDAP server claims to support it.
groups
groups_base_dn
Base dn for finding groups in LDAP searches
groups_finder_type
Identifier for a strategy for how Looker will search for groups in the LDAP server
groups_member_attribute
LDAP Group attribute that signifies the members of the groups. Most commonly 'member'
groups_objectclasses
Optional comma-separated list of supported LDAP objectclass for groups when doing groups searches
groups_user_attribute
LDAP Group attribute that signifies the user in a group. Most commonly 'dn'
groups_with_role_ids
has_auth_password
lock
(Read-only) Has the password been set for the LDAP account used to access the LDAP server
merge_new_users_by_email
Merge first-time ldap login to existing user account by email addresses. When a user logs in for the first time via ldap this option will connect this user into their existing account by finding the account with a matching email address. Otherwise a new user account will be created for the user.
modified_at
lock
When this config was last modified
modified_by
lock
User id of user who last modified this config
set_roles_from_groups
Set user roles in Looker based on groups from LDAP
test_ldap_password
(Write-Only) Test LDAP user password. For ldap tests only.
test_ldap_user
(Write-Only) Test LDAP user login id. For ldap tests only.
user_attribute_map_email
Name of user record attributes used to indicate email address field
user_attribute_map_first_name
Name of user record attributes used to indicate first name
user_attribute_map_last_name
Name of user record attributes used to indicate last name
user_attribute_map_ldap_id
Name of user record attributes used to indicate unique record id
user_attributes
user_attributes_with_ids
user_bind_base_dn
Distinguished name of LDAP node used as the base for user searches
user_custom_filter
(Optional) Custom RFC-2254 filter clause for use in finding user during login. Combined via 'and' with the other generated filter clauses.
user_id_attribute_names
Name(s) of user record attributes used for matching user login id (comma separated list)
user_objectclass
(Optional) Name of user record objectclass used for finding user during login id
allow_normal_group_membership
Allow LDAP auth'd users to be members of non-reflected Looker groups. If 'false', user will be removed from non-reflected groups on login.
allow_roles_from_normal_groups
LDAP auth'd users will be able to inherit roles from non-reflected Looker groups.
allow_direct_roles
Allows roles to be directly assigned to LDAP auth'd users.
url
lock
Link to get this item
Response
200: New state for LDAP Configuration.
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
alternate_email_login_allowed
Allow alternate email-based login via '/login/email' for admins and for specified users with the 'login_special_email' permission. This option is useful as a fallback during ldap setup, if ldap config problems occur later, or if you need to support some users who are not in your ldap directory. Looker email/password logins are always disabled for regular users when ldap is enabled.
auth_password
(Write-Only) Password for the LDAP account used to access the LDAP server
auth_requires_role
Users will not be allowed to login at all unless a role for them is found in LDAP if set to true
auth_username
Distinguished name of LDAP account used to access the LDAP server
connection_host
LDAP server hostname
connection_port
LDAP host port
connection_tls
Use Transport Layer Security
connection_tls_no_verify
Do not verify peer when using TLS
default_new_user_group_ids
default_new_user_groups
Expand Group definition...
can
lock
Operations the current user is able to perform on this object
can_add_to_content_metadata
Group can be used in content access controls
contains_current_user
lock
Currently logged in user is group member
external_group_id
lock
External Id group if embed group
externally_managed
lock
Group membership controlled outside of Looker
id
lock
Unique Id
include_by_default
lock
New users are added to this group by default
name
Name of group
user_count
lock
Number of users included in this group
default_new_user_role_ids
default_new_user_roles
Expand Role definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
name
Name of Role
permission_set
lock
(Read only) Permission set
Expand PermissionSet definition...
can
lock
Operations the current user is able to perform on this object
all_access
lock
built_in
lock
id
lock
Unique Id
name
Name of PermissionSet
permissions
url
lock
Link to get this item
permission_set_id
(Write-Only) Id of permission set
model_set
lock
(Read only) Model set
Expand ModelSet definition...
can
lock
Operations the current user is able to perform on this object
all_access
lock
built_in
lock
id
lock
Unique Id
models
name
Name of ModelSet
url
lock
Link to get this item
model_set_id
(Write-Only) Id of model set
url
lock
Link to get this item
users_url
lock
Link to get list of users with this role
enabled
Enable/Disable LDAP authentication for the server
force_no_page
Don't attempt to do LDAP search result paging (RFC 2696) even if the LDAP server claims to support it.
groups
Expand LDAPGroupRead definition...
id
lock
Unique Id
looker_group_id
lock
Unique Id of group in Looker
looker_group_name
lock
Name of group in Looker
name
lock
Name of group in LDAP
roles
Expand Role definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
name
Name of Role
permission_set
lock
(Read only) Permission set
permission_set_id
(Write-Only) Id of permission set
model_set
lock
(Read only) Model set
model_set_id
(Write-Only) Id of model set
url
lock
Link to get this item
users_url
lock
Link to get list of users with this role
url
lock
Link to ldap config
groups_base_dn
Base dn for finding groups in LDAP searches
groups_finder_type
Identifier for a strategy for how Looker will search for groups in the LDAP server
groups_member_attribute
LDAP Group attribute that signifies the members of the groups. Most commonly 'member'
groups_objectclasses
Optional comma-separated list of supported LDAP objectclass for groups when doing groups searches
groups_user_attribute
LDAP Group attribute that signifies the user in a group. Most commonly 'dn'
groups_with_role_ids
Expand LDAPGroupWrite definition...
id
Unique Id
looker_group_id
lock
Unique Id of group in Looker
looker_group_name
Name of group in Looker
name
Name of group in LDAP
role_ids
url
lock
Link to ldap config
has_auth_password
lock
(Read-only) Has the password been set for the LDAP account used to access the LDAP server
merge_new_users_by_email
Merge first-time ldap login to existing user account by email addresses. When a user logs in for the first time via ldap this option will connect this user into their existing account by finding the account with a matching email address. Otherwise a new user account will be created for the user.
modified_at
lock
When this config was last modified
modified_by
lock
User id of user who last modified this config
set_roles_from_groups
Set user roles in Looker based on groups from LDAP
test_ldap_password
(Write-Only) Test LDAP user password. For ldap tests only.
test_ldap_user
(Write-Only) Test LDAP user login id. For ldap tests only.
user_attribute_map_email
Name of user record attributes used to indicate email address field
user_attribute_map_first_name
Name of user record attributes used to indicate first name
user_attribute_map_last_name
Name of user record attributes used to indicate last name
user_attribute_map_ldap_id
Name of user record attributes used to indicate unique record id
user_attributes
Expand LDAPUserAttributeRead definition...
name
lock
Name of User Attribute in LDAP
required
lock
Required to be in LDAP assertion for login to be allowed to succeed
user_attributes
Expand UserAttribute definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
name
Name of user attribute
label
Human-friendly label for user attribute
type
Type of user attribute ("string", "number", "datetime", "yesno", "zipcode", "advanced_filter_string", "advanced_filter_number")
default_value
Default value for when no value is set on the user
is_system
lock
Attribute is a system default
is_permanent
lock
Attribute is permanent and cannot be deleted
value_is_hidden
If true, users will not be able to view values of this attribute
user_can_view
Non-admin users can see the values of their attributes and use them in filters
user_can_edit
Users can change the value of this attribute for themselves
hidden_value_domain_whitelist
Destinations to which a hidden attribute may be sent. Once set, cannot be edited.
url
lock
Link to ldap config
user_attributes_with_ids
Expand LDAPUserAttributeWrite definition...
name
Name of User Attribute in LDAP
required
Required to be in LDAP assertion for login to be allowed to succeed
user_attribute_ids
url
lock
Link to ldap config
user_bind_base_dn
Distinguished name of LDAP node used as the base for user searches
user_custom_filter
(Optional) Custom RFC-2254 filter clause for use in finding user during login. Combined via 'and' with the other generated filter clauses.
user_id_attribute_names
Name(s) of user record attributes used for matching user login id (comma separated list)
user_objectclass
(Optional) Name of user record objectclass used for finding user during login id
allow_normal_group_membership
Allow LDAP auth'd users to be members of non-reflected Looker groups. If 'false', user will be removed from non-reflected groups on login.
allow_roles_from_normal_groups
LDAP auth'd users will be able to inherit roles from non-reflected Looker groups.
allow_direct_roles
Allows roles to be directly assigned to LDAP auth'd users.
url
lock
Link to get this item
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
403: Permission Denied
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link