All URIs are relative to https://localhost:20000/api/3.1
| Method | HTTP request | Description |
|---|---|---|
| allUserCredentialsApi3s | GET /users/{user_id}/credentials_api3 | Get All API 3 Credentials |
| allUserCredentialsEmbeds | GET /users/{user_id}/credentials_embed | Get All Embedding Credentials |
| allUserSessions | GET /users/{user_id}/sessions | Get All Web Login Sessions |
| allUsers | GET /users | Get All Users |
| createEmbedUser | POST /users/embed_user | Create an embed user from an external user ID |
| createUser | POST /users | Create User |
| createUserCredentialsApi3 | POST /users/{user_id}/credentials_api3 | Create API 3 Credential |
| createUserCredentialsEmail | POST /users/{user_id}/credentials_email | Create Email/Password Credential |
| createUserCredentialsEmailPasswordReset | POST /users/{user_id}/credentials_email/password_reset | Create Password Reset Token |
| createUserCredentialsTotp | POST /users/{user_id}/credentials_totp | Create Two-Factor Credential |
| deleteUser | DELETE /users/{user_id} | Delete User |
| deleteUserAttributeUserValue | DELETE /users/{user_id}/attribute_values/{user_attribute_id} | Delete User Attribute User Value |
| deleteUserCredentialsApi3 | DELETE /users/{user_id}/credentials_api3/{credentials_api3_id} | Delete API 3 Credential |
| deleteUserCredentialsEmail | DELETE /users/{user_id}/credentials_email | Delete Email/Password Credential |
| deleteUserCredentialsEmbed | DELETE /users/{user_id}/credentials_embed/{credentials_embed_id} | Delete Embedding Credential |
| deleteUserCredentialsGoogle | DELETE /users/{user_id}/credentials_google | Delete Google Auth Credential |
| deleteUserCredentialsLdap | DELETE /users/{user_id}/credentials_ldap | Delete LDAP Credential |
| deleteUserCredentialsLookerOpenid | DELETE /users/{user_id}/credentials_looker_openid | Delete Looker OpenId Credential |
| deleteUserCredentialsOidc | DELETE /users/{user_id}/credentials_oidc | Delete OIDC Auth Credential |
| deleteUserCredentialsSaml | DELETE /users/{user_id}/credentials_saml | Delete Saml Auth Credential |
| deleteUserCredentialsTotp | DELETE /users/{user_id}/credentials_totp | Delete Two-Factor Credential |
| deleteUserSession | DELETE /users/{user_id}/sessions/{session_id} | Delete Web Login Session |
| me | GET /user | Get Current User |
| searchCredentialsEmail | GET /credentials_email/search | Search CredentialsEmail |
| searchUsers | GET /users/search | Search Users |
| searchUsersNames | GET /users/search/names/{pattern} | Search User Names |
| sendUserCredentialsEmailPasswordReset | POST /users/{user_id}/credentials_email/send_password_reset | Send Password Reset Token |
| setUserAttributeUserValue | PATCH /users/{user_id}/attribute_values/{user_attribute_id} | Set User Attribute User Value |
| setUserRoles | PUT /users/{user_id}/roles | Set User Roles |
| updateUser | PATCH /users/{user_id} | Update User |
| updateUserCredentialsEmail | PATCH /users/{user_id}/credentials_email | Update Email/Password Credential |
| user | GET /users/{user_id} | Get User by Id |
| userAttributeUserValues | GET /users/{user_id}/attribute_values | Get User Attribute Values |
| userCredentialsApi3 | GET /users/{user_id}/credentials_api3/{credentials_api3_id} | Get API 3 Credential |
| userCredentialsEmail | GET /users/{user_id}/credentials_email | Get Email/Password Credential |
| userCredentialsEmbed | GET /users/{user_id}/credentials_embed/{credentials_embed_id} | Get Embedding Credential |
| userCredentialsGoogle | GET /users/{user_id}/credentials_google | Get Google Auth Credential |
| userCredentialsLdap | GET /users/{user_id}/credentials_ldap | Get LDAP Credential |
| userCredentialsLookerOpenid | GET /users/{user_id}/credentials_looker_openid | Get Looker OpenId Credential |
| userCredentialsOidc | GET /users/{user_id}/credentials_oidc | Get OIDC Auth Credential |
| userCredentialsSaml | GET /users/{user_id}/credentials_saml | Get Saml Auth Credential |
| userCredentialsTotp | GET /users/{user_id}/credentials_totp | Get Two-Factor Credential |
| userForCredential | GET /users/credential/{credential_type}/{credential_id} | Get User by Credential Id |
| userRoles | GET /users/{user_id}/roles | Get User Roles |
| userSession | GET /users/{user_id}/sessions/{session_id} | Get Web Login Session |
| wipeoutUserEmails | POST /users/{user_id}/update_emails | Wipeout User Emails |
\Swagger\Client\Model\CredentialsApi3[] allUserCredentialsApi3s($user_id, $fields)
Get All API 3 Credentials
API 3 login information for the specified user. This is for the newer API keys that can be added for any user.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->allUserCredentialsApi3s($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->allUserCredentialsApi3s: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsApi3[]
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsEmbed[] allUserCredentialsEmbeds($user_id, $fields)
Get All Embedding Credentials
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->allUserCredentialsEmbeds($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->allUserCredentialsEmbeds: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsEmbed[]
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Session[] allUserSessions($user_id, $fields)
Get All Web Login Sessions
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->allUserSessions($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->allUserSessions: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\Session[]
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\User[] allUsers($fields, $page, $per_page, $limit, $offset, $sorts, $ids)
Get All Users
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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()
);
$fields = "fields_example"; // string | Requested fields.
$page = 789; // int | DEPRECATED. Use limit and offset instead. Return only page N of paginated results
$per_page = 789; // int | DEPRECATED. Use limit and offset instead. Return N rows of data per page
$limit = 789; // int | Number of results to return. (used with offset and takes priority over page and per_page)
$offset = 789; // int | Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
$sorts = "sorts_example"; // string | Fields to sort by.
$ids = array("ids_example"); // string[] | Optional list of ids to get specific users.
try {
$result = $apiInstance->allUsers($fields, $page, $per_page, $limit, $offset, $sorts, $ids);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->allUsers: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| fields | string | Requested fields. | [optional] |
| page | int | DEPRECATED. Use limit and offset instead. Return only page N of paginated results | [optional] |
| per_page | int | DEPRECATED. Use limit and offset instead. Return N rows of data per page | [optional] |
| limit | int | Number of results to return. (used with offset and takes priority over page and per_page) | [optional] |
| offset | int | Number of results to skip before returning any. (used with limit and takes priority over page and per_page) | [optional] |
| sorts | string | Fields to sort by. | [optional] |
| ids | string[] | Optional list of ids to get specific users. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\UserPublic createEmbedUser($body)
Create an embed user from an external user ID
Create an embed user from an external user ID
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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()
);
$body = new \Swagger\Client\Model\CreateEmbedUserRequest(); // \Swagger\Client\Model\CreateEmbedUserRequest | null
try {
$result = $apiInstance->createEmbedUser($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->createEmbedUser: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \Swagger\Client\Model\CreateEmbedUserRequest | null |
\Swagger\Client\Model\UserPublic
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\User createUser($body, $fields)
Create User
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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()
);
$body = new \Swagger\Client\Model\User(); // \Swagger\Client\Model\User | User
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->createUser($body, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->createUser: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| body | \Swagger\Client\Model\User | User | [optional] |
| fields | string | Requested fields. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CreateCredentialsApi3 createUserCredentialsApi3($user_id, $fields)
Create API 3 Credential
API 3 login information for the specified user. This is for the newer API keys that can be added for any user.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->createUserCredentialsApi3($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->createUserCredentialsApi3: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CreateCredentialsApi3
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsEmail createUserCredentialsEmail($user_id, $body, $fields)
Create Email/Password Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$body = new \Swagger\Client\Model\CredentialsEmail(); // \Swagger\Client\Model\CredentialsEmail | Email/Password Credential
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->createUserCredentialsEmail($user_id, $body, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->createUserCredentialsEmail: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| body | \Swagger\Client\Model\CredentialsEmail | Email/Password Credential | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsEmail
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsEmail createUserCredentialsEmailPasswordReset($user_id, $expires, $fields)
Create Password Reset Token
Create a password reset token. This will create a cryptographically secure random password reset token for the user. If the user already has a password reset token then this invalidates the old token and creates a new one. The token is expressed as the 'password_reset_url' of the user's email/password credential object. This takes an optional 'expires' param to indicate if the new token should be an expiring token. Tokens that expire are typically used for self-service password resets for existing users. Invitation emails for new users typically are not set to expire. The expire period is always 60 minutes when expires is enabled. This method can be called with an empty body.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$expires = true; // bool | Expiring token.
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->createUserCredentialsEmailPasswordReset($user_id, $expires, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->createUserCredentialsEmailPasswordReset: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| expires | bool | Expiring token. | [optional] |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsEmail
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsTotp createUserCredentialsTotp($user_id, $body, $fields)
Create Two-Factor Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$body = new \Swagger\Client\Model\CredentialsTotp(); // \Swagger\Client\Model\CredentialsTotp | Two-Factor Credential
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->createUserCredentialsTotp($user_id, $body, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->createUserCredentialsTotp: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| body | \Swagger\Client\Model\CredentialsTotp | Two-Factor Credential | [optional] |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsTotp
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 deleteUser($user_id)
Delete User
Delete the user with a specific id. DANGER this will delete the user and all looks and other information owned by the user.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
try {
$result = $apiInstance->deleteUser($user_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user |
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]
deleteUserAttributeUserValue($user_id, $user_attribute_id)
Delete User Attribute User Value
Delete a user attribute value from a user's account settings. After the user attribute value is deleted from the user's account settings, subsequent requests for the user attribute value for this user will draw from the user's groups or the default value of the user attribute. See Get User Attribute Values for more information about how user attribute values are resolved.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$user_attribute_id = "user_attribute_id_example"; // string | Id of user attribute
try {
$apiInstance->deleteUserAttributeUserValue($user_id, $user_attribute_id);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserAttributeUserValue: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| user_attribute_id | string | Id of user attribute |
void (empty response body)
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 deleteUserCredentialsApi3($user_id, $credentials_api3_id)
Delete API 3 Credential
API 3 login information for the specified user. This is for the newer API keys that can be added for any user.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$credentials_api3_id = "credentials_api3_id_example"; // string | Id of API 3 Credential
try {
$result = $apiInstance->deleteUserCredentialsApi3($user_id, $credentials_api3_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserCredentialsApi3: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| credentials_api3_id | string | Id of API 3 Credential |
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]
string deleteUserCredentialsEmail($user_id)
Delete Email/Password Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
try {
$result = $apiInstance->deleteUserCredentialsEmail($user_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserCredentialsEmail: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user |
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]
string deleteUserCredentialsEmbed($user_id, $credentials_embed_id)
Delete Embedding Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$credentials_embed_id = "credentials_embed_id_example"; // string | Id of Embedding Credential
try {
$result = $apiInstance->deleteUserCredentialsEmbed($user_id, $credentials_embed_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserCredentialsEmbed: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| credentials_embed_id | string | Id of Embedding Credential |
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]
string deleteUserCredentialsGoogle($user_id)
Delete Google Auth Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
try {
$result = $apiInstance->deleteUserCredentialsGoogle($user_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserCredentialsGoogle: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user |
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]
string deleteUserCredentialsLdap($user_id)
Delete LDAP Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
try {
$result = $apiInstance->deleteUserCredentialsLdap($user_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserCredentialsLdap: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user |
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]
string deleteUserCredentialsLookerOpenid($user_id)
Delete Looker OpenId Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
try {
$result = $apiInstance->deleteUserCredentialsLookerOpenid($user_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserCredentialsLookerOpenid: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user |
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]
string deleteUserCredentialsOidc($user_id)
Delete OIDC Auth Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
try {
$result = $apiInstance->deleteUserCredentialsOidc($user_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserCredentialsOidc: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user |
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]
string deleteUserCredentialsSaml($user_id)
Delete Saml Auth Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
try {
$result = $apiInstance->deleteUserCredentialsSaml($user_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserCredentialsSaml: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user |
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]
string deleteUserCredentialsTotp($user_id)
Delete Two-Factor Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
try {
$result = $apiInstance->deleteUserCredentialsTotp($user_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserCredentialsTotp: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user |
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]
string deleteUserSession($user_id, $session_id)
Delete Web Login Session
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$session_id = "session_id_example"; // string | Id of Web Login Session
try {
$result = $apiInstance->deleteUserSession($user_id, $session_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->deleteUserSession: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| session_id | string | Id of Web Login Session |
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]
\Swagger\Client\Model\User me($fields)
Get Current User
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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()
);
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->me($fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->me: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| fields | string | Requested fields. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsEmailSearch[] searchCredentialsEmail($fields, $limit, $offset, $sorts, $id, $email, $emails, $filter_or)
Search CredentialsEmail
Search email credentials Returns all credentials_email records that match the given search criteria. If multiple search params are given and filter_or is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned. If filter_or is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria. String search params use case-insensitive matching. String search params can contain % and '_' as SQL LIKE pattern match wildcard expressions. example="dan%" will match "danger" and "Danzig" but not "David" example="D_m%" will match "Damage" and "dump" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only "true" and "false" as values.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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()
);
$fields = "fields_example"; // string | Requested fields.
$limit = 789; // int | Number of results to return (used with `offset`).
$offset = 789; // int | Number of results to skip before returning any (used with `limit`).
$sorts = "sorts_example"; // string | Fields to sort by.
$id = "id_example"; // string | Match credentials_email id.
$email = "email_example"; // string | Match credentials_email email.
$emails = "emails_example"; // string | Find credentials_email that match given emails.
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression.
try {
$result = $apiInstance->searchCredentialsEmail($fields, $limit, $offset, $sorts, $id, $email, $emails, $filter_or);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->searchCredentialsEmail: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| fields | string | Requested fields. | [optional] |
| limit | int | Number of results to return (used with `offset`). | [optional] |
| offset | int | Number of results to skip before returning any (used with `limit`). | [optional] |
| sorts | string | Fields to sort by. | [optional] |
| id | string | Match credentials_email id. | [optional] |
| string | Match credentials_email email. | [optional] | |
| emails | string | Find credentials_email that match given emails. | [optional] |
| filter_or | bool | Combine given search criteria in a boolean OR expression. | [optional] |
\Swagger\Client\Model\CredentialsEmailSearch[]
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\User[] searchUsers($fields, $page, $per_page, $limit, $offset, $sorts, $id, $first_name, $last_name, $verified_looker_employee, $embed_user, $email, $is_disabled, $filter_or, $content_metadata_id, $group_id)
Search Users
Search users Returns all user records that match the given search criteria. If multiple search params are given and filter_or is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned. If filter_or is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria. String search params use case-insensitive matching. String search params can contain % and '_' as SQL LIKE pattern match wildcard expressions. example="dan%" will match "danger" and "Danzig" but not "David" example="D_m%" will match "Damage" and "dump" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only "true" and "false" as values. () Results are always filtered to the level of information the caller is permitted to view. Looker admins can see all user details; normal users in an open system can see names of other users but no details; normal users in a closed system can only see names of other users who are members of the same group as the user.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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()
);
$fields = "fields_example"; // string | Include only these fields in the response
$page = 789; // int | DEPRECATED. Use limit and offset instead. Return only page N of paginated results
$per_page = 789; // int | DEPRECATED. Use limit and offset instead. Return N rows of data per page
$limit = 789; // int | Number of results to return. (used with offset and takes priority over page and per_page)
$offset = 789; // int | Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
$sorts = "sorts_example"; // string | Fields to sort by.
$id = "id_example"; // string | Match User Id.
$first_name = "first_name_example"; // string | Match First name.
$last_name = "last_name_example"; // string | Match Last name.
$verified_looker_employee = true; // bool | Search for user accounts associated with Looker employees
$embed_user = true; // bool | Search for only embed users
$email = "email_example"; // string | Search for the user with this email address
$is_disabled = true; // bool | Search for disabled user accounts
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression
$content_metadata_id = "content_metadata_id_example"; // string | Search for users who have access to this content_metadata item
$group_id = "group_id_example"; // string | Search for users who are direct members of this group
try {
$result = $apiInstance->searchUsers($fields, $page, $per_page, $limit, $offset, $sorts, $id, $first_name, $last_name, $verified_looker_employee, $embed_user, $email, $is_disabled, $filter_or, $content_metadata_id, $group_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->searchUsers: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| fields | string | Include only these fields in the response | [optional] |
| page | int | DEPRECATED. Use limit and offset instead. Return only page N of paginated results | [optional] |
| per_page | int | DEPRECATED. Use limit and offset instead. Return N rows of data per page | [optional] |
| limit | int | Number of results to return. (used with offset and takes priority over page and per_page) | [optional] |
| offset | int | Number of results to skip before returning any. (used with limit and takes priority over page and per_page) | [optional] |
| sorts | string | Fields to sort by. | [optional] |
| id | string | Match User Id. | [optional] |
| first_name | string | Match First name. | [optional] |
| last_name | string | Match Last name. | [optional] |
| verified_looker_employee | bool | Search for user accounts associated with Looker employees | [optional] |
| embed_user | bool | Search for only embed users | [optional] |
| string | Search for the user with this email address | [optional] | |
| is_disabled | bool | Search for disabled user accounts | [optional] |
| filter_or | bool | Combine given search criteria in a boolean OR expression | [optional] |
| content_metadata_id | string | Search for users who have access to this content_metadata item | [optional] |
| group_id | string | Search for users who are direct members of this group | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\User[] searchUsersNames($pattern, $fields, $page, $per_page, $limit, $offset, $sorts, $id, $first_name, $last_name, $verified_looker_employee, $email, $is_disabled)
Search User Names
Search for user accounts by name Returns all user accounts where first_name OR last_name OR email field values match a pattern. The pattern can contain % and _ wildcards as in SQL LIKE expressions. Any additional search params will be combined into a logical AND expression.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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()
);
$pattern = "pattern_example"; // string | Pattern to match
$fields = "fields_example"; // string | Include only these fields in the response
$page = 789; // int | DEPRECATED. Use limit and offset instead. Return only page N of paginated results
$per_page = 789; // int | DEPRECATED. Use limit and offset instead. Return N rows of data per page
$limit = 789; // int | Number of results to return. (used with offset and takes priority over page and per_page)
$offset = 789; // int | Number of results to skip before returning any. (used with limit and takes priority over page and per_page)
$sorts = "sorts_example"; // string | Fields to sort by
$id = "id_example"; // string | Match User Id
$first_name = "first_name_example"; // string | Match First name
$last_name = "last_name_example"; // string | Match Last name
$verified_looker_employee = true; // bool | Match Verified Looker employee
$email = "email_example"; // string | Match Email Address
$is_disabled = true; // bool | Include or exclude disabled accounts in the results
try {
$result = $apiInstance->searchUsersNames($pattern, $fields, $page, $per_page, $limit, $offset, $sorts, $id, $first_name, $last_name, $verified_looker_employee, $email, $is_disabled);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->searchUsersNames: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| pattern | string | Pattern to match | |
| fields | string | Include only these fields in the response | [optional] |
| page | int | DEPRECATED. Use limit and offset instead. Return only page N of paginated results | [optional] |
| per_page | int | DEPRECATED. Use limit and offset instead. Return N rows of data per page | [optional] |
| limit | int | Number of results to return. (used with offset and takes priority over page and per_page) | [optional] |
| offset | int | Number of results to skip before returning any. (used with limit and takes priority over page and per_page) | [optional] |
| sorts | string | Fields to sort by | [optional] |
| id | string | Match User Id | [optional] |
| first_name | string | Match First name | [optional] |
| last_name | string | Match Last name | [optional] |
| verified_looker_employee | bool | Match Verified Looker employee | [optional] |
| string | Match Email Address | [optional] | |
| is_disabled | bool | Include or exclude disabled accounts in the results | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsEmail sendUserCredentialsEmailPasswordReset($user_id, $fields)
Send Password Reset Token
Send a password reset token. This will send a password reset email to the user. If a password reset token does not already exist for this user, it will create one and then send it. If the user has not yet set up their account, it will send a setup email to the user. The URL sent in the email is expressed as the 'password_reset_url' of the user's email/password credential object. Password reset URLs will expire in 60 minutes. This method can be called with an empty body.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->sendUserCredentialsEmailPasswordReset($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->sendUserCredentialsEmailPasswordReset: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsEmail
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\UserAttributeWithValue setUserAttributeUserValue($user_id, $user_attribute_id, $body)
Set User Attribute User Value
Store a custom value for a user attribute in a user's account settings. Per-user user attribute values take precedence over group or default values.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$user_attribute_id = "user_attribute_id_example"; // string | Id of user attribute
$body = new \Swagger\Client\Model\UserAttributeWithValue(); // \Swagger\Client\Model\UserAttributeWithValue | New attribute value for user.
try {
$result = $apiInstance->setUserAttributeUserValue($user_id, $user_attribute_id, $body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->setUserAttributeUserValue: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| user_attribute_id | string | Id of user attribute | |
| body | \Swagger\Client\Model\UserAttributeWithValue | New attribute value for user. |
\Swagger\Client\Model\UserAttributeWithValue
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Role[] setUserRoles($user_id, $body, $fields)
Set User Roles
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$body = array(new \Swagger\Client\Model\string[]()); // string[] | array of roles ids for user
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->setUserRoles($user_id, $body, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->setUserRoles: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| body | string[] | array of roles ids for user | |
| fields | string | Requested fields. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\User updateUser($user_id, $body, $fields)
Update User
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$body = new \Swagger\Client\Model\User(); // \Swagger\Client\Model\User | User
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->updateUser($user_id, $body, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->updateUser: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| body | \Swagger\Client\Model\User | User | |
| fields | string | Requested fields. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsEmail updateUserCredentialsEmail($user_id, $body, $fields)
Update Email/Password Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$body = new \Swagger\Client\Model\CredentialsEmail(); // \Swagger\Client\Model\CredentialsEmail | Email/Password Credential
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->updateUserCredentialsEmail($user_id, $body, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->updateUserCredentialsEmail: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| body | \Swagger\Client\Model\CredentialsEmail | Email/Password Credential | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsEmail
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\User user($user_id, $fields)
Get User by Id
Get information about the user with a specific id. If the caller is an admin or the caller is the user being specified, then full user information will be returned. Otherwise, a minimal 'public' variant of the user information will be returned. This contains The user name and avatar url, but no sensitive information.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->user($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->user: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\UserAttributeWithValue[] userAttributeUserValues($user_id, $fields, $user_attribute_ids, $all_values, $include_unset)
Get User Attribute Values
Get user attribute values for a given user. Returns the values of specified user attributes (or all user attributes) for a certain user. A value for each user attribute is searched for in the following locations, in this order: 1. in the user's account information 1. in groups that the user is a member of 1. the default value of the user attribute If more than one group has a value defined for a user attribute, the group with the lowest rank wins. The response will only include user attributes for which values were found. Use include_unset=true to include empty records for user attributes with no value. The value of all hidden user attributes will be blank.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
$user_attribute_ids = array("user_attribute_ids_example"); // string[] | Specific user attributes to request. Omit or leave blank to request all user attributes.
$all_values = true; // bool | If true, returns all values in the search path instead of just the first value found. Useful for debugging group precedence.
$include_unset = true; // bool | If true, returns an empty record for each requested attribute that has no user, group, or default value.
try {
$result = $apiInstance->userAttributeUserValues($user_id, $fields, $user_attribute_ids, $all_values, $include_unset);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userAttributeUserValues: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
| user_attribute_ids | string[] | Specific user attributes to request. Omit or leave blank to request all user attributes. | [optional] |
| all_values | bool | If true, returns all values in the search path instead of just the first value found. Useful for debugging group precedence. | [optional] |
| include_unset | bool | If true, returns an empty record for each requested attribute that has no user, group, or default value. | [optional] |
\Swagger\Client\Model\UserAttributeWithValue[]
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsApi3 userCredentialsApi3($user_id, $credentials_api3_id, $fields)
Get API 3 Credential
API 3 login information for the specified user. This is for the newer API keys that can be added for any user.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$credentials_api3_id = "credentials_api3_id_example"; // string | Id of API 3 Credential
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userCredentialsApi3($user_id, $credentials_api3_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userCredentialsApi3: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| credentials_api3_id | string | Id of API 3 Credential | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsApi3
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsEmail userCredentialsEmail($user_id, $fields)
Get Email/Password Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userCredentialsEmail($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userCredentialsEmail: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsEmail
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsEmbed userCredentialsEmbed($user_id, $credentials_embed_id, $fields)
Get Embedding Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$credentials_embed_id = "credentials_embed_id_example"; // string | Id of Embedding Credential
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userCredentialsEmbed($user_id, $credentials_embed_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userCredentialsEmbed: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| credentials_embed_id | string | Id of Embedding Credential | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsEmbed
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsGoogle userCredentialsGoogle($user_id, $fields)
Get Google Auth Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userCredentialsGoogle($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userCredentialsGoogle: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsGoogle
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsLDAP userCredentialsLdap($user_id, $fields)
Get LDAP Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userCredentialsLdap($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userCredentialsLdap: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsLDAP
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsLookerOpenid userCredentialsLookerOpenid($user_id, $fields)
Get Looker OpenId Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userCredentialsLookerOpenid($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userCredentialsLookerOpenid: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsLookerOpenid
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsOIDC userCredentialsOidc($user_id, $fields)
Get OIDC Auth Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userCredentialsOidc($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userCredentialsOidc: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsOIDC
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsSaml userCredentialsSaml($user_id, $fields)
Get Saml Auth Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userCredentialsSaml($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userCredentialsSaml: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsSaml
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\CredentialsTotp userCredentialsTotp($user_id, $fields)
Get Two-Factor Credential
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userCredentialsTotp($user_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userCredentialsTotp: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
\Swagger\Client\Model\CredentialsTotp
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\User userForCredential($credential_type, $credential_id, $fields)
Get User by Credential Id
Get information about the user with a credential of given type with specific id. This is used to do things like find users by their embed external_user_id. Or, find the user with a given api3 client_id, etc. The 'credential_type' matches the 'type' name of the various credential types. It must be one of the values listed in the table below. The 'credential_id' is your unique Id for the user and is specific to each type of credential. An example using the Ruby sdk might look like: sdk.user_for_credential('embed', 'customer-4959425') This table shows the supported 'Credential Type' strings. The right column is for reference; it shows which field in the given credential type is actually searched when finding a user with the supplied 'credential_id'. | Credential Types | Id Field Matched | | ---------------- | ---------------- | | email | email | | google | google_user_id | | saml | saml_user_id | | oidc | oidc_user_id | | ldap | ldap_id | | api | token | | api3 | client_id | | embed | external_user_id | | looker_openid | email | NOTE: The 'api' credential type was only used with the legacy Looker query API and is no longer supported. The credential type for API you are currently looking at is 'api3'.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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()
);
$credential_type = "credential_type_example"; // string | Type name of credential
$credential_id = "credential_id_example"; // string | Id of credential
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userForCredential($credential_type, $credential_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userForCredential: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| credential_type | string | Type name of credential | |
| credential_id | string | Id of credential | |
| fields | string | Requested fields. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Role[] userRoles($user_id, $fields, $direct_association_only)
Get User Roles
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$fields = "fields_example"; // string | Requested fields.
$direct_association_only = true; // bool | Get only roles associated directly with the user: exclude those only associated through groups.
try {
$result = $apiInstance->userRoles($user_id, $fields, $direct_association_only);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userRoles: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| fields | string | Requested fields. | [optional] |
| direct_association_only | bool | Get only roles associated directly with the user: exclude those only associated through groups. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\Session userSession($user_id, $session_id, $fields)
Get Web Login Session
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$session_id = "session_id_example"; // string | Id of Web Login Session
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->userSession($user_id, $session_id, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->userSession: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| session_id | string | Id of Web Login Session | |
| fields | string | Requested fields. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\Swagger\Client\Model\User wipeoutUserEmails($user_id, $body, $fields)
Wipeout User Emails
Change a disabled user's email addresses Allows the admin to change the email addresses for all the user's associated credentials. Will overwrite all associated email addresses with the value supplied in the 'email' body param. The user's 'is_disabled' status must be true.
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new Swagger\Client\Api\UserApi(
// 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
$body = new \Swagger\Client\Model\UserEmailOnly(); // \Swagger\Client\Model\UserEmailOnly | null
$fields = "fields_example"; // string | Requested fields.
try {
$result = $apiInstance->wipeoutUserEmails($user_id, $body, $fields);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling UserApi->wipeoutUserEmails: ', $e->getMessage(), PHP_EOL;
}
?>| Name | Type | Description | Notes |
|---|---|---|---|
| user_id | string | Id of user | |
| body | \Swagger\Client\Model\UserEmailOnly | null | |
| fields | string | Requested fields. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]