Obtener los Client Grants de una organización

GET https://{tenantDomain}/api/v2/organizations/{id}/client-grants

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"
    organizations "github.com/auth0/go-auth0/management/management/organizations"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &organizations.ListOrganizationClientGrantsRequestParameters{
        Audience: management.String(
            "audience",
        ),
        ClientId: management.String(
            "client_id",
        ),
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
    }
    client.Organizations.ClientGrants.List(
        context.TODO(),
        "id",
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.clientGrants.list("id", {
        audience: "audience",
        clientId: "client_id",
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.clientGrants.list("id", {
        audience: "audience",
        clientId: "client_id",
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();

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

import requests

url = "https://{tenantDomain}/api/v2/organizations/{id}/client-grants"

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

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/organizations/{id}/client-grants")

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

[
  {
    "allow_any_organization": true,
    "audience": "<string>",
    "client_id": "<string>",
    "id": "<string>",
    "scope": [
      "<string>"
    ]
  }
]

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de ruta

id · string · requerido

Identificador de la organización.

Maximum string length: 50

Parámetros de consulta

audience · string

Filtro opcional por audiencia del client grant.

Maximum string length: 600

client_id · string

Filtro opcional por client_id del client grant.

grant_ids · string<client-grant-id>[]

Filtro opcional por el ID del client grant. Debe estar codificado en URL y puede especificarse varias veces (máx. 10).
p. ej. ../client-grants?grant_ids=id1&grant_ids=id2

page · integer

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

Rango requerido: x >= 0

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 número total de resultados (true) o como un arreglo directo de resultados (false, valor predeterminado).

Respuesta

200

application/json

Client Grants recuperados correctamente.

object[]

object

allow_any_organization · boolean

Si está habilitado, cualquier organización puede usarse con esta concesión. Si está deshabilitado (valor predeterminado), la concesión debe asignarse explícitamente a las organizaciones deseadas.

audience · string

La audiencia (identificador de API) de esta concesión del cliente

Minimum string length: 1

client_id · string

ID del cliente.

id · string

ID de la concesión del cliente.

organization_usage · enum<string>

Define si las organizaciones se pueden usar con Client Credentials Exchange para esta concesión.

Opciones disponibles: deny, allow, require

scope · string[]

Alcances permitidos para esta concesión del cliente.

Minimum string length: 1