Create Password Reset Token

Version 4.0.25.0 (latest)

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.

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

Request

POST /users/{user_id}/credentials_email/password_reset
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
user_id
string
Id of user
query
HTTP Query
Expand HTTP Query definition...
expires
boolean
Expiring token.
fields
string
Requested fields.

Response

200: email/password credential

Datatype
Description
(object)
can
object
Operations the current user is able to perform on this object
created_at
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
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

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

403: Permission Denied

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link