確認メールを送信

指定したユーザーに、メールアドレスの確認用リンクをクリックするよう求めるメールを送信します。

注: メールを送信するには、確認メールテンプレートで Status トグルを有効にしておく必要があります。

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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &jobs.CreateVerificationEmailRequestContent{
        UserId: "user_id",
    }
    client.Jobs.VerificationEmail.Create(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

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

curl --request POST \
  --url https://{tenantDomain}/api/v2/jobs/verification-email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "google-oauth2|1234",
  "client_id": "<string>",
  "organization_id": "org_2eondWoxcMIpaLQc"
}
'

import requests

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

payload = {
    "user_id": "google-oauth2|1234",
    "client_id": "<string>",
    "organization_id": "org_2eondWoxcMIpaLQc"
}
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/jobs/verification-email",
  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' => 'google-oauth2|1234',
    'client_id' => '<string>',
    'organization_id' => 'org_2eondWoxcMIpaLQc'
  ]),
  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/jobs/verification-email")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_id\": \"google-oauth2|1234\",\n  \"client_id\": \"<string>\",\n  \"organization_id\": \"org_2eondWoxcMIpaLQc\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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\": \"google-oauth2|1234\",\n  \"client_id\": \"<string>\",\n  \"organization_id\": \"org_2eondWoxcMIpaLQc\"\n}"

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

201

{
  "id": "job_0000000000000001",
  "status": "completed",
  "type": "verification_email",
  "created_at": "<string>"
}

承認

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> · デフォルト: google-oauth2|1234 · 必須

検証メールの送信先ユーザーの user_id。

client_id · string<client-id>

クライアント（アプリケーション）の client_id。値が指定されていない場合は、グローバル クライアントID が使用されます。

identity · object

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

Show child attributes

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

（任意）組織 ID - 組織の ID。指定した場合、組織パラメーターがメールテンプレートで使用可能になり、組織のブランディングがプロンプトに適用されます。さらに、プロンプト内のリダイレクトリンクには、organization_id および organization_name のクエリパラメーターが含まれます。

レスポンス

201

application/json

ジョブが正常に作成されました。

id · string · デフォルト: job_0000000000000001 · 必須

この job の ID。

status · string · デフォルト: completed · 必須

この job のステータス。

type · string · デフォルト: verification_email · 必須

この job の種類。

created_at · string

この job が作成された日時。