Get User by Credential Id

Version 4.0.25.16

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'.

Calls to this endpoint may be denied by Looker (Google Cloud core).

Request

GET /users/credential/{credential_type}/{credential_id}

Datatype

Description

Request

HTTP Request

path

HTTP Path

Expand HTTP Path definition...

credential_type

string

Type name of credential

credential_id

string

Id of credential

query

HTTP Query

Expand HTTP Query definition...

fields

string

Requested fields.

Response

200: Specified user.

Datatype

Description

(object)

User

can

object

Operations the current user is able to perform on this object

avatar_url

string

URL for the avatar image (may be generic)

avatar_url_without_sizing

string

URL for the avatar image (may be generic), does not specify size

credentials_api3

CredentialsApi3[]

Expand CredentialsApi3 definition...

can

object

Operations the current user is able to perform on this object

string

Unique Id

client_id

string

API key client_id

created_at

string

Timestamp for the creation of this credential

is_disabled

boolean

Has this credential been disabled?

type

string

Short name for the type of this kind of credential

purpose

string

User defined purpose for this credential.

url

string

Link to get this item

credentials_email

CredentialsEmail

Email/Password login credentials

Expand CredentialsEmail definition...

can

object

Operations the current user is able to perform on this object

created_at

string

Timestamp for the creation of this credential

string

EMail address used for user login

forced_password_reset_at_next_login

boolean

Force the user to change their password upon their next login

user_id

string

Unique Id of the user

is_disabled

boolean

Has this credential been disabled?

logged_in_at

string

Timestamp for most recent login using credential

password_reset_url

string

Url with one-time use secret token that the user can use to reset password

account_setup_url

string

Url with one-time use secret token that the user can use to setup account

password_reset_url_expired

boolean

Is password_reset_url expired or not present?

account_setup_url_expired

boolean

Is account_setup_url expired or not present?

type

string

Short name for the type of this kind of credential

url

string

Link to get this item

user_url

string

Link to get this user

credentials_embed

CredentialsEmbed[]

Expand CredentialsEmbed definition...

can

object

Operations the current user is able to perform on this object

created_at

string

Timestamp for the creation of this credential

external_group_id

string

Embedder's id for a group to which this user was added during the most recent login

external_user_id

string

Embedder's unique id for the user

string

Unique Id

is_disabled

boolean

Has this credential been disabled?

logged_in_at

string

Timestamp for most recent login using credential

type

string

Short name for the type of this kind of credential

url

string

Link to get this item

credentials_google

CredentialsGoogle

Google auth credentials

Expand CredentialsGoogle definition...

can

object

Operations the current user is able to perform on this object

created_at

string

Timestamp for the creation of this credential

domain

string

Google domain

string

EMail address

google_user_id

string

Google's Unique ID for this user

is_disabled

boolean

Has this credential been disabled?

logged_in_at

string

Timestamp for most recent login using credential

type

string

Short name for the type of this kind of credential

url

string

Link to get this item

credentials_ldap

CredentialsLDAP

LDAP credentials

Expand CredentialsLDAP definition...

can

object

Operations the current user is able to perform on this object

created_at

string

Timestamp for the creation of this credential

string

EMail address

is_disabled

boolean

Has this credential been disabled?

ldap_dn

string

LDAP Distinguished name for this user (as-of the last login)

ldap_id

string

LDAP Unique ID for this user

logged_in_at

string

Timestamp for most recent login using credential

type

string

Short name for the type of this kind of credential

url

string

Link to get this item

credentials_looker_openid

CredentialsLookerOpenid

LookerOpenID credentials. Used for login by Looker Analysts

Expand CredentialsLookerOpenid definition...

can

object

Operations the current user is able to perform on this object

created_at

string

Timestamp for the creation of this credential

string

EMail address used for user login

is_disabled

boolean

Has this credential been disabled?

logged_in_at

string

Timestamp for most recent login using credential

logged_in_ip

string

IP address of client for most recent login using credential

type

string

Short name for the type of this kind of credential

url

string

Link to get this item

user_url

string

Link to get this user

credentials_oidc

CredentialsOIDC

OpenID Connect auth credentials

Expand CredentialsOIDC definition...

can

object

Operations the current user is able to perform on this object

created_at

string

Timestamp for the creation of this credential

string

EMail address

is_disabled

