using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Tickets.ChangePasswordAsync(
            new ChangePasswordTicketRequestContent()
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.ChangePasswordTicketRequestContent{}
    mgmt.Tickets.ChangePassword(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ChangePasswordTicketRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.tickets().changePassword(
            ChangePasswordTicketRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Tickets\Requests\ChangePasswordTicketRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->tickets->changePassword(
    new ChangePasswordTicketRequestContent([]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.tickets.changePassword({});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.tickets.changePassword({});
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/tickets/password-change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "DaM8bokEXBWrTUFCiJjWn50jei6ardyX",
  "connection_id": "con_0000000000000001",
  "email": "jsmith@example.com",
  "includeEmailInRedirect": true,
  "mark_email_as_verified": false,
  "organization_id": "org_2eondWoxcMIpaLQc",
  "result_url": "http://myapp.com/callback",
  "ttl_sec": 1,
  "user_id": "<string>"
}
'

{
  "ticket": "https://login.auth0.com/lo/reset?client_id=nsaPS2p3cargoFy82WT7betaOPOt3qSh&tenant=mdocs&bewit=bmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPdDNxU2hcMTQzMDY2MjE4MVxuRTcxM0RSeUNlbEpzUUJmaFVaS3A1NEdJbWFzSUZMYzRTdEFtY2NMMXhZPVx7ImVtYWloojoiZGFtaWtww2NoQGhvdG1haWwuY29tIiwidGVuYW50IjoiZHNjaGVua2tjwWFuIiwiY2xpZW50X2lkIjoibmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPiiqxU2giLCJjb25uZWN0aW9uIjoiRGFtaWmsdiwicmVzdWx0VXJsIjoiIn0"
}

パスワード変更の送信

指定したユーザーのパスワード変更チケットを作成します。パスワード変更チケットは、ユーザーがパスワードのリセットフローを開始するために使用できる、生成済みの URL です。

注: このエンドポイントでは、指定したユーザーの本人確認は行われません。アプリケーション内からこのエンドポイントを呼び出す場合は、ユーザーの本人確認を行うようにアプリケーションを設計する必要があります。

POST

https://{tenantDomain}/api/v2

tickets

password-change

using Auth0.ManagementApi;
using System.Threading.Tasks;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Tickets.ChangePasswordAsync(
            new ChangePasswordTicketRequestContent()
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.ChangePasswordTicketRequestContent{}
    mgmt.Tickets.ChangePassword(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.types.ChangePasswordTicketRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.tickets().changePassword(
            ChangePasswordTicketRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Tickets\Requests\ChangePasswordTicketRequestContent;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->tickets->changePassword(
    new ChangePasswordTicketRequestContent([]),
);

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.tickets.changePassword({});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.tickets.changePassword({});
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/tickets/password-change \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "DaM8bokEXBWrTUFCiJjWn50jei6ardyX",
  "connection_id": "con_0000000000000001",
  "email": "jsmith@example.com",
  "includeEmailInRedirect": true,
  "mark_email_as_verified": false,
  "organization_id": "org_2eondWoxcMIpaLQc",
  "result_url": "http://myapp.com/callback",
  "ttl_sec": 1,
  "user_id": "<string>"
}
'

{
  "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 エクスペリエンスを使用しているテナントでこれを指定すると、email template と UI にアプリケーションの詳細が表示され、ticket の使用後にユーザーはアプリケーションのdefault login route にリダイレクトするよう案内されます。Password Reset Post Challenge トリガーを使用するには client_id が必要です。

connection_id

string

デフォルト:con_0000000000000001

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

Pattern: ^con_[A-Za-z0-9]{16}$

string<email>

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

identity

object

ユーザーの identity です。この値を設定する場合は、user_id パラメーターも送信する必要があります。

Show child attributes

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 パラメーターが email template で使用可能になり、organization の branding が prompt に適用されます。さらに、prompt 内のリダイレクトリンクには、organization_id と organization_name のクエリ文字列パラメーターが含まれます。

result_url

string<url>

デフォルト:http://myapp.com/callback

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

ttl_sec

integer

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

必須範囲: x >= 0

user_id

string<user-id>

ticket を作成する対象ユーザーの user_id。

レスポンス

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

ticket

string<url>

デフォルト:https://login.auth0.com/lo/reset?client_id=nsaPS2p3cargoFy82WT7betaOPOt3qSh&tenant=mdocs&bewit=bmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPdDNxU2hcMTQzMDY2MjE4MVxuRTcxM0RSeUNlbEpzUUJmaFVaS3A1NEdJbWFzSUZMYzRTdEFtY2NMMXhZPVx7ImVtYWloojoiZGFtaWtww2NoQGhvdG1haWwuY29tIiwidGVuYW50IjoiZHNjaGVua2tjwWFuIiwiY2xpZW50X2lkIjoibmNlR01CcDNOUE1GeXVzODJXVDdyY1RUT1BPiiqxU2giLCJjb25uZWN0aW9uIjoiRGFtaWmsdiwicmVzdWx0VXJsIjoiIn0

必須

ticket を表す URL。