Send an email address verification email

Send an email to the specified user that asks them to click a link to verify their email address.

Note: You must have the Status toggle enabled for the verification email template for the email to be sent.

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

C#

C#

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Jobs.VerificationEmail.CreateAsync(
            new CreateVerificationEmailRequestContent {
                UserId = "user_id"
            }
        );
    }

}

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,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.jobs.verificationemail.requests.CreateVerificationEmailRequestContent;

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

        client.jobs().verificationEmail().create(
            CreateVerificationEmailRequestContent
                .builder()
                .userId("user_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Jobs\VerificationEmail\Requests\CreateVerificationEmailRequestContent;

$client = new Management(
    token: '<token>',
);
$client->jobs->verificationEmail->create(
    new CreateVerificationEmailRequestContent([
        'userId' => 'user_id',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.jobs.verification_email.create(
    user_id="user_id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.jobs.verification_email.create(user_id: "user_id")

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"
}
'

201

{
  "status": "completed",
  "type": "verification_email",
  "id": "job_0000000000000001",
  "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

Custom domain to be used for this request

Required string length: 3 - 255

ボディ

application/jsonapplication/x-www-form-urlencoded

user_id · string<user-id> · デフォルト: google-oauth2|1234 · 必須

user_id of the user to send the verification email to.

client_id · string<client-id>

client_id of the client (application). If no value provided, the global Client ID will be used.

identity · object

This must be provided to verify primary social, enterprise and passwordless email identities. Also, is needed to verify secondary identities.

Show child attributes

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

(Optional) Organization ID – the ID of the Organization. If provided, organization parameters will be made available to the email template and organization branding will be applied to the prompt. In addition, the redirect link in the prompt will include organization_id and organization_name query string parameters.

レスポンス

201

application/json

Job successfully created.

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

Status of this job.

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

Type of job this is.

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

ID of this job.

created_at · string

When this job was created.