招待を作成

特定の組織に対するユーザー招待を作成します。作成されると、一覧に記載されたユーザーに、その組織への参加を案内するメールが送信されます。組織への招待の詳細については、Invite Organization Membersを参照してください。

POST https://{tenantDomain}/api/v2/organizations/{id}/invitations

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"
    organizations "github.com/auth0/go-auth0/management/management/organizations"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &organizations.CreateOrganizationInvitationRequestContent{
        Inviter: &management.OrganizationInvitationInviter{
            Name: "name",
        },
        Invitee: &management.OrganizationInvitationInvitee{
            Email: "email",
        },
        ClientId: "client_id",
    }
    client.Organizations.Invitations.Create(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/organizations/{id}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
  "invitee": {
    "email": "[e-mail]"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "app_metadata": {},
  "connection_id": "con_0000000000000001",
  "roles": [
    "<string>"
  ],
  "send_invitation_email": true,
  "ttl_sec": 1296000,
  "user_metadata": {}
}
'

import requests

url = "https://{tenantDomain}/api/v2/organizations/{id}/invitations"

payload = {
    "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
    "invitee": { "email": "[e-mail]" },
    "inviter": { "name": "Jane Doe" },
    "app_metadata": {},
    "connection_id": "con_0000000000000001",
    "roles": ["<string>"],
    "send_invitation_email": True,
    "ttl_sec": 1296000,
    "user_metadata": {}
}
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/organizations/{id}/invitations",
  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([
    'client_id' => 'AaiyAPdpYdesoKnqjj8HJqRn4T5titww',
    'invitee' => [
        'email' => '[e-mail]'
    ],
    'inviter' => [
        'name' => 'Jane Doe'
    ],
    'app_metadata' => [
        
    ],
    'connection_id' => 'con_0000000000000001',
    'roles' => [
        '<string>'
    ],
    'send_invitation_email' => true,
    'ttl_sec' => 1296000,
    'user_metadata' => [
        
    ]
  ]),
  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/organizations/{id}/invitations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_id\": \"AaiyAPdpYdesoKnqjj8HJqRn4T5titww\",\n  \"invitee\": {\n    \"email\": \"[e-mail]\"\n  },\n  \"inviter\": {\n    \"name\": \"Jane Doe\"\n  },\n  \"app_metadata\": {},\n  \"connection_id\": \"con_0000000000000001\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"send_invitation_email\": true,\n  \"ttl_sec\": 1296000,\n  \"user_metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations/{id}/invitations")

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  \"client_id\": \"AaiyAPdpYdesoKnqjj8HJqRn4T5titww\",\n  \"invitee\": {\n    \"email\": \"[e-mail]\"\n  },\n  \"inviter\": {\n    \"name\": \"Jane Doe\"\n  },\n  \"app_metadata\": {},\n  \"connection_id\": \"con_0000000000000001\",\n  \"roles\": [\n    \"<string>\"\n  ],\n  \"send_invitation_email\": true,\n  \"ttl_sec\": 1296000,\n  \"user_metadata\": {}\n}"

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

200

{
  "app_metadata": {},
  "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
  "connection_id": "con_0000000000000001",
  "created_at": "2020-08-20T19:10:06.299Z",
  "expires_at": "2020-08-27T19:10:06.299Z",
  "id": "uinv_0000000000000001",
  "invitation_url": "https://mycompany.org/login?invitation=f81dWWYW6gzGGicxT8Ha0txBkGNcAcYr&organization=org_0000000000000001&organization_name=acme",
  "invitee": {
    "email": "[e-mail]"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "organization_id": "<string>",
  "roles": [
    "<string>"
  ],
  "ticket_id": "<string>",
  "user_metadata": {}
}

承認

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

パスパラメータ

id · string · 必須

組織の識別子。

Maximum string length: 50

ボディ

application/jsonapplication/x-www-form-urlencoded

client_id · string<client-id> · デフォルト: AaiyAPdpYdesoKnqjj8HJqRn4T5titww · 必須

Auth0のクライアントID。アプリケーションのログイン開始エンドポイントを特定するために使用されます。

invitee · object · 必須

Show child attributes

inviter · object · 必須

Show child attributes

app_metadata · object

アプリケーションの中核機能には影響しない、ユーザーに関連するデータ。

connection_id · string<connection-id> · デフォルト: con_0000000000000001

招待されたユーザーに認証を強制する接続のid。

roles · string<role-id>[]

ユーザーに関連付けるロールIDの一覧。

Minimum array length: 1

send_invitation_email · boolean · デフォルト: true

ユーザーに招待メールを送信するかどうか（true）、または送信しないかどうか（false）。デフォルトはtrueです

ttl_sec · integer

招待の有効期限が切れるまでの秒数。未指定または0に設定した場合、この値のデフォルトは604800秒（7日間）です。最大値は2592000秒（30日間）です。

必須範囲: 0 <= x <= 2592000

user_metadata · object

アプリケーションの中核機能に影響しない、このユーザーに関連するデータ。

レスポンス

200

application/json

招待が正常に作成されました。

app_metadata · object

アプリケーションの中核機能には影響しない、ユーザーに関連するデータ。

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

Auth0のクライアントID。アプリケーションのログイン開始エンドポイントを特定するために使用されます。

connection_id · string<connection-id> · デフォルト: con_0000000000000001

招待されたユーザーに認証を強制する接続のid。

created_at · string<date-time> · デフォルト: 2020-08-20T19:10:06.299Z

招待の作成時刻を表すISO 8601形式のタイムスタンプ。

expires_at · string<date-time> · デフォルト: 2020-08-27T19:10:06.299Z

招待の有効期限を表すISO 8601形式のタイムスタンプ。

id · string<user-invitation-id> · デフォルト: uinv_0000000000000001

ユーザー招待のid。

invitation_url · string<strict-https-uri> · デフォルト: https://mycompany.org/login?invitation=f81dWWYW6gzGGicxT8Ha0txBkGNcAcYr&organization=org_0000000000000001&organization_name=acme

招待されたユーザーに送信する招待URL。

invitee · object

Show child attributes

inviter · object

Show child attributes

organization_id · string<organization-id>

組織識別子。

Maximum string length: 50

roles · string<role-id>[]

ユーザーに関連付けるロールIDの一覧。

Minimum array length: 1

ticket_id · string<ticket-id>

招待ticketのid

user_metadata · object

アプリケーションの中核機能に影響しない、このユーザーに関連するデータ。