招待一覧 - Auth0 Docs

メンバー招待を一覧表示

curl --request GET \
  --url https://{tenantDomain}/my-org/v1/member-invitations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/my-org/v1/member-invitations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "invitations": [
    {
      "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"
    }
  ]
}

{
  "status": 400,
  "title": "Validation Error",
  "type": "https://auth0.com/api-errors#A0E-400-0003",
  "validation_errors": [
    {
      "detail": "is required",
      "field": "data/property_name",
      "pointer": "/property_name",
      "source": "params"
    }
  ]
}

{
  "detail": "No auth token provided.",
  "status": 401,
  "title": "Missing Token",
  "type": "https://auth0.com/api-errors#A0E-401-0002"
}

{
  "detail": "The auth token lacks the required scope: Check the API documentation for the required scopes for this endpoint.",
  "status": 403,
  "title": "Insufficient Scope",
  "type": "https://auth0.com/api-errors#A0E-403-0002"
}

{
  "detail": "The organization does not exist.",
  "status": 404,
  "title": "Resource Not Found",
  "type": "https://auth0.com/api-errors#A0E-404-0002"
}

{
  "detail": "The endpoint request limit has been exceeded.",
  "status": 429,
  "title": "Endpoint Rate Limit Exceeded",
  "type": "https://auth0.com/api-errors#A0E-429-0003"
}

GET

member-invitations

メンバー招待を一覧表示

curl --request GET \
  --url https://{tenantDomain}/my-org/v1/member-invitations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{tenantDomain}/my-org/v1/member-invitations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "invitations": [
    {
      "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"
    }
  ]
}

{
  "status": 400,
  "title": "Validation Error",
  "type": "https://auth0.com/api-errors#A0E-400-0003",
  "validation_errors": [
    {
      "detail": "is required",
      "field": "data/property_name",
      "pointer": "/property_name",
      "source": "params"
    }
  ]
}

{
  "detail": "No auth token provided.",
  "status": 401,
  "title": "Missing Token",
  "type": "https://auth0.com/api-errors#A0E-401-0002"
}

{
  "detail": "The auth token lacks the required scope: Check the API documentation for the required scopes for this endpoint.",
  "status": 403,
  "title": "Insufficient Scope",
  "type": "https://auth0.com/api-errors#A0E-403-0002"
}

{
  "detail": "The organization does not exist.",
  "status": 404,
  "title": "Resource Not Found",
  "type": "https://auth0.com/api-errors#A0E-404-0002"
}

{
  "detail": "The endpoint request limit has been exceeded.",
  "status": 429,
  "title": "Endpoint Rate Limit Exceeded",
  "type": "https://auth0.com/api-errors#A0E-429-0003"
}

承認

Authorization

string

header

必須

The access token received from the authorization server in the OAuth 2.0 flow.

クエリパラメータ

fields

string

結果に含める、または除外するフィールドのカンマ区切りリスト（include_fields に指定した値に応じます）。すべてのフィールドを取得するには空のままにします。注: ticket_id では絞り込みできず、この値はフィールドを絞り込んでいない場合にのみ返されます。

Required string length: 1 - 255

Pattern:

^(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url)(,(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url))*$

include_fields

boolean

デフォルト:true

指定したフィールドを含める（true）か、除外する（false）か。既定値は true です。

from

string

選択を開始する位置を示す任意のカーソル（この値自体は含まれません）。

Required string length: 1 - 1000

take

integer

デフォルト:50

1ページあたりの結果数。既定値は 50 です。

必須範囲: 1 <= x <= 100

sort

string

デフォルト:created_at:-1

並べ替えるフィールド。order には昇順の場合は 1、降順の場合は -1 を指定し、field:order の形式で指定します。既定値は created_at:-1 です。

Pattern: ^created_at:(1|-1)$

レスポンス

Organizationのメンバー招待を一覧表示します。

invitations

object[]

Show child attributes

string

結果の次のページのページネーションカーソル。