Search code, repositories, users, issues, pull requests...

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

create_saml_test_config

SamlConfig create_saml_test_config(body)

Create SAML Test Configuration

Create a SAML test configuration.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = swagger_client.SamlConfig() # SamlConfig | SAML test config

try: 
    # Create SAML Test Configuration
    api_response = api_instance.create_saml_test_config(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->create_saml_test_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SamlConfig	SAML test config

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

delete_oidc_test_config

str delete_oidc_test_config(test_slug)

Delete OIDC Test Configuration

Delete a OIDC test configuration.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
test_slug = 'test_slug_example' # str | Slug of test config

try: 
    # Delete OIDC Test Configuration
    api_response = api_instance.delete_oidc_test_config(test_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->delete_oidc_test_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_slug	str	Slug of test config

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_saml_test_config

str delete_saml_test_config(test_slug)

Delete SAML Test Configuration

Delete a SAML test configuration.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
test_slug = 'test_slug_example' # str | Slug of test config

try: 
    # Delete SAML Test Configuration
    api_response = api_instance.delete_saml_test_config(test_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->delete_saml_test_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_slug	str	Slug of test config

Return type

str

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fetch_and_parse_saml_idp_metadata

SamlMetadataParseResult fetch_and_parse_saml_idp_metadata(body)

Parse SAML IdP Url

Fetch the given url and parse it as a SAML IdP metadata document and return the result. Note that this requires that the url be public or at least at a location where the Looker instance can fetch it without requiring any special authentication.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = 'body_example' # str | SAML IdP metadata public url

try: 
    # Parse SAML IdP Url
    api_response = api_instance.fetch_and_parse_saml_idp_metadata(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->fetch_and_parse_saml_idp_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str	SAML IdP metadata public url

Return type

SamlMetadataParseResult

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ldap_config

LDAPConfig ldap_config()

Get LDAP Configuration

Get the LDAP configuration. Looker can be optionally configured to authenticate users against an Active Directory or other LDAP directory server. LDAP setup requires coordination with an administrator of that directory server. Only Looker administrators can read and update the LDAP configuration. Configuring LDAP impacts authentication for all users. This configuration should be done carefully. Looker maintains a single LDAP configuration. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct). LDAP is enabled or disabled for Looker using the enabled field. Looker will never return an auth_password field. That value can be set, but never retrieved. See the Looker LDAP docs for additional information.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()

try: 
    # Get LDAP Configuration
    api_response = api_instance.ldap_config()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->ldap_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

LDAPConfig

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

oidc_config

OIDCConfig oidc_config()

Get OIDC Configuration

Get the OIDC configuration. Looker can be optionally configured to authenticate users against an OpenID Connect (OIDC) authentication server. OIDC setup requires coordination with an administrator of that server. Only Looker administrators can read and update the OIDC configuration. Configuring OIDC impacts authentication for all users. This configuration should be done carefully. Looker maintains a single OIDC configuation. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct). OIDC is enabled or disabled for Looker using the enabled field.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()

try: 
    # Get OIDC Configuration
    api_response = api_instance.oidc_config()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->oidc_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

oidc_test_config

OIDCConfig oidc_test_config(test_slug)

Get OIDC Test Configuration

Get a OIDC test configuration by test_slug.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
test_slug = 'test_slug_example' # str | Slug of test config

try: 
    # Get OIDC Test Configuration
    api_response = api_instance.oidc_test_config(test_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->oidc_test_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_slug	str	Slug of test config

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

parse_saml_idp_metadata

SamlMetadataParseResult parse_saml_idp_metadata(body)

Parse SAML IdP XML

Parse the given xml as a SAML IdP metadata document and return the result.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = 'body_example' # str | SAML IdP metadata xml

try: 
    # Parse SAML IdP XML
    api_response = api_instance.parse_saml_idp_metadata(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->parse_saml_idp_metadata: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	str	SAML IdP metadata xml

Return type

SamlMetadataParseResult

Authorization

No authorization required

HTTP request headers

Content-Type: text/plain
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

saml_config

SamlConfig saml_config()

Get SAML Configuration

Get the SAML configuration. Looker can be optionally configured to authenticate users against a SAML authentication server. SAML setup requires coordination with an administrator of that server. Only Looker administrators can read and update the SAML configuration. Configuring SAML impacts authentication for all users. This configuration should be done carefully. Looker maintains a single SAML configuation. It can be read and updated. Updates only succeed if the new state will be valid (in the sense that all required fields are populated); it is up to you to ensure that the configuration is appropriate and correct). SAML is enabled or disabled for Looker using the enabled field.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()

try: 
    # Get SAML Configuration
    api_response = api_instance.saml_config()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->saml_config: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

saml_test_config

SamlConfig saml_test_config(test_slug)

Get SAML Test Configuration

Get a SAML test configuration by test_slug.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
test_slug = 'test_slug_example' # str | Slug of test config

try: 
    # Get SAML Test Configuration
    api_response = api_instance.saml_test_config(test_slug)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->saml_test_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
test_slug	str	Slug of test config

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

test_ldap_config_auth

LDAPConfigTestResult test_ldap_config_auth(body)

Test LDAP Auth

Test the connection authentication settings for an LDAP configuration. This tests that the connection is possible and that a 'server' account to be used by Looker can authenticate to the LDAP server given connection and authentication information. connection_host, connection_port, and auth_username, are required. connection_tls and auth_password are optional. Example: `json { \"connection_host\": \"ldap.example.com\", \"connection_port\": \"636\", \"connection_tls\": true, \"auth_username\": \"cn=looker,dc=example,dc=com\", \"auth_password\": \"secret\" }` Looker will never return an auth_password. If this request omits the auth_password field, then the auth_password value from the active config (if present) will be used for the test. The active LDAP settings are not modified.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = swagger_client.LDAPConfig() # LDAPConfig | LDAP Config

try: 
    # Test LDAP Auth
    api_response = api_instance.test_ldap_config_auth(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->test_ldap_config_auth: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LDAPConfig	LDAP Config

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

test_ldap_config_connection

LDAPConfigTestResult test_ldap_config_connection(body)

Test LDAP Connection

Test the connection settings for an LDAP configuration. This tests that the connection is possible given a connection_host and connection_port. connection_host and connection_port are required. connection_tls is optional. Example: `json { \"connection_host\": \"ldap.example.com\", \"connection_port\": \"636\", \"connection_tls\": true }` No authentication to the LDAP server is attempted. The active LDAP settings are not modified.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = swagger_client.LDAPConfig() # LDAPConfig | LDAP Config

try: 
    # Test LDAP Connection
    api_response = api_instance.test_ldap_config_connection(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->test_ldap_config_connection: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LDAPConfig	LDAP Config

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

test_ldap_config_user_auth

LDAPConfigTestResult test_ldap_config_user_auth(body)

Test LDAP User Auth

Test the user authentication settings for an LDAP configuration. This test accepts a full LDAP configuration along with a username/password pair and attempts to authenticate the user with the LDAP server. The configuration is validated before attempting the authentication. Looker will never return an auth_password. If this request omits the auth_password field, then the auth_password value from the active config (if present) will be used for the test. test_ldap_user and test_ldap_password are required. The active LDAP settings are not modified.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = swagger_client.LDAPConfig() # LDAPConfig | LDAP Config

try: 
    # Test LDAP User Auth
    api_response = api_instance.test_ldap_config_user_auth(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->test_ldap_config_user_auth: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LDAPConfig	LDAP Config

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

test_ldap_config_user_info

LDAPConfigTestResult test_ldap_config_user_info(body)

Test LDAP User Info

Test the user authentication settings for an LDAP configuration without authenticating the user. This test will let you easily test the mapping for user properties and roles for any user without needing to authenticate as that user. This test accepts a full LDAP configuration along with a username and attempts to find the full info for the user from the LDAP server without actually authenticating the user. So, user password is not required.The configuration is validated before attempting to contact the server. test_ldap_user is required. The active LDAP settings are not modified.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = swagger_client.LDAPConfig() # LDAPConfig | LDAP Config

try: 
    # Test LDAP User Info
    api_response = api_instance.test_ldap_config_user_info(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->test_ldap_config_user_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LDAPConfig	LDAP Config

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

update_ldap_config

LDAPConfig update_ldap_config(body)

Update LDAP Configuration

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.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = swagger_client.LDAPConfig() # LDAPConfig | LDAP Config

try: 
    # Update LDAP Configuration
    api_response = api_instance.update_ldap_config(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->update_ldap_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	LDAPConfig	LDAP Config

Return type

LDAPConfig

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_oidc_config

OIDCConfig update_oidc_config(body)

Update OIDC Configuration

Update the OIDC configuration. Configuring OIDC impacts authentication for all users. This configuration should be done carefully. Only Looker administrators can read and update the OIDC configuration. OIDC is enabled or disabled for Looker using the enabled field. It is highly recommended that any OIDC setting changes be tested using the APIs below before being set globally.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = swagger_client.OIDCConfig() # OIDCConfig | OIDC Config

try: 
    # Update OIDC Configuration
    api_response = api_instance.update_oidc_config(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->update_oidc_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	OIDCConfig	OIDC Config

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

update_saml_config

SamlConfig update_saml_config(body)

Update SAML Configuration

Update the SAML configuration. Configuring SAML impacts authentication for all users. This configuration should be done carefully. Only Looker administrators can read and update the SAML configuration. SAML is enabled or disabled for Looker using the enabled field. It is highly recommended that any SAML setting changes be tested using the APIs below before being set globally.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.AuthApi()
body = swagger_client.SamlConfig() # SamlConfig | SAML Config

try: 
    # Update SAML Configuration
    api_response = api_instance.update_saml_config(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthApi->update_saml_config: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	SamlConfig	SAML Config

Return type