Organizationsを取得

tenant で利用可能なすべての Organizations の詳細な一覧を取得します。詳しくは、Auth0 Organizations を参照してください。

この endpoint は、次の 2 種類のページネーションをサポートしています。

• オフセットページネーション
• チェックポイントページネーション

1000 件を超える組織を取得する必要がある場合は、チェックポイントページネーションを使用する必要があります。

チェックポイントページネーション

checkpoint で検索するには、次のパラメーターを使用します。

• from: 取得開始位置となる省略可能な ID。
• take: from パラメーターを使用する場合に取得するエントリーの総数。既定値は 50 です。

注: チェックポイントページネーションを使用してこの endpoint を初めて呼び出すときは、from パラメーターを省略してください。さらに結果がある場合は、レスポンスに next 値が含まれます。これは後続の API 呼び出しで使用できます。レスポンスに next が含まれなくなった時点で、残りのページはありません。

GET https://{tenantDomain}/api/v2/organizations

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;

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.ListAsync(
            new ListOrganizationsRequestParameters {
                From = "from",
                Take = 1,
                Sort = "sort",
                IncludeClientAssociationFor = "include_client_association_for"
            }
        );
    }

}

200

[
  {
    "branding": {
      "colors": {
        "page_background": "<string>",
        "primary": "<string>"
      },
      "logo_url": "<string>"
    },
    "client": {
      "use_for_member_access": true
    },
    "display_name": "Acme Users",
    "id": "<string>",
    "is_app_entitlement_active": true,
    "metadata": {},
    "name": "organization-1",
    "token_quota": {
      "client_credentials": {
        "enforce": true,
        "per_day": 1073741824,
        "per_hour": 1073741824
      }
    }
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

クエリパラメータ

page · integer

返す結果のページ index。最初のページは 0 です。

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

per_page · integer

1 ページあたりの結果数。既定値は 50 です。

必須範囲: 1 <= x <= 100

include_totals · boolean

結果を、総結果数を含むオブジェクト内に返すか（true）、結果の配列を直接返すか（false、既定値）を指定します。

from · string

取得開始位置となる省略可能な ID。

take · integer

1 ページあたりの結果数。既定値は 50 です。

必須範囲: 1 <= x <= 100

sort · string

並べ替えに使用するフィールド。昇順の場合は 1、降順の場合は -1 を order に指定し、field:order 形式で使用します。例: created_at:1。現在、次のフィールドでの並べ替えをサポートしています: name、display_name、created_at。

Maximum string length: 15

include_client_association_for · string · EA

クライアントID。設定すると、このクライアントに関連付けられた各organizationには、そのクライアントを示すclientオブジェクトが含まれます。関連付けのないorganizationでは、このフィールドは省略されます。

レスポンス

200

application/json

Organizations を正常に取得しました。

Option 1 · object[]

Option 2 · object

Option 3 · object

branding · object

Theme はログインページのスタイルを定義します。

Show child attributes

client · object · EA

include_client_association_for クエリパラメータで渡されたクライアントと organization の関連付け。

Show child attributes

display_name · string · デフォルト: Acme Users

このorganizationのフレンドリー名。

Required string length: 1 - 255

id · string<organization-id>

organizationの識別子。

Maximum string length: 50

is_app_entitlement_active · boolean · EA

この organization でアプリケーションのエンタイトルメントが有効かどうか。

metadata · object

organization に関連付けられたメタデータです。文字列値を持つオブジェクト形式です（最大255文字）。メタデータのプロパティは最大25個まで設定できます。

Show child attributes

name · string<organization-name> · デフォルト: organization-1

このorganizationの名前。

Required string length: 1 - 50

third_party_client_access · enum<string> · GA

この organization をサードパーティ クライアントのユーザーフローで使用できるかどうかを制御します。デフォルトは block です。

利用可能なオプション: block, allow

token_quota · object · EA

Show child attributes