Obtener nombre por su nombre

Recupere los detalles de una sola organización especificada por nombre.

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

Go

Go

package example

import (
    context "context"

    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>",
        ),
    )
    client.Organizations.GetByName(
        context.TODO(),
        "name",
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.getByName("name");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.getByName("name");
}
main();

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

import requests

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

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/name/{name}",
  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/name/{name}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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 ruta

name · string · requerido

nombre de la organización que se va a recuperar.

Required string length: 1 - 50

Respuesta

200

application/json

Organización recuperada correctamente.

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

Nombre de esta organización.

Required string length: 1 - 50

token_quota · object · EA

Show child attributes