Obtener servidor de recursos por id

Recupere los detalles de la API con el ID especificado.

GET https://{tenantDomain}/api/v2/resource-servers/{id}

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.GetResourceServerRequestParameters{
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.ResourceServers.Get(
        context.TODO(),
        "id",
        request,
    )
}

200

{
  "allow_offline_access": true,
  "allow_online_access": true,
  "allow_online_access_with_ephemeral_sessions": true,
  "authorization_details": [
    "<unknown>"
  ],
  "authorization_policy": {
    "policy_id": "<string>"
  },
  "client_id": "<string>",
  "enforce_policies": true,
  "id": "<string>",
  "identifier": "<string>",
  "is_system": true,
  "name": "<string>",
  "proof_of_possession": {
    "required": true
  },
  "scopes": [
    {
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "signing_alg": "HS256",
  "signing_secret": "<string>",
  "skip_consent_for_verifiable_first_party_clients": true,
  "subject_type_authorization": {
    "client": {},
    "user": {}
  },
  "token_encryption": {
    "encryption_key": {
      "pem": "-----BEGIN PUBLIC KEY-----\r\nMIIBIjANBg...\r\n-----END PUBLIC KEY-----\r\n",
      "kid": "<string>",
      "name": "<string>"
    }
  },
  "token_lifetime": 123,
  "token_lifetime_for_web": 123
}

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

ID o audiencia del servidor de recursos que se va a recuperar.

Parámetros de consulta

include_fields · boolean

Indica si los campos especificados deben incluirse (true) o excluirse (false).

Respuesta

200

application/json

Servidor de recursos recuperado correctamente.

allow_offline_access · boolean

Indica si se pueden emitir tokens de actualización para esta API (true) o no (false).

allow_online_access · boolean

Indica si se pueden emitir tokens de actualización en línea para esta API (true) o no (false).

allow_online_access_with_ephemeral_sessions · boolean

Indica si se pueden emitir tokens de actualización en línea incluso cuando las sesiones están configuradas como efímeras (true) o no (false).

authorization_details · any[] | null

authorization_policy · object · EA

Política de autorización del servidor de recursos.

Show child attributes

client_id · string<client-id>

ID de cliente del cliente al que está vinculado este servidor de recursos

consent_policy · enum<string> | null

Opciones disponibles: transactional-authorization-with-mfa, null

enforce_policies · boolean

Indica si las políticas de autorización se aplican (true) o no se aplican (false).

id · string

ID de la API (servidor de recursos).

identifier · string

Identificador único de la API que se usa como parámetro audience en las llamadas de autorización. No se puede cambiar una vez establecido.

is_system · boolean

Indica si esta es una API del sistema de Auth0 (true) o una API personalizada (false).

name · string

Nombre descriptivo de este servidor de recursos. No puede contener los caracteres < o >.

proof_of_possession · object

Configuración de Proof-of-Possession para tokens de acceso

Show child attributes

scopes · object[]

Lista de permisos (alcances) que usa esta API.

Show child attributes

signing_alg · enum<string> · predeterminado: HS256

Algoritmo utilizado para firmar JWT. Puede ser HS256 (predeterminado) o RS256. PS256 está disponible mediante addon.

Opciones disponibles: HS256, RS256, RS512, PS256

signing_secret · string

Secret usado para firmar tokens al usar algoritmos simétricos (HS256).

Minimum string length: 16

skip_consent_for_verifiable_first_party_clients · boolean

Indica si se omite el consentimiento del usuario para las aplicaciones marcadas como de primera parte (true) o no (false).

subject_type_authorization · object

Define el permiso de acceso de la aplicación para un servidor de recursos

Show child attributes

token_dialect · enum<string>

Dialecto de los tokens de acceso que se deben emitir. access_token es un JWT que contiene claims estándar de Auth0; rfc9068_profile es un JWT conforme al perfil de token de acceso JWT de la IETF. access_token_authz y rfc9068_profile_authz también incluyen claims de permisos de RBAC.

Opciones disponibles: access_token, access_token_authz, rfc9068_profile, rfc9068_profile_authz

token_encryption · object

Show child attributes

token_lifetime · integer

Valor de expiración (en segundos) de los tokens de acceso emitidos para esta API desde el token endpoint.

token_lifetime_for_web · integer

Valor de expiración (en segundos) de los tokens de acceso emitidos para esta API mediante flujos implícitos o híbridos. No puede ser mayor que el valor de token_lifetime.