メンバー招待を取得

TypeScript

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.invitations.get("invitation_id", {
        fields: "fields",
        include_fields: true,
    });
}
main();

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.invitations.get("invitation_id", {
        fields: "fields",
        include_fields: true,
    });
}
main();

package example

import (
    context "context"

    myorganization "github.com/auth0/myorganization-go/v2"
    client "github.com/auth0/myorganization-go/v2/client"
    option "github.com/auth0/myorganization-go/v2/option"
)

func do() {
    c, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &myorganization.GetMemberInvitationRequestParameters{
        Fields: myorganization.String(
            "fields",
        ),
        IncludeFields: myorganization.Bool(
            true,
        ),
    }
    c.Organization.Invitations.Get(
        context.TODO(),
        "invitation_id",
        request,
    )
}

using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
using Auth0.MyOrganizationApi.Organization;

public partial class Examples
{
    public async Task Example() {
        var client = new MyOrganizationClient(new MyOrganizationClientOptions
        {
            Domain = "{YOUR_DOMAIN}",
            TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
        });

        await client.Organization.Invitations.GetAsync(
            invitationId: "invitation_id",
            request: new GetMemberInvitationRequestParameters {
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.organization.types.GetMemberInvitationRequestParameters;

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

        client.organization().invitations().get(
            "invitation_id",
            GetMemberInvitationRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

from auth0.myorganization import MyOrganizationClient

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}",
  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;
}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}")

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

{
  "id": "uinv_12345678abcdefgh",
  "organization_id": "org_12345678abcdefgh",
  "inviter": {
    "name": "Allison the Admin"
  },
  "invitee": {
    "email": "user@example.com"
  },
  "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
  "created_at": "2025-04-11T20:11:45.431Z",
  "expires_at": "2025-04-11T20:11:45.431Z",
  "roles": [
    "rol_BKW1BKIfBKd0BaI0"
  ],
  "invitation_url": "https://example.auth0.com/login?invitation=uinv_12345678abcdefgh&organization=org_12345678abcdefgh",
  "ticket_id": "1asdfasd23usjdef"
}

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

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

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

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

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

GET

member-invitations

{invitation_id}

TypeScript

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.invitations.get("invitation_id", {
        fields: "fields",
        include_fields: true,
    });
}
main();

import { MyOrganizationClient } from "@auth0/myorganization-js";

async function main() {
    const client = new MyOrganizationClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organization.invitations.get("invitation_id", {
        fields: "fields",
        include_fields: true,
    });
}
main();

package example

import (
    context "context"

    myorganization "github.com/auth0/myorganization-go/v2"
    client "github.com/auth0/myorganization-go/v2/client"
    option "github.com/auth0/myorganization-go/v2/option"
)

func do() {
    c, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &myorganization.GetMemberInvitationRequestParameters{
        Fields: myorganization.String(
            "fields",
        ),
        IncludeFields: myorganization.Bool(
            true,
        ),
    }
    c.Organization.Invitations.Get(
        context.TODO(),
        "invitation_id",
        request,
    )
}

using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
using Auth0.MyOrganizationApi.Organization;

public partial class Examples
{
    public async Task Example() {
        var client = new MyOrganizationClient(new MyOrganizationClientOptions
        {
            Domain = "{YOUR_DOMAIN}",
            TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
        });

        await client.Organization.Invitations.GetAsync(
            invitationId: "invitation_id",
            request: new GetMemberInvitationRequestParameters {
                Fields = "fields",
                IncludeFields = true
            }
        );
    }

}

package com.example.usage;

import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.organization.types.GetMemberInvitationRequestParameters;

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

        client.organization().invitations().get(
            "invitation_id",
            GetMemberInvitationRequestParameters
                .builder()
                .fields("fields")
                .includeFields(true)
                .build()
        );
    }
}

from auth0.myorganization import MyOrganizationClient

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

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}",
  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;
}

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/my-org/v1/member-invitations/{invitation_id}")

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

{
  "id": "uinv_12345678abcdefgh",
  "organization_id": "org_12345678abcdefgh",
  "inviter": {
    "name": "Allison the Admin"
  },
  "invitee": {
    "email": "user@example.com"
  },
  "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
  "created_at": "2025-04-11T20:11:45.431Z",
  "expires_at": "2025-04-11T20:11:45.431Z",
  "roles": [
    "rol_BKW1BKIfBKd0BaI0"
  ],
  "invitation_url": "https://example.auth0.com/login?invitation=uinv_12345678abcdefgh&organization=org_12345678abcdefgh",
  "ticket_id": "1asdfasd23usjdef"
}

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

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

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

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

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

承認

Authorization

string

header

必須

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

パスパラメータ

invitation_id

string

必須

read-only

メンバー招待のID

Pattern: ^uinv_[A-Za-z0-9]{16}$

クエリパラメータ

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 です。

レスポンス

IDでOrganizationのメンバー招待を取得します。

string

read-only

メンバー招待のID

Pattern: ^uinv_[A-Za-z0-9]{16}$

organization_id

string

read-only

組織ID。

Pattern: ^org_[A-Za-z0-9]{16}$

inviter

object

Show child attributes

invitee

object

Show child attributes

identity_provider_id

string

read-only

IDプロバイダーの識別子。

Pattern: ^con_[A-Za-z0-9]{16}$

user_store_id

string

read-only

IDプロバイダーの識別子。

Pattern: ^con_[A-Za-z0-9]{16}$

created_at

string<date-time>

招待の作成日時を表すISO 8601形式のタイムスタンプ。

expires_at

string<date-time>

招待の有効期限を表すISO 8601形式のタイムスタンプ。

roles

string[]

read-only

組織のメンバーに割り当て可能なロールの ID。

Pattern: ^rol_(?:[A-Za-z0-9]{16}|sys_[a-z0-9_]{1,64})$

invitation_url

string<uri>

被招待者に送信する招待URL。

ticket_id

string

招待ticketのID。