UserApi: User operations

UserApiR Documentation

User operations

Description

looker.User

Methods

all_user_credentials_api3s Get All API 3 Credentials

all_user_credentials_embeds Get All Embedding Credentials

all_user_sessions Get All Web Login Sessions

all_users Get All Users

create_embed_user Create an embed user from an external user ID

create_user Create User

create_user_credentials_api3 Create API 3 Credential

create_user_credentials_email Create Email/Password Credential

create_user_credentials_email_password_reset Create Password Reset Token

create_user_credentials_totp Create Two-Factor Credential

delete_user Delete User

delete_user_attribute_user_value Delete User Attribute User Value

delete_user_credentials_api3 Delete API 3 Credential

delete_user_credentials_email Delete Email/Password Credential

delete_user_credentials_embed Delete Embedding Credential

delete_user_credentials_google Delete Google Auth Credential

delete_user_credentials_ldap Delete LDAP Credential

delete_user_credentials_looker_openid Delete Looker OpenId Credential

delete_user_credentials_oidc Delete OIDC Auth Credential

delete_user_credentials_saml Delete Saml Auth Credential

delete_user_credentials_totp Delete Two-Factor Credential

delete_user_session Delete Web Login Session

me Get Current User

search_credentials_email Search CredentialsEmail

search_users Search Users

search_users_names Search User Names

send_user_credentials_email_password_reset Send Password Reset Token

set_user_attribute_user_value Set User Attribute User Value

set_user_roles Set User Roles

update_user Update User

update_user_credentials_email Update Email/Password Credential

user Get User by Id

user_attribute_user_values Get User Attribute Values

user_credentials_api3 Get API 3 Credential

user_credentials_email Get Email/Password Credential

user_credentials_embed Get Embedding Credential

user_credentials_google Get Google Auth Credential

user_credentials_ldap Get LDAP Credential

user_credentials_looker_openid Get Looker OpenId Credential

user_credentials_oidc Get OIDC Auth Credential

user_credentials_saml Get Saml Auth Credential

user_credentials_totp Get Two-Factor Credential

user_for_credential Get User by Credential Id

user_roles Get User Roles

user_session Get Web Login Session

wipeout_user_emails Wipeout User Emails

Public fields

path

Stores url path of the request.

apiClient

Handles the client-server communication.

userAgent

Set the user agent of the request.

Active bindings

path

Stores url path of the request.

Methods

Public methods


Method new()

Usage
UserApi$new(apiClient)

Method all_user_credentials_api3s()

Usage
UserApi$all_user_credentials_api3s(user_id, fields, ...)

Method all_user_credentials_embeds()

Usage
UserApi$all_user_credentials_embeds(user_id, fields, ...)

Method all_user_sessions()

Usage
UserApi$all_user_sessions(user_id, fields, ...)

Method all_users()

Usage
UserApi$all_users(fields, page, per_page, limit, offset, sorts, ids, ...)

Method create_embed_user()

Usage
UserApi$create_embed_user(body, ...)

Method create_user()

Usage
UserApi$create_user(body, fields, ...)

Method create_user_credentials_api3()

Usage
UserApi$create_user_credentials_api3(user_id, body, fields, ...)

Method create_user_credentials_email()

Usage
UserApi$create_user_credentials_email(user_id, body, fields, ...)

Method create_user_credentials_email_password_reset()

Usage
UserApi$create_user_credentials_email_password_reset(
  user_id,
  expires,
  fields,
  ...
)

Method create_user_credentials_totp()

Usage
UserApi$create_user_credentials_totp(user_id, body, fields, ...)

Method delete_user()

Usage
UserApi$delete_user(user_id, ...)

Method delete_user_attribute_user_value()

Usage
UserApi$delete_user_attribute_user_value(user_id, user_attribute_id, ...)

Method delete_user_credentials_api3()

Usage
UserApi$delete_user_credentials_api3(user_id, credentials_api3_id, ...)

Method delete_user_credentials_email()

Usage
UserApi$delete_user_credentials_email(user_id, ...)

