招待を送信 - 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.CreateAsync(
            id: "id",
            request: new CreateOrganizationInvitationRequestContent {
                Inviter = new OrganizationInvitationInviter {
                    Name = "name"
                },
                Invitee = new OrganizationInvitationInvitee {
                    Email = "email"
                },
                ClientId = "client_id"
            }
        );
    }

}

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.CreateOrganizationInvitationRequestContent{
        Inviter: &management.OrganizationInvitationInviter{
            Name: "name",
        },
        Invitee: &management.OrganizationInvitationInvitee{
            Email: "email",
        },
        ClientId: "client_id",
    }
    mgmt.Organizations.Invitations.Create(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.CreateOrganizationInvitationRequestContent;
import com.auth0.client.mgmt.types.OrganizationInvitationInvitee;
import com.auth0.client.mgmt.types.OrganizationInvitationInviter;

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

        client.organizations().invitations().create(
            "id",
            CreateOrganizationInvitationRequestContent
                .builder()
                .inviter(
                    OrganizationInvitationInviter
                        .builder()
                        .name("name")
                        .build()
                )
                .invitee(
                    OrganizationInvitationInvitee
                        .builder()
                        .email("email")
                        .build()
                )
                .clientId("client_id")
                .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\CreateOrganizationInvitationRequestContent;
use Auth0\SDK\API\Management\Types\OrganizationInvitationInviter;
use Auth0\SDK\API\Management\Types\OrganizationInvitationInvitee;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->create(
    'id',
    new CreateOrganizationInvitationRequestContent([
        'inviter' => new OrganizationInvitationInviter([
            'name' => 'name',
        ]),
        'invitee' => new OrganizationInvitationInvitee([
            'email' => 'email',
        ]),
        'clientId' => 'client_id',
    ]),
);

from auth0.management import ManagementClient, OrganizationInvitationInviter, OrganizationInvitationInvitee

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

client.organizations.invitations.create(
    id="id",
    inviter=OrganizationInvitationInviter(
        name="name",
    ),
    invitee=OrganizationInvitationInvitee(
        email="email",
    ),
    client_id="client_id",
)

require "auth0"

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

client.organizations.invitations.create(
  id: "id",
  inviter: {
    name: "name"
  },
  invitee: {
    email: "email"
  },
  client_id: "client_id"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/organizations/{id}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
  "invitee": {
    "email": "john.doe@gmail.com"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "app_metadata": {},
  "connection_id": "con_0000000000000001",
  "roles": [
    "<string>"
  ],
  "send_invitation_email": true,
  "ttl_sec": 1296000,
  "user_metadata": {}
}
'

{
  "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": {}
}

POST

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.CreateAsync(
            id: "id",
            request: new CreateOrganizationInvitationRequestContent {
                Inviter = new OrganizationInvitationInviter {
                    Name = "name"
                },
                Invitee = new OrganizationInvitationInvitee {
                    Email = "email"
                },
                ClientId = "client_id"
            }
        );
    }

}

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.CreateOrganizationInvitationRequestContent{
        Inviter: &management.OrganizationInvitationInviter{
            Name: "name",
        },
        Invitee: &management.OrganizationInvitationInvitee{
            Email: "email",
        },
        ClientId: "client_id",
    }
    mgmt.Organizations.Invitations.Create(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.CreateOrganizationInvitationRequestContent;
import com.auth0.client.mgmt.types.OrganizationInvitationInvitee;
import com.auth0.client.mgmt.types.OrganizationInvitationInviter;

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

        client.organizations().invitations().create(
            "id",
            CreateOrganizationInvitationRequestContent
                .builder()
                .inviter(
                    OrganizationInvitationInviter
                        .builder()
                        .name("name")
                        .build()
                )
                .invitee(
                    OrganizationInvitationInvitee
                        .builder()
                        .email("email")
                        .build()
                )
                .clientId("client_id")
                .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\CreateOrganizationInvitationRequestContent;
use Auth0\SDK\API\Management\Types\OrganizationInvitationInviter;
use Auth0\SDK\API\Management\Types\OrganizationInvitationInvitee;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->create(
    'id',
    new CreateOrganizationInvitationRequestContent([
        'inviter' => new OrganizationInvitationInviter([
            'name' => 'name',
        ]),
        'invitee' => new OrganizationInvitationInvitee([
            'email' => 'email',
        ]),
        'clientId' => 'client_id',
    ]),
);

from auth0.management import ManagementClient, OrganizationInvitationInviter, OrganizationInvitationInvitee

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

client.organizations.invitations.create(
    id="id",
    inviter=OrganizationInvitationInviter(
        name="name",
    ),
    invitee=OrganizationInvitationInvitee(
        email="email",
    ),
    client_id="client_id",
)

require "auth0"

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

client.organizations.invitations.create(
  id: "id",
  inviter: {
    name: "name"
  },
  invitee: {
    email: "email"
  },
  client_id: "client_id"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/organizations/{id}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
  "invitee": {
    "email": "john.doe@gmail.com"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "app_metadata": {},
  "connection_id": "con_0000000000000001",
  "roles": [
    "<string>"
  ],
  "send_invitation_email": true,
  "ttl_sec": 1296000,
  "user_metadata": {}
}
'

{
  "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.

ヘッダー

auth0-custom-domain

string

この request で使用するカスタムドメイン

Required string length: 3 - 255

パスパラメータ

string

必須

組織ID。

Maximum string length: 50

ボディ

client_id

string<client-id>

デフォルト:AaiyAPdpYdesoKnqjj8HJqRn4T5titww

必須

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

invitee

object

必須

Show child attributes

inviter

object

必須

Show child attributes

app_metadata

object

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

connection_id

string<connection-id>

デフォルト:con_0000000000000001

招待対象者に認証で使用させる接続の id。

roles

string<role-id>[]

ユーザーに関連付ける role ID の一覧。

Minimum array length: 1

send_invitation_email

boolean

デフォルト:true

ユーザーが招待メールを受信するか（true）、受信しないか（false）。デフォルトは true です。

ttl_sec

integer

招待の有効期限が切れるまでの有効秒数。未指定または 0 に設定した場合、この値はデフォルトで 604800 秒（7 日）になります。最大値: 2592000 秒（30 日）。

必須範囲: 0 <= x <= 2592000

user_metadata

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>

組織識別子。

Maximum string length: 50

roles

string<role-id>[]

ユーザーに関連付けるロールIDの一覧。

Minimum array length: 1

ticket_id

string<ticket-id>

招待ticketのID。

user_metadata

object

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