メインコンテンツへスキップ
POST
https://{tenantDomain}/api/v2
/
tickets
/
password-change
Go
package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ChangePasswordTicketRequestContent{}
    client.Tickets.ChangePassword(
        context.TODO(),
        request,
    )
}
{
  "ticket": "https://login.auth0.com/lo/reset?client_id=nsaPS2p3cargoFy82WT7betaOPOt3qSh&tenant=mdocs&bewit=bmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPdDNxU2hcMTQzMDY2MjE4MVxuRTcxM0RSeUNlbEpzUUJmaFVaS3A1NEdJbWFzSUZMYzRTdEFtY2NMMXhZPVx7ImVtYWloojoiZGFtaWtww2NoQGhvdG1haWwuY29tIiwidGVuYW50IjoiZHNjaGVua2tjwWFuIiwiY2xpZW50X2lkIjoibmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPiiqxU2giLCJjb25uZWN0aW9uIjoiRGFtaWmsdiwicmVzdWx0VXJsIjoiIn0"
}

承認

Authorization
string
header
必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

ヘッダー

auth0-custom-domain
string

このリクエストで使用するカスタムドメイン

Required string length: 3 - 255

ボディ

client_id
string<client-id>
デフォルト:DaM8bokEXBWrTUFCiJjWn50jei6ardyX

クライアント(アプリケーション)の ID。New Universal Login エクスペリエンスを使用するテナントで指定すると、メールテンプレートと UI にアプリケーションの詳細が表示され、チケットの使用後、ユーザーにアプリケーションのデフォルトのログインルートへリダイレクトするよう促します。Password Reset Post Challenge トリガーを使用するには client_id が必要です。

connection_id
string
デフォルト:con_0000000000000001

接続の ID。指定すると、user_id ではなくメールアドレスでユーザーを指定できます。この値を設定する場合は、email パラメーターも送信する必要があります。connection_id を指定する場合、user_id は送信できません。

Pattern: ^con_[A-Za-z0-9]{16}$
email
string<email>

チケットの作成対象ユーザーのメールアドレス。connection_id パラメーターが必要です。user_id を使用する場合は指定できません。

identity
object
EA

ユーザーのアイデンティティ。この値を設定する場合は、user_id パラメーターも送信する必要があります。

includeEmailInRedirect
boolean

reset_email の returnUrl にメールアドレスを含めるか(true)、含めないか(false)を指定します。

mark_email_as_verified
boolean
デフォルト:false

email_verified 属性を true に設定するか(true)、更新しないか(false)を指定します。

organization_id
string<organization-id>
デフォルト:org_2eondWoxcMIpaLQc

(任意)組織 ID - 組織の ID。指定すると、organization パラメーターがメールテンプレートで利用可能になり、組織のブランディングがプロンプトに適用されます。さらに、プロンプト内のリダイレクトリンクには、organization_id と organization_name のクエリ文字列パラメーターが含まれます。

result_url
string<url>
デフォルト:http://myapp.com/callback

チケットが使用されると、Classic Universal Login エクスペリエンスでユーザーがリダイレクトされる URL。organization_id を使用する場合は指定できません。テナントでカスタムのパスワードリセットページが有効になっており、password-reset-post-challenge Action がバインドされている場合は、client_id とあわせて指定できます。

ttl_sec
integer

有効期限が切れるまでチケットが有効な秒数。未指定の場合、または 0 に設定した場合、この値はデフォルトで 432000 秒(5 日)になります。

必須範囲: x >= 0
user_id
string<user-id>

チケットの作成対象ユーザーの user_id。

レスポンス

チケットが正常に作成されました。

ticket
string<url>
デフォルト:https://login.auth0.com/lo/reset?client_id=nsaPS2p3cargoFy82WT7betaOPOt3qSh&tenant=mdocs&bewit=bmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPdDNxU2hcMTQzMDY2MjE4MVxuRTcxM0RSeUNlbEpzUUJmaFVaS3A1NEdJbWFzSUZMYzRTdEFtY2NMMXhZPVx7ImVtYWloojoiZGFtaWtww2NoQGhvdG1haWwuY29tIiwidGVuYW50IjoiZHNjaGVua2tjwWFuIiwiY2xpZW50X2lkIjoibmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPiiqxU2giLCJjb25uZWN0aW9uIjoiRGFtaWmsdiwicmVzdWx0VXJsIjoiIn0
必須

ticket を表す URL。