GetUserPasswordResetLink

POST

https://api.cbf.tcn.com/api/v0alpha/org/user/password/resetlink

Org

GetUserPasswordResetLink generates a password reset link for a user
in the same org as the current user.
Required Permissions: USER_EDIT
USER_EDIT if user_id given on the request.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Request message for the GetUserPasswordResetLinkRequest rpc.

user_id

string

user_id

optional

The ID of the user in the same org as the current user.

org_id

string

org_id

deprecated

DEPRECATED: org_id was previously optional,
if org_id needs to be provided, use GetUserPasswordResetLinkByOrgId rpc

ttl

integer <int64> | string

ttl

optional

The time to live (in seconds) of the generated link. This will default to 180 if set to 0.

Example

{
  "user_id": "string",
  "org_id": "string",
  "ttl": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/org/user/password/resetlink' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK

application/json

Success

Body

Response message for the GetUserPasswordResetLinkRequest rpc.

url

string

url

optional

the generated link url.

Example

{
  "url": "string"
}

🔴500Server Error

Modified at 2025-04-18 19:29:54

ResetUserRequirePasswordReset

GetMyUserPasswordResetLink