Obtenir les Organizations

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

Cet endpoint prend en charge deux types de pagination :

• Pagination par décalage
• Pagination par checkpoint

La pagination par checkpoint doit être utilisée si vous devez récupérer plus de 1 000 organisations.

Pagination par checkpoint

Pour effectuer une recherche par checkpoint, 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 de 50.

Remarque : La première fois que vous appelez cet endpoint en utilisant la pagination par checkpoint, 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 ne reste plus de pages.

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

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

Index de la page de résultats à retourner. 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 de 50.

Plage requise: 1 <= x <= 100

include_totals · boolean

Retourner les résultats dans un objet qui contient le nombre total de résultats (true) ou comme tableau direct de résultats (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 de 50.

Plage requise: 1 <= x <= 100

sort · string

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

Maximum string length: 15

include_client_association_for · string · EA

ID du client. Lorsqu’il est défini, chaque organisation renvoyée associée à ce client comprend un objet client qui la décrit; les organisations qui ne lui sont pas associées n’incluent pas ce champ.

Réponse

200

application/json

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

Option 1 · object[]

Option 2 · object

Option 3 · object

branding · object

Theme définit le style des pages de connexion.

Show child attributes

client · object · EA

L’association de l’organisation avec le client transmis dans le paramètre de requête include_client_association_for.

Show child attributes

display_name · string · défaut: Acme Users

Le nom convivial de cette organisation.

Required string length: 1 - 255

id · string<organization-id>

Identifiant de l’organisation.

Maximum string length: 50

is_app_entitlement_active · boolean · EA

Indique si le droit d’accès de l’application est actif pour cette organisation.

metadata · object

Métadonnées associées à l’organisation, sous la forme d’un objet contenant des valeurs de type String (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

third_party_client_access · enum<string> · GA

Détermine si cette organisation peut être utilisée dans les flux utilisateur avec des clients tiers. La valeur par défaut est block.

Options disponibles: block, allow

token_quota · object · EA

Show child attributes