招待 ID で招待を取得

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.GetAsync(
            id: "id",
            invitationId: "invitation_id",
            request: new GetOrganizationInvitationRequestParameters {
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

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.GetOrganizationInvitationRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.Organizations.Invitations.Get(
        context.TODO(),
        "id",
        "invitation_id",
        request,
    )
}

package com.example.usage;

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

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

        client.organizations().invitations().get(
            "id",
            "invitation_id",
            GetOrganizationInvitationRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .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\GetOrganizationInvitationRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->get(
    'id',
    'invitation_id',
    new GetOrganizationInvitationRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.organizations.invitations.get(
    id="id",
    invitation_id="invitation_id",
    fields="fields",
    include_fields=True,
)

require "auth0"

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

client.organizations.invitations.get(
  id: "id",
  invitation_id: "invitation_id",
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.get("id", "invitation_id", {
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

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

{invitation_id}

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.GetAsync(
            id: "id",
            invitationId: "invitation_id",
            request: new GetOrganizationInvitationRequestParameters {
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

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.GetOrganizationInvitationRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    mgmt.Organizations.Invitations.Get(
        context.TODO(),
        "id",
        "invitation_id",
        request,
    )
}

package com.example.usage;

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

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

        client.organizations().invitations().get(
            "id",
            "invitation_id",
            GetOrganizationInvitationRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .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\GetOrganizationInvitationRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->get(
    'id',
    'invitation_id',
    new GetOrganizationInvitationRequestParameters([
        'fields' => 'fields',
        'includeFields' => true,
    ]),
);

from auth0.management import ManagementClient

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

client.organizations.invitations.get(
    id="id",
    invitation_id="invitation_id",
    fields="fields",
    include_fields=True,
)

require "auth0"

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

client.organizations.invitations.get(
  id: "id",
  invitation_id: "invitation_id",
  fields: "fields",
  include_fields: true
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.get("id", "invitation_id", {
        fields: "fields",
        includeFields: true,
    });
}
main();

import { ManagementClient } from "auth0";

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

必須

組織ID。

Maximum string length: 50

invitation_id

string

必須

user invitation の ID。

クエリパラメータ

fields

string

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

include_fields

boolean

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

レスポンス

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

app_metadata

object

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

client_id

string<client-id>

デフォルト:AaiyAPdpYdesoKnqjj8HJqRn4T5titww

Auth0 client ID。アプリケーションのログイン開始 endpoint を特定するために使用されます。

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

ユーザー招待の 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

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