Récupérer les organisations

Récupère la liste détaillée de toutes les organisations disponibles dans votre locataire. Pour en savoir plus, consultez Auth0 Organizations.

Ce point de terminaison prend en charge deux types de pagination :

• Pagination par offset
• Pagination par point de contrôle

La pagination par point de contrôle doit être utilisée si vous devez récupérer plus de 1000 organisations.

Pagination par point de contrôle

Pour effectuer une recherche par point de contrôle, utilisez les paramètres suivants :

• from : id facultatif à partir duquel commencer la sélection.
• take : nombre total d’entrées à récupérer lors de l’utilisation du paramètre from. La valeur par défaut est 50.

Remarque : la première fois que vous appelez ce point de terminaison avec la pagination par point de contrôle, omettez le paramètre from. S’il y a d’autres résultats, une valeur next est incluse dans la réponse. Vous pouvez l’utiliser pour les appels d’API suivants. Lorsque next n’est plus inclus dans la réponse, il n’y a plus d’autres pages.

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
      }
    }
  }
]

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de requête

page · integer

Indice de page des résultats à renvoyer. La première page est 0.

Plage requise: 0 <= x <= 1000

per_page · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

include_totals · boolean

Renvoyer les résultats dans un objet contenant le nombre total de résultats (true) ou sous forme de tableau de résultats direct (false, par défaut).

from · string

id facultatif à partir duquel commencer la sélection.

take · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

sort · string

Champ à utiliser pour le tri. Utilisez field:order, où order vaut 1 pour l’ordre croissant et -1 pour l’ordre décroissant. Par exemple, created_at:1. Nous prenons actuellement en charge le tri selon les champs suivants : name, display_name et created_at.

Maximum string length: 15

Réponse

200

application/json

Organisations récupérées avec succès.

Option 1 · object[]

Option 2 · object

Option 3 · object

branding · object

Le thème définit le style des pages de connexion.

Show child attributes

display_name · string · défaut: Acme Users

Nom convivial de cette organisation.

Required string length: 1 - 255

id · string<organization-id>

Identifiant de l’organisation.

Maximum string length: 50

metadata · object

Métadonnées associées à l’organisation, sous la forme d’un objet avec des valeurs de type chaîne (max. 255 caractères). Un maximum de 25 propriétés de métadonnées est autorisé.

Show child attributes

name · string<organization-name> · défaut: organization-1

Le nom de cette organisation.

Required string length: 1 - 50

token_quota · object · EA

Show child attributes