Obtener organizaciones

Recupere una lista detallada de todas las organizaciones disponibles en su inquilino. Para obtener más información, consulte Auth0 Organizations.

Este endpoint admite dos tipos de paginación:

• Paginación por offset
• Paginación por punto de control

Debe usar la paginación por punto de control si necesita recuperar más de 1000 organizaciones.

Paginación por punto de control

Para buscar por punto de control, use los siguientes parámetros:

• from: id opcional a partir del cual se iniciará la selección.
• take: El número total de entradas que se recuperarán al usar el parámetro from. El valor predeterminado es 50.

Nota: La primera vez que llame a este endpoint con paginación por punto de control, omita el parámetro from. Si hay más resultados, se incluirá un valor next en la respuesta. Puede usarlo en llamadas posteriores a la API. Cuando next deje de incluirse en la respuesta, no quedarán más páginas.

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,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.list({
        from: "from",
        take: 1,
        sort: "sort",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.list({
        from: "from",
        take: 1,
        sort: "sort",
    });
}
main();

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}/api/v2/organizations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/organizations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}/api/v2/organizations")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de consulta

page · integer

Índice de página de los resultados que se devolverán. La primera página es 0.

Rango requerido: 0 <= x <= 1000

per_page · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

include_totals · boolean

Devuelve los resultados dentro de un objeto que contiene el recuento total de resultados (true) o como un array directo de resultados (false, valor predeterminado).

from · string

Id opcional a partir del cual se iniciará la selección.

take · integer

Número de resultados por página. El valor predeterminado es 50.

Rango requerido: 1 <= x <= 100

sort · string

Campo por el que se ordenará. Use field:order, donde order es 1 para orden ascendente y -1 para orden descendente. Por ejemplo, created_at:1. Actualmente admitimos ordenar por los siguientes campos: name, display_name y created_at.

Maximum string length: 15

Respuesta

200

application/json

Organizaciones recuperadas correctamente.

Option 1 · object[]

Option 2 · object

Option 3 · object

branding · object

Theme define cómo aplicar estilo a las páginas de Login.

Show child attributes

display_name · string · predeterminado: Acme Users

Nombre descriptivo de esta organización.

Required string length: 1 - 255

id · string<organization-id>

Identificador de la organización.

Maximum string length: 50

metadata · object

Metadatos asociados a la organización, en forma de objeto con valores de cadena (máx. 255 caracteres). Se permite un máximo de 25 propiedades de metadatos.

Show child attributes

name · string<organization-name> · predeterminado: organization-1

El nombre de esta organización.

Required string length: 1 - 50

token_quota · object · EA

Show child attributes