Version 4.0.24.16 (latest)
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}
Expand HTTP Path definition...
credential_type
string
Type name of credential
credential_id
string
Id of credential
Expand HTTP Query definition...
fields
string
Requested fields.
Response
200: Specified user.
can
lock
object
Operations the current user is able to perform on this object
avatar_url
lock
string
URL for the avatar image (may be generic)
avatar_url_without_sizing
lock
string
URL for the avatar image (may be generic), does not specify size
Expand CredentialsApi3 definition...
can
lock
object
Operations the current user is able to perform on this object
client_id
lock
string
API key client_id
created_at
lock
string
Timestamp for the creation of this credential
is_disabled
lock
boolean
Has this credential been disabled?
type
lock
string
Short name for the type of this kind of credential
url
lock
string
Link to get this item
credentials_email
lock
Email/Password login credentials
Expand CredentialsEmail definition...
can
lock
object
Operations the current user is able to perform on this object
created_at
lock
string
Timestamp for the creation of this credential
email
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
lock
string
Unique Id of the user
is_disabled
lock
boolean
Has this credential been disabled?
logged_in_at
lock
string
Timestamp for most recent login using credential
password_reset_url
lock
string
Url with one-time use secret token that the user can use to reset password
account_setup_url
lock
string
Url with one-time use secret token that the user can use to setup account
password_reset_url_expired
lock
boolean
Is password_reset_url expired or not present?
account_setup_url_expired
lock
boolean
Is account_setup_url expired or not present?
type
lock
string
Short name for the type of this kind of credential
url
lock
string
Link to get this item
user_url
lock
string
Link to get this user
Expand CredentialsEmbed definition...
can
lock
object
Operations the current user is able to perform on this object
created_at
lock
string
Timestamp for the creation of this credential
external_group_id
lock
string
Embedder's id for a group to which this user was added during the most recent login
external_user_id
lock
string
Embedder's unique id for the user
is_disabled
lock
boolean
Has this credential been disabled?
logged_in_at
lock
string
Timestamp for most recent login using credential
type
lock
string
Short name for the type of this kind of credential
url
lock
string
Link to get this item
credentials_google
lock
Google auth credentials
Expand CredentialsGoogle definition...
can
lock
object
Operations the current user is able to perform on this object
created_at
lock
string
Timestamp for the creation of this credential
domain
lock
string
Google domain
email
lock
string
EMail address
google_user_id
lock
string
Google's Unique ID for this user
is_disabled
lock
boolean
Has this credential been disabled?
logged_in_at
lock
string
Timestamp for most recent login using credential
type
lock
string
Short name for the type of this kind of credential
url
lock
string
Link to get this item
credentials_ldap
lock
LDAP credentials
Expand CredentialsLDAP definition...
can
lock
object
Operations the current user is able to perform on this object
created_at
lock
string
Timestamp for the creation of this credential
email
lock
string
EMail address
is_disabled
lock
boolean
Has this credential been disabled?
ldap_dn
lock
string
LDAP Distinguished name for this user (as-of the last login)
ldap_id
lock
string
LDAP Unique ID for this user
logged_in_at
lock
string
Timestamp for most recent login using credential
type
lock
string
Short name for the type of this kind of credential
url
lock
string
Link to get this item
credentials_looker_openid
lock
LookerOpenID credentials. Used for login by Looker Analysts
Expand CredentialsLookerOpenid definition...
can
lock
object
Operations the current user is able to perform on this object
created_at
lock
string
Timestamp for the creation of this credential
email
lock
string
EMail address used for user login
is_disabled
lock
boolean
Has this credential been disabled?
logged_in_at
lock
string
Timestamp for most recent login using credential
logged_in_ip
lock
string
IP address of client for most recent login using credential
type
lock
string
Short name for the type of this kind of credential
url
lock
string
Link to get this item
user_url
lock
string
Link to get this user
credentials_oidc
lock
OpenID Connect auth credentials
Expand CredentialsOIDC definition...
can
lock
object
Operations the current user is able to perform on this object
created_at
lock
string
Timestamp for the creation of this credential
email
lock
string
EMail address
is_disabled
lock
boolean
Has this credential been disabled?
logged_in_at
lock
string
Timestamp for most recent login using credential
oidc_user_id
lock
string
OIDC OP's Unique ID for this user
type
lock
string
Short name for the type of this kind of credential
url
lock
string
Link to get this item
credentials_saml
lock
Saml auth credentials
Expand CredentialsSaml definition...
can
lock
object
Operations the current user is able to perform on this object
created_at
lock
string
Timestamp for the creation of this credential
email
lock
string
EMail address
is_disabled
lock
boolean
Has this credential been disabled?
logged_in_at
lock
string
Timestamp for most recent login using credential
saml_user_id
lock
string
Saml IdP's Unique ID for this user
type
lock
string
Short name for the type of this kind of credential
url
lock
string
Link to get this item
credentials_totp
lock
Two-factor credentials
Expand CredentialsTotp definition...
can
lock
object
Operations the current user is able to perform on this object
created_at
lock
string
Timestamp for the creation of this credential
is_disabled
lock
boolean
Has this credential been disabled?
type
lock
string
Short name for the type of this kind of credential
verified
lock
boolean
User has verified
url
lock
string
Link to get this item
display_name
lock
string
Full name for display (available only if both first_name and last_name are set)
email
lock
string
EMail address
embed_group_space_id
lock
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
home_folder_id
string
ID string for user's home folder
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.
models_dir_validated
boolean
User's dev workspace has been checked for presence of applicable production projects
personal_folder_id
lock
string
ID of user's personal folder
presumed_looker_employee
lock
boolean
(DEPRECATED) User is identified as an employee of Looker
Expand Session definition...
can
lock
object
Operations the current user is able to perform on this object
ip_address
lock
string
IP address of user when this session was initiated
browser
lock
string
User's browser type
operating_system
lock
string
User's Operating System
city
lock
string
City component of user location (derived from IP address)
state
lock
string
State component of user location (derived from IP address)
country
lock
string
Country component of user location (derived from IP address)
credentials_type
lock
string
Type of credentials used for logging in this session
extended_at
lock
string
Time when this session was last extended by the user
extended_count
lock
integer
Number of times this session was extended
sudo_user_id
lock
string
Actual user in the case when this session represents one user sudo'ing as another
created_at
lock
string
Time when this session was initiated
expires_at
lock
string
Time when this session will expire
url
lock
string
Link to get this item
ui_state
object
Per user dictionary of undocumented state information owned by the Looker UI.
verified_looker_employee
lock
boolean
User is identified as an employee of Looker who has been verified via Looker corporate authentication
roles_externally_managed
lock
boolean
User's roles are managed by an external directory like SAML or LDAP and can not be changed directly.
allow_direct_roles
lock
boolean
User can be directly assigned a role.
allow_normal_group_membership
lock
boolean
User can be a direct member of a normal Looker group.
allow_roles_from_normal_groups
lock
boolean
User can inherit roles from a normal Looker group.
embed_group_folder_id
lock
string
(Embed only) ID of user's group folder based on the external_group_id optionally specified during embed user login
is_iam_admin
lock
boolean
User is an IAM Admin - only available in Looker (Google Cloud core)
url
lock
string
Link to get this item
400: Bad Request
message
lock
string
Error details
documentation_url
lock
string
Documentation link
403: Permission Denied
message
lock
string
Error details
documentation_url
lock
string
Documentation link
404: Not Found
message
lock
string
Error details
documentation_url
lock
string
Documentation link
429: Too Many Requests
message
lock
string
Error details
documentation_url
lock
string
Documentation link
Examples