Obtener los Client Grants

Recupere una lista de Client Grants, incluidos los alcances asociados al par aplicación/API.

GET https://{tenantDomain}/api/v2/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"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.ListClientGrantsRequestParameters{
        From: management.String(
            "from",
        ),
        Take: management.Int(
            1,
        ),
        Audience: management.String(
            "audience",
        ),
        ClientId: management.String(
            "client_id",
        ),
        AllowAnyOrganization: management.Bool(
            true,
        ),
    }
    client.ClientGrants.List(
        context.TODO(),
        request,
    )
}

200

[
  {
    "allow_all_scopes": true,
    "allow_any_organization": true,
    "audience": "<string>",
    "authorization_details_types": [
      "<string>"
    ],
    "client_id": "<string>",
    "id": "<string>",
    "is_system": true,
    "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 consulta

per_page · integer

Número de resultados por página.

Rango requerido: 1 <= x <= 100

page · integer

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

Rango requerido: x >= 0

include_totals · boolean

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

from · string

id opcional a partir del cual iniciar la selección.

take · integer

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

Rango requerido: 1 <= x <= 100

audience · string

Filtro opcional por audiencia.

client_id · string

Filtro opcional por client_id.

allow_any_organization · enum<boolean>

Filtro opcional por allow_any_organization. Filtro opcional para allow_any_organization.

Opciones disponibles: true

subject_type · enum<string>

El tipo de acceso a la aplicación que permite el client grant. El tipo de acceso a la aplicación que permite esta concesión de cliente.

Opciones disponibles: client, user

default_for · enum<string> · GA

Aplica este Client Grants como valor predeterminado para todos los clientes del grupo especificado. El único valor aceptado es third_party_clients, que aplica la concesión a todos los clientes de terceros. Los Client Grants por cliente para la misma audiencia tienen prioridad. Es mutuamente excluyente con client_id. Aplica esta concesión de cliente como predeterminada para todos los clientes del grupo especificado. El único valor aceptado es third_party_clients, que aplica la concesión a todos los clientes de terceros. Las concesiones por cliente para la misma audiencia tienen prioridad. Es mutuamente excluyente con client_id.

Opciones disponibles: third_party_clients

Respuesta

200

application/json

Client Grants recuperados correctamente.

Option 1 · object[]

Option 2 · object

Option 3 · object

allow_all_scopes · boolean

Si está habilitado, se permiten todos los alcances configurados en el servidor de recursos para esta concesión.

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 la API) de esta concesión de cliente.

Minimum string length: 1

authorization_details_types · string[]

Tipos de authorization_details permitidos para esta concesión de cliente.

Required string length: 1 - 255

client_id · string

ID del cliente.

default_for · enum<string> · GA

Aplica esta concesión de cliente como predeterminada para todos los clientes del grupo especificado. El único valor aceptado es third_party_clients, que aplica la concesión a todos los clientes de terceros. Las concesiones por cliente para la misma audiencia tienen prioridad. Es mutuamente excluyente con client_id.

Opciones disponibles: third_party_clients

id · string

ID de la concesión de cliente.

is_system · boolean

Si está habilitado, esta concesión es una concesión especial creada por Auth0. No se puede modificar ni eliminar directamente.

organization_usage · enum<string>

Define si las organizaciones pueden usarse con intercambios de credenciales de cliente para esta concesión.

Opciones disponibles: deny, allow, require

scope · string[]

Alcances permitidos para esta concesión de cliente.

Minimum string length: 1

subject_type · enum<string>

El tipo de acceso a la aplicación que permite esta concesión de cliente.

Opciones disponibles: client, user