AuthApi.md

LookerApi31Reference.AuthApi

All URIs are relative to /api/3.1

Method	HTTP request	Description
createOidcTestConfig	POST /oidc_test_configs	Create OIDC Test Configuration
createSamlTestConfig	POST /saml_test_configs	Create SAML Test Configuration
deleteOidcTestConfig	DELETE /oidc_test_configs/{test_slug}	Delete OIDC Test Configuration
deleteSamlTestConfig	DELETE /saml_test_configs/{test_slug}	Delete SAML Test Configuration
fetchAndParseSamlIdpMetadata	POST /fetch_and_parse_saml_idp_metadata	Parse SAML IdP Url
forcePasswordResetAtNextLoginForAllUsers	PUT /password_config/force_password_reset_at_next_login_for_all_users	Force password reset
ldapConfig	GET /ldap_config	Get LDAP Configuration
oidcConfig	GET /oidc_config	Get OIDC Configuration
oidcTestConfig	GET /oidc_test_configs/{test_slug}	Get OIDC Test Configuration
parseSamlIdpMetadata	POST /parse_saml_idp_metadata	Parse SAML IdP XML
passwordConfig	GET /password_config	Get Password Config
samlConfig	GET /saml_config	Get SAML Configuration
samlTestConfig	GET /saml_test_configs/{test_slug}	Get SAML Test Configuration
sessionConfig	GET /session_config	Get Session Config
testLdapConfigAuth	PUT /ldap_config/test_auth	Test LDAP Auth
testLdapConfigConnection	PUT /ldap_config/test_connection	Test LDAP Connection
testLdapConfigUserAuth	PUT /ldap_config/test_user_auth	Test LDAP User Auth
testLdapConfigUserInfo	PUT /ldap_config/test_user_info	Test LDAP User Info
updateLdapConfig	PATCH /ldap_config	Update LDAP Configuration
updateOidcConfig	PATCH /oidc_config	Update OIDC Configuration
updatePasswordConfig	PATCH /password_config	Update Password Config
updateSamlConfig	PATCH /saml_config	Update SAML Configuration
updateSessionConfig	PATCH /session_config	Update Session Config

createOidcTestConfig

OIDCConfig createOidcTestConfig(body)

Create OIDC Test Configuration

Create a OIDC test configuration.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.OIDCConfig(); // OIDCConfig | OIDC test config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createOidcTestConfig(body, callback);

Parameters

Name	Type	Description	Notes
body	OIDCConfig	OIDC test config

Return type

OIDCConfig

Authorization

No authorization required

HTTP request headers

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

createSamlTestConfig

SamlConfig createSamlTestConfig(body)

Create SAML Test Configuration

Create a SAML test configuration.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.SamlConfig(); // SamlConfig | SAML test config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createSamlTestConfig(body, callback);

Parameters

Name	Type	Description	Notes
body	SamlConfig	SAML test config

Return type

SamlConfig

Authorization

No authorization required

HTTP request headers

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

deleteOidcTestConfig

'String' deleteOidcTestConfig(testSlug)

Delete OIDC Test Configuration

Delete a OIDC test configuration.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var testSlug = "testSlug_example"; // String | Slug of test config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deleteOidcTestConfig(testSlug, callback);

Parameters

Name	Type	Description	Notes
testSlug	String	Slug of test config

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

deleteSamlTestConfig

'String' deleteSamlTestConfig(testSlug)

Delete SAML Test Configuration

Delete a SAML test configuration.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var testSlug = "testSlug_example"; // String | Slug of test config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deleteSamlTestConfig(testSlug, callback);

Parameters

Name	Type	Description	Notes
testSlug	String	Slug of test config

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

fetchAndParseSamlIdpMetadata

