All URIs are relative to https://localhost:20000/api/3.1
| Method | HTTP request | Description |
|---|---|---|
| login | POST /login | Login |
| loginUser | POST /login/{user_id} | Login user |
| logout | DELETE /logout | Logout |
\Swagger\Client\Model\AccessToken login($client_id, $client_secret)
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. This function can accept client_id and client_secret parameters as URL query params or as www-form-urlencoded params in the body of the HTTP request. Since there is a small risk that URL parameters may be visible to intermediate nodes on the network route (proxies, routers, etc), passing credentials in the body of the request is considered more secure than URL params. Example of passing credentials in the HTTP request body: POST HTTP /login Content-Type: application/x-www-form-urlencoded client_id=CGc9B7v7J48dQSJvxxx&client_secret=nNVS9cSS3xNpSC9JdsBvvvvv ### Best Practice: Always pass credentials in body params. Pass credentials in URL query params only when you cannot pass body params due to application, tool, or other limitations. For more information and detailed examples of Looker API authorization, see How to Authenticate to Looker API3.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ApiAuthApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$client_id = "client_id_example"; // string | client_id part of API3 Key.
$client_secret = "client_secret_example"; // string | client_secret part of API3 Key.
try {
$result = $apiInstance->login($client_id, $client_secret);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ApiAuthApi->login: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| client_id | string | client_id part of API3 Key. | [optional] |
| client_secret | string | client_secret part of API3 Key. | [optional] |
\Swagger\Client\Model\AccessToken
No authorization required
- Content-Type: application/x-www-form-urlencoded
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\AccessToken loginUser($user_id, $associative)
Login user
Create an access token that runs as 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.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ApiAuthApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$user_id = "user_id_example"; // string | Id of user.
$associative = true; // bool | When true (default), API calls using the returned access_token are attributed to the admin user who created the access_token. When false, API activity is attributed to the user the access_token runs as. False requires a looker license.
try {
$result = $apiInstance->loginUser($user_id, $associative);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ApiAuthApi->loginUser: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user. | |
| associative | bool | When true (default), API calls using the returned access_token are attributed to the admin user who created the access_token. When false, API activity is attributed to the user the access_token runs as. False requires a looker license. | [optional] |
\Swagger\Client\Model\AccessToken
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
string logout()
Logout
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\ApiAuthApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
try {
$result = $apiInstance->logout();
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ApiAuthApi->logout: ', $e->getMessage(), PHP_EOL;
}
?>This endpoint does not need any parameter.
string
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]