招待一覧を取得

特定の組織について、ユーザーに送信された招待の詳細な一覧を取得します。この一覧には、招待元および招待先の情報、招待 URL、作成日、有効期限日などの詳細が含まれます。組織への招待の詳細については、Invite Organization Membersを参照してください。

GET 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.ListOrganizationInvitationsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Sort: management.String(
            "sort",
        ),
    }
    client.Organizations.Invitations.List(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.invitations.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
        fields: "fields",
        includeFields: true,
        sort: "sort",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.invitations.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
        fields: "fields",
        includeFields: true,
        sort: "sort",
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/{id}/invitations \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, 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 => "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;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/organizations/{id}/invitations")
  .header("Authorization", "Bearer <token>")
  .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::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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.

パスパラメータ

id · string · 必須

組織の識別子。

Maximum string length: 50

クエリパラメータ

page · integer

返される結果のページインデックスです。最初のページは 0 です。

必須範囲: x >= 0

per_page · integer

1 ページあたりの結果数です。デフォルトは 50 です。

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

include_totals · boolean

true の場合、結果を start と limit も含むオブジェクト内に返します。false の場合（デフォルト）、結果の配列を直接返します。招待の合計数の返却は、まだサポートされていません。

fields · string

結果に含める、または除外する（include_fields に指定した値に基づく）フィールドのカンマ区切りリストです。すべてのフィールドを取得するには空のままにします。

include_fields · boolean

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

sort · string

並べ替えに使用するフィールドです。field:order を使用します。order には、昇順の場合は 1、降順の場合は -1 を指定します。デフォルトは created_at:-1 です。

レスポンス

200

application/json

招待が正常に取得されました。

object[]

object

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>

招待チケットの id

user_metadata · object

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