Skip to content

Latest commit

 

History

History
178 lines (120 loc) · 4.82 KB

ApiAuthApi.md

File metadata and controls

178 lines (120 loc) · 4.82 KB
Raw

LookerApi30Reference.ApiAuthApi

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

Method HTTP request Description
login POST /login Login
loginUser POST /login/{user_id} Login user
logout DELETE /logout Logout

login

AccessToken login(opts)

Login

Present client credentials to obtain an authorization token

Looker API implements the OAuth2 Resource Owner Password Credentials Grant pattern. The client credentials required for this login must be obtained by creating an API3 key on a user account in the Looker Admin console. The API3 key consists of a public client_id and a private client_secret.

The access token returned by login must be used in the HTTP Authorization header of subsequent API requests, like this:

Authorization: token 4QDkCyCtZzYgj4C2p2cj3csJH7zqS5RzKs2kTnG4

Replace "4QDkCy..." with the access_token value returned by login. The word 'token' is a string literal and must be included exactly as shown.

For more information and detailed examples of Looker API authorization, see How to Authenticate to Looker API3.

Example

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

var apiInstance = new LookerApi30Reference.ApiAuthApi()

var opts = { 
  'clientId': "clientId_example", // {String} client_id part of API3 Key.
  'clientSecret': "clientSecret_example" // {String} client_secret part of API3 Key.
};

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

Parameters

Name Type Description Notes
clientId String client_id part of API3 Key. [optional]
clientSecret String client_secret part of API3 Key. [optional]

Return type

AccessToken

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

loginUser

AccessToken loginUser(userId)

Login user

Create an access token for a given user.

This can only be called by an authenticated admin user. It allows that admin to generate a new authentication token for the user with the given user id. That token can then be used for subsequent API calls - which are then performed as that target user.

The target user does not need to have a pre-existing API client_id/client_secret pair. And, no such credentials are created by this call.

This allows for building systems where api user authentication for an arbitrary number of users is done outside of Looker and funneled through a single 'service account' with admin permissions. Note that a new access token is generated on each call. If target users are going to be making numerous API calls in a short period then it is wise to cache this authentication token rather than call this before each of those API calls.

See 'login' for more detail on the access token and how to use it.

Example

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

var apiInstance = new LookerApi30Reference.ApiAuthApi()

var userId = 789; // {Integer} Id of user.


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

Parameters

Name Type Description Notes
userId Integer Id of user.

Return type

AccessToken

Authorization

No authorization required

HTTP request headers

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

logout

'String' logout

Logout

Logout of the API and invalidate the current access token.

Example

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

var apiInstance = new LookerApi30Reference.ApiAuthApi()

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