組織へのメンバーシップ招待を送信する

Auth0 Dashboard または Management API を使用して、組織へのメンバーシップ招待を送信する方法を学びます。

組織へのメンバーシップ招待は、Auth0 DashboardまたはManagement APIを使用してユーザーに送信できます。

​

Auth0 Dashboard

Auth0 Dashboard でメンバーを招待するには、次の手順に従います。

1. Auth0 Dashboard > 組織 に移動し、メンバーシップを設定する組織を選択します。

2. Invitations ビューで、Invite Members を選択します。

3. メンバーを招待する アプリケーション を選択し、組織に招待するユーザーのメールアドレスを入力して、Send Invite(s) を選択します。

   必要に応じて、ユーザーが招待を承諾する際に使用する接続や、承諾時に組織メンバーに割り当てるロールを指定できます。組織ロールを事前に割り当てるには、ロールセレクターでこの組織にスコープが設定されたロールを選択します。

複数のカスタムドメイン を有効にすると、Send Invite(s) セクションの Domain で、テナントの通知ドメインを選択できます。

​

Management API

アプリケーション向けにカスタマイズした管理ダッシュボードから招待機能を公開する場合は、新しいメンバーを招待する前に、認証済みユーザーが組織に属していることを確認するため、confidential アプリケーションを使用してください。あるいは、特定のロールが割り当てられているユーザー以外は新しいメンバーを招待できないように制限することもできます。

Management API を使用してメンバーを招待するには:

Create Organization Invitations エンドポイントに POST リクエストを送信します。ORG_ID、MGMT_API_ACCESS_TOKEN、NAME_OF_USER、EMAIL_ADDRESS、CLIENT_ID、CONNECTION_ID、EXP_TIME、ROLE_ID、SEND_INVITATION_EMAIL_OPTION の各プレースホルダー値は、それぞれ組織ID、Management API のアクセストークン、招待するユーザーの名前、招待するユーザーのメールアドレス、client ID、接続 ID、有効期限、ロール ID に必ず置き換えてください。

{
  "method": "POST",
  "url": "https://{yourDomain}/api/v2/organizations/ORG_ID/invitations",
"headers": [
  { "name": "Content-Type", "value": "application/json" },
  { "name": "Authorization", "value": "Bearer MGMT_API_ACCESS_TOKEN" },
  { "name": "Cache-Control", "value": "no-cache" }
  ],
  "postData": {
  "mimeType": "application/json",
  "text" : "{ \"inviter\": { \"name\": \"NAME_OF_USER\"}, \"invitee\": { \"email\": \"EMAIL_ADDRESS\" }, \"client_id\": \"CLIENT_ID\", \"connection_id\": \"CONNECTION_ID\", \"ttl_sec\": \"EXP_TIME\", \"roles\": [ \"ROLE_ID\", \"ROLE_ID\", \"ROLE_ID\" ], \"send_invitation_email\": \"SEND_EMAIL_INVITATION_OPTION\" }"
  }
}

複数のカスタムドメイン を有効にしている場合は、auth0-custom-domain HTTP ヘッダーを含める必要があります。詳しくは、複数のカスタムドメイン をご覧ください。

Auth0 ドメインを確認する

Auth0 ドメインは、テナント名、リージョンのサブドメイン (テナントが米国リージョンにあり、2020 年 6 月以前に作成されている場合を除く) 、および .auth0.com を組み合わせたものです。たとえば、テナント名が travel0 の場合、Auth0 ドメイン名は travel0.us.auth0.com になります。 (テナントが米国にあり、2020 年 6 月以前に作成されている場合、ドメイン名は https://travel0.auth0.com になります。)

カスタムドメインを使用している場合は、こちらにそのカスタムドメイン名を指定してください。

Value	Description
ORG_ID	メンバーシップを割り当てる対象の 組織 の ID。
MGMT_API_ACCESS_TOKEN	スコープ create:organization_invitations を持つ Management API のアクセストークン。
NAME_OF_USER	招待を送信するユーザーの名前。最大 300 文字。
EMAIL_ADDRESS	招待の送信先メールアドレス。
CLIENT_ID	招待されたユーザーが認証を行うアプリケーションの ID。
CONNECTION_ID	招待されたメンバーが認証を行う接続の ID。
EXP_TIME	招待の有効期限が切れるまでの秒数。指定しない場合、または 0 に設定した場合は、デフォルトで 604800 秒 (7 日間) になります。最大 2592000 秒 (30 日間) 。
ROLE_ID	指定した 組織 について、招待されたユーザーに割り当てるロールの ID。組織スコープのロールを事前に割り当てるには、組織ロールの ID を渡します。roles 配列は任意です。省略した場合、招待されたユーザーはロールが割り当てられていない状態で参加します。メンバー 1 人あたり最大 50 ロール。
SEND_INVITATION_EMAIL_OPTION	Auth0 がメールを送信するかどうかを示します。値は true または false です。false に設定すると、Auth0 は招待 URL を生成し、それを独自のメールサービスを通じてユーザーに送信できます。

​

レスポンスステータスコード

レスポンスとして返される可能性のあるステータスコードは次のとおりです。

Status code	Error code	Message	Cause
200		招待が正常に作成されました。
400	invalid_body	指定された client_id は存在しません。	リクエストのペイロードが有効ではありません。
400	invalid_body	指定された接続は存在しません。	リクエストのペイロードが有効ではありません。
400	invalid_body	パスワードレス接続はサポートされていません。	リクエストのペイロードが有効ではありません。
400	invalid_body	招待 URL を生成するには、デフォルトのログインルートが必要です。詳しくは、Configure default login routes を参照してください。	リクエストのペイロードが有効ではありません。
400	invalid_body	指定されたロールのうち 1 つ以上が存在しません: role1, role2’。	リクエストのペイロードが有効ではありません。
400	invalid_body	リクエスト本文が無効です。メッセージは原因によって異なります。	リクエストのペイロードが有効ではありません。
400	invalid_query_string	リクエストのクエリ文字列が無効です。メッセージは原因によって異なります。	クエリ文字列が有効ではありません。
401		無効なトークンです。
401		JSON Web Token の検証で無効な署名を受信しました。
401		クライアントはグローバルではありません。
403	insufficient_scope	スコープが不足しています。必要なスコープのいずれか: create:organization_invitations。	提供された bearer token のスコープでは許可されていないフィールドの読み取りまたは書き込みを試みました。
404		その ID に一致する組織が見つかりません。
429		リクエストが多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset ヘッダーを確認してください。