Créer des informations d’identification

Créez une information d’identification associée à votre application. Les informations d’identification peuvent servir à configurer les méthodes d’authentification par JWT avec clé privée et mTLS, ainsi que les requêtes d’autorisation sécurisées par JWT.

Clé publique

Les informations d’identification de clé publique peuvent servir à configurer l’authentification du client par JWT avec clé privée et les requêtes d’autorisation sécurisées par JWT.

Exemple :

{
  "credential_type": "public_key",
  "name": "string",
  "pem": "string",
  "alg": "RS256",
  "parse_expiry_from_cert": false,
  "expires_at": "2022-12-31T23:59:59Z"
}

Certificat (signé par une AC et autosigné)

Les informations d’identification de certificat peuvent servir à configurer l’authentification client mTLS. Les certificats signés par une AC peuvent être configurés soit avec un certificat signé, soit uniquement avec le DN du sujet du certificat.

Exemple de certificat signé par une AC (pem) :

{
  "credential_type": "x509_cert",
  "name": "string",
  "pem": "string"
}

Exemple de certificat signé par une AC (subject_dn) :

{
  "credential_type": "cert_subject_dn",
  "name": "string",
  "subject_dn": "string"
}

Exemple de certificat autosigné :

{
  "credential_type": "cert_subject_dn",
  "name": "string",
  "pem": "string"
}

L’information d’identification sera créée, mais elle ne sera pas encore activée tant que vous n’aurez pas défini les propriétés correspondantes sur l’application :

• Pour activer l’information d’identification pour les méthodes d’authentification par JWT avec clé privée ou mTLS, définissez la propriété client_authentication_methods sur l’application. Pour en savoir plus, consultez Configurer l’authentification du client par JWT avec clé privée et Configurer l’authentification mTLS
• Pour activer l’information d’identification pour les requêtes d’autorisation sécurisées par JWT, définissez la propriété signed_request_object sur l’application. Pour en savoir plus, consultez Configurer les requêtes d’autorisation sécurisées par JWT (JAR)

POST https://{tenantDomain}/api/v2/clients/{client_id}/credentials

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    clients "github.com/auth0/go-auth0/management/management/clients"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &clients.PostClientCredentialRequestContent{
        CredentialType: management.ClientCredentialTypeEnumPublicKey,
    }
    client.Clients.Credentials.Create(
        context.TODO(),
        "client_id",
        request,
    )
}

201

{
  "alg": "RS256",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "cred_1m7sfABoNTTKYwTQ8qt6tX",
  "kid": "IZSSTECp...",
  "name": "",
  "subject_dn": "<string>",
  "thumbprint_sha256": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

client_id · string · requis

ID de l’application.

Corps

application/jsonapplication/x-www-form-urlencoded

credential_type · enum<string> · requis

Le type d’information d’identification.

Options disponibles: public_key, cert_subject_dn, x509_cert

alg · enum<string> · défaut: RS256

Algorithme utilisé avec l’information d’identification. Peut être l’un des suivants : RS256, RS384, PS256. S’il n’est pas spécifié, RS256 est utilisé. S’applique au type d’information d’identification public_key.

Options disponibles: RS256, RS384, PS256

expires_at · string<date-time> · défaut: 2023-02-07T12:40:17.807Z

Date au format ISO 8601 représentant l’expiration de l’information d’identification. Si elle n’est pas précisée (non recommandé), l’information d’identification n’expire jamais. S’applique au type d’information d’identification public_key.

kid · string

kid (Key ID) facultatif, utilisé pour identifier de manière unique l’information d’identification. S’il n’est pas précisé, une valeur kid sera générée automatiquement. Le paramètre d’en-tête kid dans les JWT envoyés par votre application doit correspondre à cette valeur. Le format valide est [0-9a-zA-Z-_]{10,64}

Required string length: 10 - 64

Pattern: ^([0-9a-zA-Z-_]{10,64})$

name · string · défaut: ""

Nom convivial d’une information d’identification.

Maximum string length: 128

parse_expiry_from_cert · boolean · défaut: false

Analyser la date d’expiration à partir du certificat X509. Si la valeur est true, tente d’analyser la date d’expiration à partir du PEM fourni. S’applique au type d’information d’identification public_key.

pem · string · défaut: -----BEGIN PUBLIC KEY----- MIIBIjANBg... -----END PUBLIC KEY-----

Clé publique au format PEM (SPKI et PKCS1) ou certificat X509. Doit être échappé au format JSON.

subject_dn · string

Nom distinctif du sujet. Mutuellement exclusif avec la propriété pem. S’applique au type d’information d’identification cert_subject_dn.

Required string length: 1 - 256

Réponse

201

application/json

Information d’identification créée avec succès.

alg · enum<string> · défaut: RS256

Algorithme qui sera utilisé avec l’information d’identification. Algorithmes pris en charge : RS256,RS384,PS256

Options disponibles: RS256, RS384, PS256

created_at · string<date-time>

La date de création de l’information d’identification, au format ISO 8601.

credential_type · enum<string>

Le type d’information d’identification.

Options disponibles: public_key, cert_subject_dn, x509_cert

expires_at · string<date-time>

La date au format ISO 8601 représentant l’expiration de l’information d’identification.

id · string · défaut: cred_1m7sfABoNTTKYwTQ8qt6tX

ID de l’information d’identification. Généré lors de la création.

kid · string · défaut: IZSSTECp...

L’identifiant de clé de l’information d’identification, généré lors de la création.

name · string · défaut: ""

Le nom donné à l’information d’identification par l’utilisateur.

subject_dn · string

Le nom distinctif du sujet du certificat X509

thumbprint_sha256 · string

L’empreinte SHA256 du certificat X509

updated_at · string<date-time>

La date de mise à jour de l’information d’identification, au format ISO 8601.