SamlMetadataParseResult fetchAndParseSamlIdpMetadata(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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = "body_example"; // String | SAML IdP metadata public url


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.fetchAndParseSamlIdpMetadata(body, callback);

Parameters

Name	Type	Description	Notes
body	String	SAML IdP metadata public url

Return type

SamlMetadataParseResult

Authorization

No authorization required

HTTP request headers

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

forcePasswordResetAtNextLoginForAllUsers

'String' forcePasswordResetAtNextLoginForAllUsers()

Force password reset

Force all credentials_email users to reset their login passwords upon their next login.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.forcePasswordResetAtNextLoginForAllUsers(callback);

Parameters

This endpoint does not need any parameter.

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

ldapConfig

LDAPConfig ldapConfig()

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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.ldapConfig(callback);

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

oidcConfig

OIDCConfig oidcConfig()

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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.oidcConfig(callback);

Parameters

This endpoint does not need any parameter.

Return type

OIDCConfig

Authorization

No authorization required

HTTP request headers

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

oidcTestConfig

OIDCConfig oidcTestConfig(testSlug)

Get OIDC Test Configuration

Get a OIDC test configuration by test_slug.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var testSlug = "testSlug_example"; // String | Slug of test config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.oidcTestConfig(testSlug, callback);

Parameters

Name	Type	Description	Notes
testSlug	String	Slug of test config

Return type

OIDCConfig

Authorization

No authorization required

HTTP request headers

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

parseSamlIdpMetadata

SamlMetadataParseResult parseSamlIdpMetadata(body)

Parse SAML IdP XML

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

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = "body_example"; // String | SAML IdP metadata xml


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.parseSamlIdpMetadata(body, callback);

Parameters

Name	Type	Description	Notes
body	String	SAML IdP metadata xml

Return type

SamlMetadataParseResult

Authorization

No authorization required

HTTP request headers

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

passwordConfig

PasswordConfig passwordConfig()

Get Password Config

Get password config.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.passwordConfig(callback);

Parameters

This endpoint does not need any parameter.

Return type

PasswordConfig

Authorization

No authorization required

HTTP request headers

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

samlConfig

SamlConfig samlConfig()

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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.samlConfig(callback);

Parameters

This endpoint does not need any parameter.

Return type

SamlConfig

Authorization

No authorization required

HTTP request headers

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

samlTestConfig

SamlConfig samlTestConfig(testSlug)

Get SAML Test Configuration

Get a SAML test configuration by test_slug.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var testSlug = "testSlug_example"; // String | Slug of test config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.samlTestConfig(testSlug, callback);

Parameters

Name	Type	Description	Notes
testSlug	String	Slug of test config

Return type

SamlConfig

Authorization

No authorization required

HTTP request headers

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

sessionConfig

SessionConfig sessionConfig()

Get Session Config

Get session config.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.sessionConfig(callback);

Parameters

This endpoint does not need any parameter.

Return type

SessionConfig

Authorization

No authorization required

HTTP request headers

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

testLdapConfigAuth

LDAPConfigTestResult testLdapConfigAuth(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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.LDAPConfig(); // LDAPConfig | LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.testLdapConfigAuth(body, callback);

Parameters

Name	Type	Description	Notes
body	LDAPConfig	LDAP Config

Return type

LDAPConfigTestResult

Authorization

No authorization required

HTTP request headers

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

testLdapConfigConnection

LDAPConfigTestResult testLdapConfigConnection(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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.LDAPConfig(); // LDAPConfig | LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.testLdapConfigConnection(body, callback);

Parameters

Name	Type	Description	Notes
body	LDAPConfig	LDAP Config

Return type

LDAPConfigTestResult

Authorization

No authorization required

HTTP request headers

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

testLdapConfigUserAuth

LDAPConfigTestResult testLdapConfigUserAuth(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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.LDAPConfig(); // LDAPConfig | LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.testLdapConfigUserAuth(body, callback);

Parameters

Name	Type	Description	Notes
body	LDAPConfig	LDAP Config

Return type

LDAPConfigTestResult

Authorization

No authorization required

HTTP request headers

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

testLdapConfigUserInfo

LDAPConfigTestResult testLdapConfigUserInfo(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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.LDAPConfig(); // LDAPConfig | LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.testLdapConfigUserInfo(body, callback);

Parameters

Name	Type	Description	Notes
body	LDAPConfig	LDAP Config

Return type

LDAPConfigTestResult

Authorization

No authorization required

HTTP request headers

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

updateLdapConfig

LDAPConfig updateLdapConfig(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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.LDAPConfig(); // LDAPConfig | LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateLdapConfig(body, callback);

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

updateOidcConfig

OIDCConfig updateOidcConfig(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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.OIDCConfig(); // OIDCConfig | OIDC Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateOidcConfig(body, callback);

Parameters

Name	Type	Description	Notes
body	OIDCConfig	OIDC Config

Return type

OIDCConfig

Authorization

No authorization required

HTTP request headers

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

updatePasswordConfig

PasswordConfig updatePasswordConfig(body)

Update Password Config

Update password config.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.PasswordConfig(); // PasswordConfig | Password Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updatePasswordConfig(body, callback);

Parameters

Name	Type	Description	Notes
body	PasswordConfig	Password Config

Return type

PasswordConfig

Authorization

No authorization required

HTTP request headers

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

updateSamlConfig

SamlConfig updateSamlConfig(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

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.SamlConfig(); // SamlConfig | SAML Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateSamlConfig(body, callback);

Parameters

Name	Type	Description	Notes
body	SamlConfig	SAML Config

Return type

SamlConfig

Authorization

No authorization required

HTTP request headers

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

updateSessionConfig

SessionConfig updateSessionConfig(body)

Update Session Config

Update session config.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.AuthApi();

var body = new LookerApi31Reference.SessionConfig(); // SessionConfig | Session Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateSessionConfig(body, callback);

Parameters

Name	Type	Description	Notes
body	SessionConfig	Session Config

Return type

SessionConfig

Authorization

No authorization required

HTTP request headers

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