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

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

Auth0 Dashboard

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

Auth0 Dashboard > Organizations に移動し、メンバーシップを設定する組織を選択します。
Invitations ビューを選択し、Invite Members を選択します。
招待先のアプリケーションを選択し、組織に招待するユーザーのメールアドレスを入力して、Send Invite(s) を選択します。
必要に応じて、ユーザーが招待を承諾する際に使用する接続と、承諾時に組織メンバーに割り当てるロールを指定できます。

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

Management API

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

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 の、招待するユーザーの名前、招待するユーザーのメールアドレス、、接続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 ドメインは、テナント名、リージョンのサブドメイン (テナントが US リージョンにあり、2020 年 6 月より前に作成された場合を除く) 、および .auth0.com を組み合わせたものです。たとえば、テナント名が travel0 の場合、Auth0 ドメイン名は travel0.us.auth0.com になります。 (テナントが US にあり、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。メンバーごとに最大 50 ロール。
`SEND_INVITATION_EMAIL_OPTION`	Auth0 がメールを送信するかどうかを示します。値は `true` または `false` です。`false` に設定すると、独自のメールサービスを通じてユーザーに送信できる招待 URL が Auth0 によって生成されます。

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

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

ステータスコード	エラーコード	メッセージ	原因
`200`		招待が正常に作成されました。
`400`	`invalid_body`	指定された client_id は存在しません。	リクエストペイロードが無効です。
`400`	`invalid_body`	指定された接続は存在しません。	リクエストペイロードが無効です。
`400`	`invalid_body`	パスワードレス接続はサポートされていません。	リクエストペイロードが無効です。
`400`	`invalid_body`	招待 URL を生成するには、デフォルトのログインルートが必要です。詳しくは、デフォルトのログインルートを設定するを参照してください。	リクエストペイロードが無効です。
`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 ヘッダーを確認してください。

​Auth0 Dashboard

​Management API

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

Auth0 Dashboard

Management API

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