メンバー招待を作成
curl --request POST \
--url https://{tenantDomain}/my-org/v1/member-invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"invitees": [
{
"email": "user@example.com",
"roles": [
"rol_0000000000000001"
]
}
],
"inviter": {
"name": "Allison the Admin"
},
"ttl_sec": 3600
}
'import requests
url = "https://{tenantDomain}/my-org/v1/member-invitations"
payload = {
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"invitees": [
{
"email": "user@example.com",
"roles": ["rol_0000000000000001"]
}
],
"inviter": { "name": "Allison the Admin" },
"ttl_sec": 3600
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identity_provider_id: 'con_2CZPv6IY0gWzDaQJ',
invitees: [{email: 'user@example.com', roles: ['rol_0000000000000001']}],
inviter: {name: 'Allison the Admin'},
ttl_sec: 3600
})
};
fetch('https://{tenantDomain}/my-org/v1/member-invitations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenantDomain}/my-org/v1/member-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([
'identity_provider_id' => 'con_2CZPv6IY0gWzDaQJ',
'invitees' => [
[
'email' => 'user@example.com',
'roles' => [
'rol_0000000000000001'
]
]
],
'inviter' => [
'name' => 'Allison the Admin'
],
'ttl_sec' => 3600
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{tenantDomain}/my-org/v1/member-invitations"
payload := strings.NewReader("{\n \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n \"invitees\": [\n {\n \"email\": \"user@example.com\",\n \"roles\": [\n \"rol_0000000000000001\"\n ]\n }\n ],\n \"inviter\": {\n \"name\": \"Allison the Admin\"\n },\n \"ttl_sec\": 3600\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{tenantDomain}/my-org/v1/member-invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n \"invitees\": [\n {\n \"email\": \"user@example.com\",\n \"roles\": [\n \"rol_0000000000000001\"\n ]\n }\n ],\n \"inviter\": {\n \"name\": \"Allison the Admin\"\n },\n \"ttl_sec\": 3600\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}/my-org/v1/member-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 \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n \"invitees\": [\n {\n \"email\": \"user@example.com\",\n \"roles\": [\n \"rol_0000000000000001\"\n ]\n }\n ],\n \"inviter\": {\n \"name\": \"Allison the Admin\"\n },\n \"ttl_sec\": 3600\n}"
response = http.request(request)
puts response.read_body[
{
"created_at": "2025-04-11T20:11:45.431Z",
"expires_at": "2025-04-11T20:11:45.431Z",
"id": "uinv_12345678abcdefgh",
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"invitation_url": "https://example.auth0.com/login?invitation=uinv_12345678abcdefgh&organization=org_12345678abcdefgh",
"invitee": {
"email": "user@example.com"
},
"inviter": {
"name": "Allison the Admin"
},
"organization_id": "org_12345678abcdefgh",
"roles": [
"rol_BKW1BKIfBKd0BaI0"
],
"ticket_id": "1asdfasd23usjdef"
}
]この組織のメンバー招待を1件以上作成します。ユーザーに対して有効な招待がすでに存在する場合、新しい招待を作成すると、そのユーザーに対する未処理の招待はすべて自動的に取り消されます。ペイロードで指定されたロールは、ユーザーが招待を承諾すると付与されます。
POST
/
member-invitations
メンバー招待を作成
curl --request POST \
--url https://{tenantDomain}/my-org/v1/member-invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"invitees": [
{
"email": "user@example.com",
"roles": [
"rol_0000000000000001"
]
}
],
"inviter": {
"name": "Allison the Admin"
},
"ttl_sec": 3600
}
'import requests
url = "https://{tenantDomain}/my-org/v1/member-invitations"
payload = {
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"invitees": [
{
"email": "user@example.com",
"roles": ["rol_0000000000000001"]
}
],
"inviter": { "name": "Allison the Admin" },
"ttl_sec": 3600
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
identity_provider_id: 'con_2CZPv6IY0gWzDaQJ',
invitees: [{email: 'user@example.com', roles: ['rol_0000000000000001']}],
inviter: {name: 'Allison the Admin'},
ttl_sec: 3600
})
};
fetch('https://{tenantDomain}/my-org/v1/member-invitations', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenantDomain}/my-org/v1/member-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([
'identity_provider_id' => 'con_2CZPv6IY0gWzDaQJ',
'invitees' => [
[
'email' => 'user@example.com',
'roles' => [
'rol_0000000000000001'
]
]
],
'inviter' => [
'name' => 'Allison the Admin'
],
'ttl_sec' => 3600
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{tenantDomain}/my-org/v1/member-invitations"
payload := strings.NewReader("{\n \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n \"invitees\": [\n {\n \"email\": \"user@example.com\",\n \"roles\": [\n \"rol_0000000000000001\"\n ]\n }\n ],\n \"inviter\": {\n \"name\": \"Allison the Admin\"\n },\n \"ttl_sec\": 3600\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{tenantDomain}/my-org/v1/member-invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n \"invitees\": [\n {\n \"email\": \"user@example.com\",\n \"roles\": [\n \"rol_0000000000000001\"\n ]\n }\n ],\n \"inviter\": {\n \"name\": \"Allison the Admin\"\n },\n \"ttl_sec\": 3600\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}/my-org/v1/member-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 \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n \"invitees\": [\n {\n \"email\": \"user@example.com\",\n \"roles\": [\n \"rol_0000000000000001\"\n ]\n }\n ],\n \"inviter\": {\n \"name\": \"Allison the Admin\"\n },\n \"ttl_sec\": 3600\n}"
response = http.request(request)
puts response.read_body[
{
"created_at": "2025-04-11T20:11:45.431Z",
"expires_at": "2025-04-11T20:11:45.431Z",
"id": "uinv_12345678abcdefgh",
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"invitation_url": "https://example.auth0.com/login?invitation=uinv_12345678abcdefgh&organization=org_12345678abcdefgh",
"invitee": {
"email": "user@example.com"
},
"inviter": {
"name": "Allison the Admin"
},
"organization_id": "org_12345678abcdefgh",
"roles": [
"rol_BKW1BKIfBKd0BaI0"
],
"ticket_id": "1asdfasd23usjdef"
}
]承認
OAuth2ClientCredentialsOAuth2AuthCode
The access token received from the authorization server in the OAuth 2.0 flow.
ヘッダー
ボディ
application/json
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
アイデンティティプロバイダーの識別子。identity_provider_id または user_store_id の少なくとも一方を指定する必要があります。
Pattern:
^con_[A-Za-z0-9]{16}$Show child attributes
Show child attributes
招待の有効期限が切れるまでの有効秒数。指定しない場合、または 0 に設定した場合、この値はデフォルトで 604800 秒(7 日)になります。最大値: 2592000 秒(30 日)。
必須範囲:
0 <= x <= 2592000レスポンス
Organizationのメンバー招待を作成します。
招待の作成日時を表すISO 8601形式のタイムスタンプ。
招待の有効期限を表すISO 8601形式のタイムスタンプ。
メンバー招待のID
Pattern:
^uinv_[A-Za-z0-9]{16}$IDプロバイダーの識別子。
Pattern:
^con_[A-Za-z0-9]{16}$被招待者に送信する招待URL。
Show child attributes
Show child attributes
Show child attributes
Show child attributes
組織ID。
Pattern:
^org_[A-Za-z0-9]{16}$組織のメンバーに割り当て可能なロールの ID。
Pattern:
^rol_[A-Za-z0-9]{16}$招待ticketのID。
⌘I