組織の取得

テナントで使用可能なすべての組織の詳細一覧を取得します。詳しくは、Auth0 組織を参照してください。

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

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

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

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

チェックポイントによる検索には、次のパラメーターを使用します。

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

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

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

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ListOrganizationsRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Sort: management.String(
            "sort",
        ),
    }
    client.Organizations.List(
        context.TODO(),
        request,
    )
}

200

[
  {
    "branding": {
      "colors": {
        "page_background": "<string>",
        "primary": "<string>"
      },
      "logo_url": "<string>"
    },
    "display_name": "Acme Users",
    "id": "<string>",
    "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

レスポンス

200

application/json

組織を正常に取得しました。

Option 1 · object[]

Option 2 · object

Option 3 · object

branding · object

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

Show child attributes

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

この組織のフレンドリ名。

Required string length: 1 - 255

id · string<organization-id>

組織の識別子。

Maximum string length: 50

metadata · object

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

Show child attributes

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

この組織の名前。

Required string length: 1 - 50

token_quota · object · EA

Show child attributes