Skip to content

Latest commit

 

History

History
721 lines (460 loc) · 18.7 KB

AuthApi.md

File metadata and controls

721 lines (460 loc) · 18.7 KB
Raw

LookerApi30Reference.AuthApi

All URIs are relative to https://madisonreed.looker.com:19999/api/3.0

Method HTTP request Description
createSamlTestConfig POST /saml_test_configs Create SAML 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
ldapConfig GET /ldap_config Get LDAP Configuration
parseSamlIdpMetadata POST /parse_saml_idp_metadata Parse SAML IdP XML
samlConfig GET /saml_config Get SAML Configuration
samlTestConfig GET /saml_test_configs/{test_slug} Get SAML Test Configuration
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
updateSamlConfig PATCH /saml_config Update SAML Configuration

createSamlTestConfig

SamlConfig createSamlTestConfig(body)

Create SAML Test Configuration

Create a SAML test configuration.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.AuthApi()

var body = new LookerApi30Reference.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);
  }
};
api.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

deleteSamlTestConfig

'String' deleteSamlTestConfig(testSlug)

Delete SAML Test Configuration

Delete a SAML test configuration.

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.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);
  }
};
api.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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.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);
  }
};
api.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

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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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

parseSamlIdpMetadata

SamlMetadataParseResult parseSamlIdpMetadata(body)

Parse SAML IdP XML

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

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.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);
  }
};
api.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

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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.AuthApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.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);
  }
};
api.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

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:

{
  \"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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.AuthApi()

var body = new LookerApi30Reference.LDAPConfig(); // {LDAPConfig} LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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:

{
  \"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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.AuthApi()

var body = new LookerApi30Reference.LDAPConfig(); // {LDAPConfig} LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.AuthApi()

var body = new LookerApi30Reference.LDAPConfig(); // {LDAPConfig} LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.AuthApi()

var body = new LookerApi30Reference.LDAPConfig(); // {LDAPConfig} LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.AuthApi()

var body = new LookerApi30Reference.LDAPConfig(); // {LDAPConfig} LDAP Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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

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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.AuthApi()

var body = new LookerApi30Reference.SamlConfig(); // {SamlConfig} SAML Config


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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