招待を取得 - Auth0 Docs

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.Invitations.ListAsync(
            id: "id",
            request: new ListOrganizationInvitationsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Fields = "fields",
                IncludeFields = true,
                Sort = "sort"
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.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",
        ),
    }
    mgmt.Organizations.Invitations.List(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.ListOrganizationInvitationsRequestParameters;

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

        client.organizations().invitations().list(
            "id",
            ListOrganizationInvitationsRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .fields("fields")
                .includeFields(true)
                .sort("sort")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\Invitations\Requests\ListOrganizationInvitationsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->list(
    'id',
    new ListOrganizationInvitationsRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'fields' => 'fields',
        'includeFields' => true,
        'sort' => 'sort',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.invitations.list(
    id="id",
    page=1,
    per_page=1,
    include_totals=True,
    fields="fields",
    include_fields=True,
    sort="sort",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.organizations.invitations.list(
  id: "id",
  page: 1,
  per_page: 1,
  include_totals: true,
  fields: "fields",
  include_fields: true,
  sort: "sort"
)

import { ManagementClient } from "auth0";

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

[
  {
    "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": "john.doe@gmail.com"
    },
    "inviter": {
      "name": "Jane Doe"
    },
    "organization_id": "<string>",
    "roles": [
      "<string>"
    ],
    "ticket_id": "<string>",
    "user_metadata": {}
  }
]

GET

https://{tenantDomain}/api/v2

organizations

{id}

invitations

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

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.Invitations.ListAsync(
            id: "id",
            request: new ListOrganizationInvitationsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Fields = "fields",
                IncludeFields = true,
                Sort = "sort"
            }
        );
    }

}

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/v3/management"
    client "github.com/auth0/go-auth0/v3/management/client"
    option "github.com/auth0/go-auth0/v3/management/option"
)

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.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",
        ),
    }
    mgmt.Organizations.Invitations.List(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.ListOrganizationInvitationsRequestParameters;

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

        client.organizations().invitations().list(
            "id",
            ListOrganizationInvitationsRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .fields("fields")
                .includeFields(true)
                .sort("sort")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\Invitations\Requests\ListOrganizationInvitationsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->list(
    'id',
    new ListOrganizationInvitationsRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'fields' => 'fields',
        'includeFields' => true,
        'sort' => 'sort',
    ]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.invitations.list(
    id="id",
    page=1,
    per_page=1,
    include_totals=True,
    fields="fields",
    include_fields=True,
    sort="sort",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.organizations.invitations.list(
  id: "id",
  page: 1,
  per_page: 1,
  include_totals: true,
  fields: "fields",
  include_fields: true,
  sort: "sort"
)

import { ManagementClient } from "auth0";

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

[
  {
    "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": "john.doe@gmail.com"
    },
    "inviter": {
      "name": "Jane Doe"
    },
    "organization_id": "<string>",
    "roles": [
      "<string>"
    ],
    "ticket_id": "<string>",
    "user_metadata": {}
  }
]

承認

Authorization

string

header

必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

string

必須

organization の識別子。

Maximum string length: 50

クエリパラメータ

page

integer

返される結果のページ index。最初のページは 0 です。

必須範囲: x >= 0

per_page

integer

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

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

include_totals

boolean

true の場合、結果は start と limit も含むオブジェクト内に返されます。false（デフォルト）の場合、結果の array が直接返されます。現在のところ、招待の総数を返すことはサポートされていません。

fields

string

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

include_fields

boolean

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

sort

string

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

レスポンス

招待の取得に成功しました。

object[]
object

app_metadata

object

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

client_id

string<client-id>

デフォルト:AaiyAPdpYdesoKnqjj8HJqRn4T5titww

Auth0 Client 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 形式のタイムスタンプです。

string<user-invitation-id>

デフォルト:uinv_0000000000000001

user invitation の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>

organization の識別子です。

Maximum string length: 50

roles

string<role-id>[]

ユーザーに関連付けるロールIDのリストです。

Minimum array length: 1

ticket_id

string<ticket-id>

招待チケットのIDです

user_metadata

object

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