Version 4.0.24.18 (latest)
Update information about the user with a specific id.
Request
PATCH
/users/{user_id}
Datatype
Description
Request
path
Expand HTTP Path definition...
user_id
Id of user
body
Expand HTTP Body definition...
body
User
Expand User definition...
can
lock
Operations the current user is able to perform on this object
avatar_url
lock
URL for the avatar image (may be generic)
avatar_url_without_sizing
lock
URL for the avatar image (may be generic), does not specify size
credentials_api3
credentials_email
lock
Email/Password login credentials
credentials_embed
credentials_google
lock
Google auth credentials
credentials_ldap
lock
LDAP credentials
credentials_looker_openid
lock
LookerOpenID credentials. Used for login by Looker Analysts
credentials_oidc
lock
OpenID Connect auth credentials
credentials_saml
lock
Saml auth credentials
credentials_totp
lock
Two-factor credentials
display_name
lock
Full name for display (available only if both first_name and last_name are set)
email
lock
EMail address
embed_group_space_id
lock
(DEPRECATED) (Embed only) ID of user's group space based on the external_group_id optionally specified during embed user login
first_name
First name
group_ids
home_folder_id
ID string for user's home folder
id
lock
Unique Id
is_disabled
Account has been disabled
last_name
Last name
locale
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
models_dir_validated
User's dev workspace has been checked for presence of applicable production projects
personal_folder_id
lock
ID of user's personal folder
presumed_looker_employee
lock
(DEPRECATED) User is identified as an employee of Looker
role_ids
sessions
ui_state
Per user dictionary of undocumented state information owned by the Looker UI.
verified_looker_employee
lock
User is identified as an employee of Looker who has been verified via Looker corporate authentication
roles_externally_managed
lock
User's roles are managed by an external directory like SAML or LDAP and can not be changed directly.
allow_direct_roles
lock
User can be directly assigned a role.
allow_normal_group_membership
lock
User can be a direct member of a normal Looker group.
allow_roles_from_normal_groups
lock
User can inherit roles from a normal Looker group.
embed_group_folder_id
lock
(Embed only) ID of user's group folder based on the external_group_id optionally specified during embed user login
url
lock
Link to get this item
query
Expand HTTP Query definition...
fields
Requested fields.
Response
200: New state for specified user.
Datatype
Description
(object)
can
lock
Operations the current user is able to perform on this object
avatar_url
lock
URL for the avatar image (may be generic)
avatar_url_without_sizing
lock
URL for the avatar image (may be generic), does not specify size
credentials_api3
Expand CredentialsApi3 definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
client_id
lock
API key client_id
created_at
lock
Timestamp for the creation of this credential
is_disabled
lock
Has this credential been disabled?
type
lock
Short name for the type of this kind of credential
url
lock
Link to get this item
credentials_email
lock
Email/Password login credentials
Expand CredentialsEmail definition...
can
lock
Operations the current user is able to perform on this object
created_at
lock
Timestamp for the creation of this credential
email
EMail address used for user login
forced_password_reset_at_next_login
Force the user to change their password upon their next login
user_id
lock
Unique Id of the user
is_disabled
lock
Has this credential been disabled?
logged_in_at
lock
Timestamp for most recent login using credential
password_reset_url
lock
Url with one-time use secret token that the user can use to reset password
account_setup_url
lock
Url with one-time use secret token that the user can use to setup account
password_reset_url_expired
lock
Is password_reset_url expired or not present?
account_setup_url_expired
lock
Is account_setup_url expired or not present?
type
lock
Short name for the type of this kind of credential
url
lock
Link to get this item
user_url
lock
Link to get this user
credentials_embed
Expand CredentialsEmbed definition...
can
lock
Operations the current user is able to perform on this object
created_at
lock
Timestamp for the creation of this credential
external_group_id
lock
Embedder's id for a group to which this user was added during the most recent login
external_user_id
lock
Embedder's unique id for the user
id
lock
Unique Id
is_disabled
lock
Has this credential been disabled?
logged_in_at
lock
Timestamp for most recent login using credential
type
lock
Short name for the type of this kind of credential
url
lock
Link to get this item
credentials_google
lock
Google auth credentials
Expand CredentialsGoogle definition...
can
lock
Operations the current user is able to perform on this object
created_at
lock
Timestamp for the creation of this credential
domain
lock
Google domain
email
lock
EMail address
google_user_id
lock
Google's Unique ID for this user
is_disabled
lock
Has this credential been disabled?
logged_in_at
lock
Timestamp for most recent login using credential
type
lock
Short name for the type of this kind of credential
url
lock
Link to get this item
credentials_ldap
lock
LDAP credentials
Expand CredentialsLDAP definition...
can
lock
Operations the current user is able to perform on this object
created_at
lock
Timestamp for the creation of this credential
email
lock
EMail address
is_disabled
lock
Has this credential been disabled?
ldap_dn
lock
LDAP Distinguished name for this user (as-of the last login)
ldap_id
lock
LDAP Unique ID for this user
logged_in_at
lock
Timestamp for most recent login using credential
type
lock
Short name for the type of this kind of credential
url
lock
Link to get this item
credentials_looker_openid
lock
LookerOpenID credentials. Used for login by Looker Analysts
Expand CredentialsLookerOpenid definition...
can
lock
Operations the current user is able to perform on this object
created_at
lock
Timestamp for the creation of this credential
email
lock
EMail address used for user login
is_disabled
lock
Has this credential been disabled?
logged_in_at
lock
Timestamp for most recent login using credential
logged_in_ip
lock
IP address of client for most recent login using credential
type
lock
Short name for the type of this kind of credential
url
lock
Link to get this item
user_url
lock
Link to get this user
credentials_oidc
lock
OpenID Connect auth credentials
Expand CredentialsOIDC definition...
can
lock
Operations the current user is able to perform on this object
created_at
lock
Timestamp for the creation of this credential
email
lock
EMail address
is_disabled
lock
Has this credential been disabled?
logged_in_at
lock
Timestamp for most recent login using credential
oidc_user_id
lock
OIDC OP's Unique ID for this user
type
lock
Short name for the type of this kind of credential
url
lock
Link to get this item
credentials_saml
lock
Saml auth credentials
Expand CredentialsSaml definition...
can
lock
Operations the current user is able to perform on this object
created_at
lock
Timestamp for the creation of this credential
email
lock
EMail address
is_disabled
lock
Has this credential been disabled?
logged_in_at
lock
Timestamp for most recent login using credential
saml_user_id
lock
Saml IdP's Unique ID for this user
type
lock
Short name for the type of this kind of credential
url
lock
Link to get this item
credentials_totp
lock
Two-factor credentials
Expand CredentialsTotp definition...
can
lock
Operations the current user is able to perform on this object
created_at
lock
Timestamp for the creation of this credential
is_disabled
lock
Has this credential been disabled?
type
lock
Short name for the type of this kind of credential
verified
lock
User has verified
url
lock
Link to get this item
display_name
lock
Full name for display (available only if both first_name and last_name are set)
email
lock
EMail address
embed_group_space_id
lock
(DEPRECATED) (Embed only) ID of user's group space based on the external_group_id optionally specified during embed user login
first_name
First name
group_ids
home_folder_id
ID string for user's home folder
id
lock
Unique Id
is_disabled
Account has been disabled
last_name
Last name
locale
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
models_dir_validated
User's dev workspace has been checked for presence of applicable production projects
personal_folder_id
lock
ID of user's personal folder
presumed_looker_employee
lock
(DEPRECATED) User is identified as an employee of Looker
role_ids
sessions
Expand Session definition...
can
lock
Operations the current user is able to perform on this object
id
lock
Unique Id
ip_address
lock
IP address of user when this session was initiated
browser
lock
User's browser type
operating_system
lock
User's Operating System
city
lock
City component of user location (derived from IP address)
state
lock
State component of user location (derived from IP address)
country
lock
Country component of user location (derived from IP address)
credentials_type
lock
Type of credentials used for logging in this session
extended_at
lock
Time when this session was last extended by the user
extended_count
lock
Number of times this session was extended
sudo_user_id
lock
Actual user in the case when this session represents one user sudo'ing as another
created_at
lock
Time when this session was initiated
expires_at
lock
Time when this session will expire
url
lock
Link to get this item
ui_state
Per user dictionary of undocumented state information owned by the Looker UI.
verified_looker_employee
lock
User is identified as an employee of Looker who has been verified via Looker corporate authentication
roles_externally_managed
lock
User's roles are managed by an external directory like SAML or LDAP and can not be changed directly.
allow_direct_roles
lock
User can be directly assigned a role.
allow_normal_group_membership
lock
User can be a direct member of a normal Looker group.
allow_roles_from_normal_groups
lock
User can inherit roles from a normal Looker group.
embed_group_folder_id
lock
(Embed only) ID of user's group folder based on the external_group_id optionally specified during embed user login
url
lock
Link to get this item
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
403: Permission Denied
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
Examples
Python
Ruby
https://github.com/looker-open-source/sdk-codegen/blob/main/examples/ruby/disable_users.rb |
Kotlin
https://github.com/looker-open-source/sdk-codegen/blob/main/kotlin/src/test/TestSmoke.kt |
https://github.com/looker-open-source/sdk-codegen/blob/main/kotlin/src/test/TestSmoke.kt |
TypeScript
Swift