Créer des serveurs de ressources

Créez une nouvelle API associée à votre locataire. Notez que toutes les nouvelles API doivent être enregistrées auprès d’Auth0. Pour en savoir plus, consultez APIs.

POST https://{tenantDomain}/api/v2/resource-servers

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.CreateResourceServerRequestContent{
        Identifier: "identifier",
    }
    client.ResourceServers.Create(
        context.TODO(),
        request,
    )
}

201

{
  "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
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Corps

application/jsonapplication/x-www-form-urlencoded

identifier · string · requis

Identifiant unique de l’API utilisé comme paramètre audience dans les appels d’autorisation. Ne peut pas être modifié une fois défini.

Required string length: 1 - 600

allow_offline_access · boolean

Indique si des Jetons d’actualisation peuvent être émis pour cette API (true) ou non (false).

allow_online_access · boolean

Indique si des Online Refresh Tokens peuvent être émis pour cette API (true) ou non (false).

allow_online_access_with_ephemeral_sessions · boolean

Indique si des Online Refresh Tokens peuvent être émis même lorsque les sessions sont configurées comme éphémères (true) ou non (false).

authorization_details · any[] | null

authorization_policy · object · EA

Stratégie d’autorisation du serveur de ressources.

Show child attributes

consent_policy · enum<string> | null

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

enforce_policies · boolean

Indique s’il faut appliquer les stratégies d’autorisation (true) ou les ignorer (false).

name · string

Nom convivial de ce serveur de ressources. Ne peut pas contenir les caractères < ou >.

Maximum string length: 200

Pattern: ^[^<>]+$

proof_of_possession · object

Configuration de preuve de possession pour les jetons d’accès

Show child attributes

scopes · object[]

Liste des permissions (scopes) utilisées par cette API.

Show child attributes

signing_alg · enum<string> · défaut: HS256

Algorithme utilisé pour signer les JWT. Peut être HS256 (par défaut) ou RS256. PS256 est offert via un addon.

Options disponibles: HS256, RS256, RS512, PS256

signing_secret · string

Secret utilisé pour signer les jetons avec des algorithmes symétriques (HS256).

Minimum string length: 16

skip_consent_for_verifiable_first_party_clients · boolean

Indique s’il faut ignorer le consentement de l’utilisateur pour les applications marquées comme de première partie (true) ou non (false).

subject_type_authorization · object

Définit la permission d’accès de l’application pour un serveur de ressources

Show child attributes

token_dialect · enum<string>

Dialecte du jeton d’accès émis. access_token est un JWT contenant les revendications standard d’Auth0 ; rfc9068_profile est un JWT conforme au profil de jeton d’accès JWT de l’IETF. access_token_authz et rfc9068_profile_authz incluent également des revendications de permission RBAC.

Options disponibles: access_token, access_token_authz, rfc9068_profile, rfc9068_profile_authz

token_encryption · object

Show child attributes

token_lifetime · integer

Valeur d’expiration (en secondes) des jetons d’accès émis pour cette API à partir du point de terminaison de jeton.

Plage requise: 0 <= x <= 2592000

Réponse

201

application/json

Serveur de ressources créé avec succès.

allow_offline_access · boolean

Indique si des Jetons d’actualisation peuvent être émis pour cette API (true) ou non (false).

allow_online_access · boolean

Indique si des Online Refresh Tokens peuvent être émis pour cette API (true) ou non (false).

allow_online_access_with_ephemeral_sessions · boolean

Indique si des Online Refresh Tokens peuvent être émis même lorsque les sessions sont configurées comme éphémères (true) ou non (false).

authorization_details · any[] | null

authorization_policy · object · EA

Stratégie d’autorisation du serveur de ressources.

Show child attributes

client_id · string<client-id>

ID client de l’application à laquelle ce serveur de ressources est lié

consent_policy · enum<string> | null

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

enforce_policies · boolean

Indique si les stratégies d’autorisation sont appliquées (true) ou non (false).

id · string

ID de l’API (serveur de ressources).

identifier · string

Identifiant unique de l’API utilisé comme paramètre audience dans les appels d’autorisation. Ne peut pas être modifié une fois défini.

is_system · boolean

Indique s’il s’agit d’une API système Auth0 (true) ou d’une API personnalisée (false).

name · string

Nom convivial de ce serveur de ressources. Ne peut pas contenir les caractères < ou >.

proof_of_possession · object

Configuration de preuve de possession pour les jetons d’accès

Show child attributes

scopes · object[]

Liste des permissions (scopes) utilisées par cette API.

Show child attributes

signing_alg · enum<string> · défaut: HS256

Algorithme utilisé pour signer les JWT. Peut être HS256 (par défaut) ou RS256. PS256 est offert via un addon.

Options disponibles: HS256, RS256, RS512, PS256

signing_secret · string

Secret utilisé pour signer les jetons avec des algorithmes symétriques (HS256).

Minimum string length: 16

skip_consent_for_verifiable_first_party_clients · boolean

Indique s’il faut ignorer le consentement de l’utilisateur pour les applications marquées comme de première partie (true) ou non (false).

subject_type_authorization · object

Définit la permission d’accès de l’application pour un serveur de ressources

Show child attributes

token_dialect · enum<string>

Dialecte des jetons d’accès à émettre. access_token est un JWT contenant les revendications standard d’Auth0 ; rfc9068_profile est un JWT conforme au profil de jeton d’accès JWT de l’IETF. access_token_authz et rfc9068_profile_authz incluent également des revendications de permission RBAC.

Options disponibles: access_token, access_token_authz, rfc9068_profile, rfc9068_profile_authz

token_encryption · object

Show child attributes

token_lifetime · integer

Valeur d’expiration (en secondes) des jetons d’accès émis pour cette API à partir du point de terminaison de jeton.

token_lifetime_for_web · integer

Valeur d’expiration (en secondes) des jetons d’accès émis pour cette API au moyen des flux implicites ou hybrides. Ne peut pas être supérieure à la valeur token_lifetime.