Crear credenciales

Cree una credencial de cliente asociada a su aplicación. Las credenciales se pueden usar para configurar los métodos de autenticación de cliente con JWT de clave privada y mTLS, así como para solicitudes de autorización protegidas con JWT.

Clave pública

Las credenciales de clave pública se pueden usar para configurar la autenticación de cliente con JWT de clave privada y las solicitudes de autorización protegidas con JWT.

Ejemplo:

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

Certificado (firmado por una CA y autofirmado)

Las credenciales de certificado se pueden usar para configurar la autenticación de cliente mediante mTLS. Los certificados firmados por una CA se pueden configurar con un certificado firmado o solo con el Subject DN del certificado.

Ejemplo de certificado firmado por una CA (pem):

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

Ejemplo de certificado firmado por una CA (subject_dn):

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

Ejemplo de certificado autofirmado:

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

La credencial se creará, pero no se habilitará para su uso hasta que establezca las propiedades correspondientes en el cliente:

• Para habilitar la credencial para los métodos de autenticación de cliente con JWT de clave privada o mTLS, establezca la propiedad client_authentication_methods en el cliente. Para obtener más información, consulte Configure Private Key JWT Authentication y Configure mTLS Authentication
• Para habilitar la credencial para solicitudes de autorización protegidas con JWT, establezca la propiedad signed_request_object en el cliente. Para obtener más información, consulte Configure JWT-secured Authorization Requests (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"
}

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de ruta

client_id · string · requerido

ID del cliente.

Cuerpo

application/jsonapplication/x-www-form-urlencoded

credential_type · enum<string> · requerido

El tipo de credencial.

Opciones disponibles: public_key, cert_subject_dn, x509_cert

alg · enum<string> · predeterminado: RS256

Algoritmo que se usará con la credencial. Puede ser uno de los siguientes: RS256, RS384, PS256. Si no se especifica, se usará RS256. Se aplica al tipo de credencial public_key.

Opciones disponibles: RS256, RS384, PS256

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

La fecha en formato ISO 8601 que representa la expiración de la credencial. Si no se especifica (no se recomienda), la credencial nunca vence. Se aplica al tipo de credencial public_key.

kid · string

kid opcional (Key ID), usado para identificar de forma única la credencial. Si no se especifica, se generará automáticamente un valor kid. El parámetro kid del encabezado de los JWT enviados por su cliente debe coincidir con este valor. El formato válido es [0-9a-zA-Z-_]{10,64}

Required string length: 10 - 64

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

name · string · predeterminado: ""

Nombre descriptivo de una credencial.

Maximum string length: 128

parse_expiry_from_cert · boolean · predeterminado: false

Analiza la fecha de expiración del certificado X509. Si es true, intenta analizar la fecha de expiración a partir del PEM proporcionado. Se aplica al tipo de credencial public_key.

pem · string · predeterminado: -----BEGIN PUBLIC KEY----- MIIBIjANBg... -----END PUBLIC KEY-----

Clave pública en formato PEM (SPKI y PKCS1) o certificado X509. Debe tener caracteres de escape JSON.

subject_dn · string

Nombre distintivo del sujeto. Es mutuamente excluyente con la propiedad pem. Se aplica al tipo de credencial cert_subject_dn.

Required string length: 1 - 256

Respuesta

201

application/json

Credencial creada correctamente.

alg · enum<string> · predeterminado: RS256

Algoritmo que se usará con la credencial. Algoritmos soportados: RS256,RS384,PS256

Opciones disponibles: RS256, RS384, PS256

created_at · string<date-time>

La fecha en formato ISO 8601 en que se creó la credencial.

credential_type · enum<string>

El tipo de credencial.

Opciones disponibles: public_key, cert_subject_dn, x509_cert

expires_at · string<date-time>

La fecha en formato ISO 8601 que representa la expiración de la credencial.

id · string · predeterminado: cred_1m7sfABoNTTKYwTQ8qt6tX

ID de la credencial. Se genera al crearla.

kid · string · predeterminado: IZSSTECp...

El identificador de clave de la credencial, generado al crearla.

name · string · predeterminado: ""

El nombre asignado a la credencial por el usuario.

subject_dn · string

El nombre distintivo del sujeto del certificado X509

thumbprint_sha256 · string

La huella digital SHA256 del certificado X509

updated_at · string<date-time>

La fecha en formato ISO 8601 en que se actualizó la credencial.