組織 はAuth0 Dashboard またはManagement API を使って作成することができます。
利用可能性はAuth0プランによって異なる この機能が利用できるかどうかは、ご利用のAuth0プラン(または契約)によります。詳細については、「価格設定 」をお読みください。
Auth0ダッシュボード
Auth0 Dashboardを使用して組織を作成するには、以下を行います。
[Auth0 Dashboard]>[Organizations(組織)] に移動します。
[Create Organization(Organizationの作成)] を選択します。
組織についての基本情報を入力してから、[Add Organization(組織の追加)] を選択します。
フィールド 説明 Name(名前) 作成したい組織の名前です。これは、エンドユーザーがログインしたい組織を特定するためにpre-login(ログイン前)プロンプトに入力する名前です。一意の論理識別子です。小文字のアルファベット文字、数字、アンダースコア(_
)、ダッシュ(-
)を使用することができます。先頭に数字を入力することができます。1~50文字でなければなりません。 Display Name(表示名) 表示のための、ユーザーに分かりやすい名前です。
[Branding(ブランディング)] セクションで組織をカスタマイズしてから、[Save Changes(変更の保存)] を選択します。
フィールド 説明 Organization Logo(組織ロゴ) 表示されるロゴです。推奨される最小解像度は200ピクセル(幅)x 200ピクセル(高さ)です。 Primary Color(主な色) 主な要素の色。 Page Background Color(ページ背景色) 背景の色。
[Metadata(メタデータ)] セクションで、組織に必要なメタデータのキー/値のペアを追加してから、[Add(追加)] を選択します。
Mangement API
Management APIを使用して組織を作成するには、以下を行います。
組織作成
エンドポイントにPOST
呼び出しを行います。placeholder値は必ずテナントからの適切な値に置き換えてください。詳細については、以下のパラメーターの表を参照してください。
cURL
C#
Go
Java
Node.JS
Obj-C
PHP
Python
Ruby
Swift
curl --request POST \
--url 'https://{yourDomain}/api/v2/organizations' \
--header 'authorization: Bearer {MGMT_API_ACCESS_TOKEN}' \
--header 'cache-control: no-cache' \
--header 'content-type: application/json' \
--data '{ "name": "ORG_NAME", "display_name": "ORG_DISPLAY_NAME", "branding": [ { "logo_url": "{orgLogo}", "colors": [ { "primary": "{orgPrimaryColor}", "page_background": "{orgPageBackground}" } ] } ], "metadata": [ { "{key}": "{value}", "{key}": "{value}", "{key}": "{value}" } ] }, "enabled_connections": [ { "connection_id": "{connectionId}", "assign_membership_on_login": "{assignMembershipOption}" }, { "connection_id": "{connectionId}", "assign_membership_on_login": "{assignMembershipOption}" } ] }'
Auth0ドメインを見つける テナント名がAuth0ドメインである場合は、地域のサブドメイン(テナントが米国地域にあり、2020年6月より前に作成された場合を除く)の後に「.auth0.com
」が続きます。たとえば、テナント名が「travel0
」の場合、Auth0のドメイン名は「travel0.us.auth0.com
」になります。(テナントが米国内にあって、2020年6月よりも前に作成された場合、ドメイン名は「https://travel0.auth0.com
」になります。) カスタムドメインを使用している場合には、これがカスタムドメイン名になります。
値 説明 MGMT_API_ACCESS_TOKEN
read:organizations
スコープのあるManagement APIのアクセストークン です。ORG_NAME
作成したい組織の名前です。これは、エンドユーザーがログインしたい組織を特定するためにpre-login(ログイン前)プロンプトに入力する名前です。一意の論理識別子です。小文字のアルファベット文字、数字、アンダースコア(_
)、ダッシュ(-
)を使用することができます。先頭に数字を入力することができます。1~50文字でなければなりません。 ORG_DISPLAY_NAME
任意です。ユーザーに分かりやすい組織名で、ログインフローやメールテンプレートに表示することができます。 ORG_LOGO
任意です。組織ロゴのURLです。 ORG_PRIMARY_COLOR
任意です。プライマリー要素の16進数カラーコードです。 ORG_BACKGROUND_COLOR
任意です。背景の16進数カラーコードです。 KEY
/VALUE
任意です。組織のメタデータを表す文字列キーと値のペアです。255文字が上限です。メタデータのペアは10が上限です。 CONNECTION_ID
任意です。特定の組織に有効化したい接続のIDです。有効化された接続は組織のログインプロンプトに表示され、ユーザーはそれを通してアプリケーションにアクセスすることができます。 ASSIGN_MEMBERSHIP_OPTION
任意です。有効化された接続でログインしたユーザーに、指定された組織のメンバーシップを自動的に付与するのかを指定します。true
に設定すると、ユーザーに対して自動的にメンバーシップが付与されます。false
に設定すると、メンバーシップはユーザーに自動的に付与されません。
応答ステータスコード
可能性のある応答ステータスコードは以下のとおりです。
ステータスコード エラーコード メッセージ 原因 201
Organization successfully created.(Organizationが正常に作成されました。) 400
invalid_body
Invalid request body.(無効な要求本文です。)メッセージは、原因によって異なります。 要求ペイロードが有効ではありません。 400
invalid_query_string
Invalid request query string(無効な要求クエリ文字列です)メッセージは、原因によって異なります。 クエリ文字列が有効ではありません。 401
Invalid token.(無効なトークンです。) 401
Invalid signature received for JSON Web Token validation.(JSON Web Tokenの検証に無効な署名を受け取りました。) 401
Client is not global.(クライアントがグローバルではありません。) 403
insufficient_scope
Insufficient scope; expected any of: create:organizations
.(スコープが不十分です。create:organizations
が必要です。) 渡されたベアラートークンのスコープでは許可されないフィールドの読み込みや書き出しが試行されました。 409
organization_conflict
An organization with the same name already exists.(同じ名前の組織が既に存在します。) 同じ名前の組織が既に存在します。 429
Too many requests.Check the X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset headers.(要求が多すぎます。X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Resetヘッダーを確認してください。)