boolean

Has this credential been disabled?

logged_in_at

string

Timestamp for most recent login using credential

oidc_user_id

string

OIDC OP's Unique ID for this user

type

string

Short name for the type of this kind of credential

url

string

Link to get this item

credentials_saml

CredentialsSaml

Saml auth credentials

Expand CredentialsSaml definition...

can

object

Operations the current user is able to perform on this object

created_at

string

Timestamp for the creation of this credential

string

EMail address

is_disabled

boolean

Has this credential been disabled?

logged_in_at

string

Timestamp for most recent login using credential

saml_user_id

string

Saml IdP's Unique ID for this user

type

string

Short name for the type of this kind of credential

url

string

Link to get this item

credentials_totp

CredentialsTotp

Two-factor credentials

Expand CredentialsTotp definition...

can

object

Operations the current user is able to perform on this object

created_at

string

Timestamp for the creation of this credential

is_disabled

boolean

Has this credential been disabled?

type

string

Short name for the type of this kind of credential

verified

boolean

User has verified

url

string

Link to get this item

display_name

string

Full name for display (available only if both first_name and last_name are set)

string

EMail address

embed_group_space_id

string

(DEPRECATED) (Embed only) ID of user's group space based on the external_group_id optionally specified during embed user login

first_name

string

First name

group_ids

string[]

home_folder_id

string

ID string for user's home folder

string

Unique Id

is_disabled

boolean

Account has been disabled

last_name

string

Last name

locale

string

User's preferred locale. User locale takes precedence over Looker's system-wide default locale. Locale determines language of display strings and date and numeric formatting in API responses. Locale string must be a 2 letter language code or a combination of language code and region code: 'en' or 'en-US', for example.

looker_versions

string[]

models_dir_validated

boolean

User's dev workspace has been checked for presence of applicable production projects

personal_folder_id

string

ID of user's personal folder

presumed_looker_employee

boolean

(DEPRECATED) User is identified as an employee of Looker

role_ids

string[]

sessions

Session[]

Expand Session definition...

can

object

Operations the current user is able to perform on this object

string

Unique Id

ip_address

string

IP address of user when this session was initiated

browser

string

User's browser type

operating_system

string

User's Operating System

city

string

City component of user location (derived from IP address)

state

string

State component of user location (derived from IP address)

country

string

Country component of user location (derived from IP address)

credentials_type

string

Type of credentials used for logging in this session

extended_at

string

Time when this session was last extended by the user

extended_count

integer

Number of times this session was extended

sudo_user_id

string

Actual user in the case when this session represents one user sudo'ing as another

created_at

string

Time when this session was initiated

expires_at

string

Time when this session will expire

url

string

Link to get this item

ui_state

object

Per user dictionary of undocumented state information owned by the Looker UI.

verified_looker_employee

boolean

User is identified as an employee of Looker who has been verified via Looker corporate authentication

roles_externally_managed

boolean

User's roles are managed by an external directory like SAML or LDAP and can not be changed directly.

allow_direct_roles

boolean

User can be directly assigned a role.

allow_normal_group_membership

boolean

User can be a direct member of a normal Looker group.

allow_roles_from_normal_groups

boolean

User can inherit roles from a normal Looker group.

embed_group_folder_id

string

(Embed only) ID of user's group folder based on the external_group_id optionally specified during embed user login

is_iam_admin

boolean

User is an IAM Admin - only available in Looker (Google Cloud core). The is_iam_admin is not returned by default. Please explicitly request this attribute if needed via the fields query param. Note: Including the optional is_iam_admin attribute can increase API latency. For best performance, use this attribute only when filtering for users with the 'Admin via IAM' role. When using this filter, always paginate your results with the offset and limit fields to optimize response time.

can_manage_api3_creds

boolean

Indicates if the user can manage API3 credentials

url

string

Link to get this item

400: Bad Request

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

403: Permission Denied

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

404: Not Found

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

429: Too Many Requests

Datatype

Description

(object)

Error

message

string

Error details

documentation_url

string

Documentation link

Examples

Get User by Credential Id

Get information about the user with a credential of given type with specific id.

Request

Response

200: Specified user.

400: Bad Request

403: Permission Denied

404: Not Found

429: Too Many Requests

Examples

C#

Go

Kotlin

TypeScript

Python

Swift