利用可否は Auth0 のプランによって異なります
この機能を利用できるかどうかは、Auth0 のプランまたはカスタム契約によって異なります。詳しくは、Pricing を参照してください。
Auth0 Dashboard
- Auth0 Dashboard > Organizations に移動します。
- Create Organization を選択します。
-
組織の基本情報を入力し、Add Organization を選択します。
Field Description Name 作成する組織の名前です。これは、エンドユーザーがログイン前のプロンプトで、どの組織を通じてログインするかを識別するために入力する名前です。一意の論理識別子です。使用できるのは、小文字のアルファベット、数字、アンダースコア ( _) 、ハイフン (-) です。数字で始めることもできます。1 文字以上 50 文字以下である必要があります。Display Name 表示用のわかりやすい名前です。 -
Branding セクションで組織をカスタマイズし、Save changes を選択します。
Field Description Organization Logo 表示するロゴです。推奨される最小解像度は、幅 200 ピクセル、高さ 200 ピクセルです。 Primary Color 主要な要素に使用する色です。 Page Background Color 背景色です。 - Metadata セクションで、必要なメタデータのキーと値のペアを組織に追加し、Add を選択します。
Management API
Create Organizations エンドポイントに POST リクエストを送信します。プレースホルダーの値は、テナントの適切な値に置き換えてください。詳細については、以下のパラメーター一覧を確認してください。
Auth0 ドメインを確認するAuth0 ドメインは、テナント名、リージョンのサブドメイン (テナントが US リージョンにあり、2020 年 6 月より前に作成されている場合を除く) 、および
.auth0.com を組み合わせたものです。たとえば、テナント名が travel0 の場合、Auth0 ドメイン名は travel0.us.auth0.com になります。 (テナントが US にあり、2020 年 6 月より前に作成されている場合、ドメイン名は https://travel0.auth0.com になります。)カスタムドメインを使用している場合は、カスタムドメイン名を指定してください。| 値 | 説明 |
|---|---|
MGMT_API_ACCESS_TOKEN | スコープ create:organizations を持つ Management API のアクセストークン。 |
ORG_NAME | 作成する組織の名前です。この名前は、エンドユーザーがログイン前のプロンプトで、どの組織を通じてログインするかを識別するために入力します。一意の論理識別子です。使用できるのは、小文字のアルファベット、数字、アンダースコア (_) 、ダッシュ (-) です。数字で始めることもできます。1~50 文字で指定する必要があります。 |
ORG_DISPLAY_NAME | 任意。ログインフローやメールテンプレートに表示できる、わかりやすい組織名です。 |
ORG_LOGO | 任意。組織のロゴの URL。 |
ORG_PRIMARY_COLOR | 任意。主要な要素に使用する HEX カラーコード。 |
ORG_BACKGROUND_COLOR | 任意。背景に使用する HEX カラーコード。 |
KEY/VALUE | 任意。組織のメタデータを表す文字列のキーと値のペアです。それぞれ最大 255 文字まで指定できます。メタデータのペアは最大 25 個です。 |
CONNECTION_ID | 任意。指定した組織で有効にする接続の ID。有効な接続は組織のログインプロンプトに表示されるため、ユーザーはそれらを通じてアプリケーションにアクセスできます。 |
ASSIGN_MEMBERSHIP_OPTION | 任意。有効にした接続でログインするユーザーに、指定した組織のメンバーシップを自動的に付与するかどうかを示します。true に設定すると、ユーザーにメンバーシップが自動的に付与されます。false に設定すると、自動的には付与されません。 |
レスポンスステータスコード
| ステータスコード | エラーコード | メッセージ | 原因 |
|---|---|---|---|
201 | 組織が正常に作成されました。 | ||
400 | invalid_body | リクエストボディが無効です。メッセージは原因に応じて異なります。 | リクエストペイロードが無効です。 |
400 | invalid_query_string | リクエストのクエリ文字列が無効です。メッセージは原因に応じて異なります。 | クエリ文字列が無効です。 |
401 | 無効なトークンです。 | ||
401 | JSON Web Token の検証で受信したシグネチャが無効です。 | ||
401 | クライアントはグローバルではありません。 | ||
403 | insufficient_scope | スコープが不足しています。必要なスコープのいずれか: create:organizations。 | 指定された Bearer トークンのスコープでは許可されていないフィールドの読み取りまたは書き込みが試行されました。 |
409 | organization_conflict | 同じ名前の組織がすでに存在します。 | 同じ名前の組織がすでに存在します。 |
429 | リクエスト数が多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset ヘッダーを確認してください。 |