メールアドレス確認チケットを作成

指定したユーザーのメールアドレス確認チケットを作成します。メールアドレス確認チケットは、ユーザーがメールアドレスを確認するために使用できる生成済み URL です。

POST https://{tenantDomain}/api/v2/tickets/email-verification

Go

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.VerifyEmailTicketRequestContent{
        UserId: "user_id",
    }
    client.Tickets.VerifyEmail(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.tickets.verifyEmail({
        userId: "user_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.tickets.verifyEmail({
        userId: "user_id",
    });
}
main();

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

import requests

url = "https://{tenantDomain}/api/v2/tickets/email-verification"

payload = {
    "user_id": "<string>",
    "client_id": "DaM8bokEXBWrTUFCiJjWn50jei6ardyX",
    "includeEmailInRedirect": True,
    "organization_id": "org_2eondWoxcMIpaLQc",
    "result_url": "http://myapp.com/callback",
    "ttl_sec": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/tickets/email-verification",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_id' => '<string>',
    'client_id' => 'DaM8bokEXBWrTUFCiJjWn50jei6ardyX',
    'includeEmailInRedirect' => true,
    'organization_id' => 'org_2eondWoxcMIpaLQc',
    'result_url' => 'http://myapp.com/callback',
    'ttl_sec' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://{tenantDomain}/api/v2/tickets/email-verification")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"<string>\",\n  \"client_id\": \"DaM8bokEXBWrTUFCiJjWn50jei6ardyX\",\n  \"includeEmailInRedirect\": true,\n  \"organization_id\": \"org_2eondWoxcMIpaLQc\",\n  \"result_url\": \"http://myapp.com/callback\",\n  \"ttl_sec\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/tickets/email-verification")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_id\": \"<string>\",\n  \"client_id\": \"DaM8bokEXBWrTUFCiJjWn50jei6ardyX\",\n  \"includeEmailInRedirect\": true,\n  \"organization_id\": \"org_2eondWoxcMIpaLQc\",\n  \"result_url\": \"http://myapp.com/callback\",\n  \"ttl_sec\": 1\n}"

response = http.request(request)
puts response.read_body

201

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

承認

bearerAuthoAuth2ClientCredentials

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

ボディ

application/jsonapplication/x-www-form-urlencoded

user_id · string<user-id> · 必須

チケットを作成する対象の user_id。

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

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

identity · object

プライマリのソーシャル、エンタープライズ、パスワードレスのメールアドレス アイデンティティを検証するには、これを指定する必要があります。また、セカンダリ アイデンティティの検証にも必要です。

Show child attributes

includeEmailInRedirect · boolean

reset_email の returnUrl にメールアドレスを含めるかどうかを指定します（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。client_id または organization_id を使用する場合は指定できません。

ttl_sec · integer

有効期限が切れるまでチケットが有効な秒数です。未指定または 0 に設定した場合、既定値は 432000 秒（5 日間）です。

必須範囲: x >= 0

レスポンス

201

application/json

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

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

チケットを表す URL。