Method delete_user_credentials_embed()

Usage
UserApi$delete_user_credentials_embed(user_id, credentials_embed_id, ...)

Method delete_user_credentials_google()

Usage
UserApi$delete_user_credentials_google(user_id, ...)

Method delete_user_credentials_ldap()

Usage
UserApi$delete_user_credentials_ldap(user_id, ...)

Method delete_user_credentials_looker_openid()

Usage
UserApi$delete_user_credentials_looker_openid(user_id, ...)

Method delete_user_credentials_oidc()

Usage
UserApi$delete_user_credentials_oidc(user_id, ...)

Method delete_user_credentials_saml()

Usage
UserApi$delete_user_credentials_saml(user_id, ...)

Method delete_user_credentials_totp()

Usage
UserApi$delete_user_credentials_totp(user_id, ...)

Method delete_user_session()

Usage
UserApi$delete_user_session(user_id, session_id, ...)

Method me()

Usage
UserApi$me(fields, ...)

Method search_credentials_email()

Usage
UserApi$search_credentials_email(
  fields,
  limit,
  offset,
  sorts,
  id,
  email,
  emails,
  filter_or,
  ...
)

Method search_users()

Usage
UserApi$search_users(
  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,
  ...
)

Method search_users_names()

Usage
UserApi$search_users_names(
  pattern,
  fields,
  page,
  per_page,
  limit,
  offset,
  sorts,
  id,
  first_name,
  last_name,
  verified_looker_employee,
  email,
  is_disabled,
  ...
)

Method send_user_credentials_email_password_reset()

Usage
UserApi$send_user_credentials_email_password_reset(user_id, fields, ...)

Method set_user_attribute_user_value()

Usage
UserApi$set_user_attribute_user_value(user_id, user_attribute_id, body, ...)

Method set_user_roles()

Usage
UserApi$set_user_roles(user_id, body, fields, ...)

Method update_user()

Usage
UserApi$update_user(user_id, body, fields, ...)

Method update_user_credentials_email()

Usage
UserApi$update_user_credentials_email(user_id, body, fields, ...)

Method user()

Usage
UserApi$user(user_id, fields, ...)

Method user_attribute_user_values()

Usage
UserApi$user_attribute_user_values(
  user_id,
  fields,
  user_attribute_ids,
  all_values,
  include_unset,
  ...
)

Method user_credentials_api3()

Usage
UserApi$user_credentials_api3(user_id, credentials_api3_id, fields, ...)

Method user_credentials_email()

Usage
UserApi$user_credentials_email(user_id, fields, ...)

Method user_credentials_embed()

Usage
UserApi$user_credentials_embed(user_id, credentials_embed_id, fields, ...)

Method user_credentials_google()

Usage
UserApi$user_credentials_google(user_id, fields, ...)

Method user_credentials_ldap()

Usage
UserApi$user_credentials_ldap(user_id, fields, ...)

Method user_credentials_looker_openid()

Usage
UserApi$user_credentials_looker_openid(user_id, fields, ...)

Method user_credentials_oidc()

Usage
UserApi$user_credentials_oidc(user_id, fields, ...)

Method user_credentials_saml()

Usage
UserApi$user_credentials_saml(user_id, fields, ...)

Method user_credentials_totp()

Usage
UserApi$user_credentials_totp(user_id, fields, ...)

Method user_for_credential()

Usage
UserApi$user_for_credential(credential_type, credential_id, fields, ...)

Method user_roles()

Usage
UserApi$user_roles(user_id, fields, direct_association_only, ...)

Method user_session()

Usage
UserApi$user_session(user_id, session_id, fields, ...)

Method wipeout_user_emails()

Usage
UserApi$wipeout_user_emails(user_id, body, fields, ...)

Method clone()

The objects of this class are cloneable with this method.

Usage
UserApi$clone(deep = FALSE)
Arguments
deep

Whether to make a deep clone.


looker/lookr documentation built on Jan. 15, 2024, 2:49 a.m.