招待IDによる招待の取得

GET https://{tenantDomain}/api/v2/organizations/{id}/invitations/{invitation_id}

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

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

invitation_id · string · 必須

ユーザー招待の id。

クエリパラメータ

fields · string

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

include_fields · boolean

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

レスポンス

200

application/json

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

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>

招待 ticket の id です。

user_metadata · object

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