Update a client credential

Change a client credential you previously created. May be enabled or disabled. For more information, read Client Credential Flow.

PATCH https://{tenantDomain}/api/v2/clients/{client_id}/credentials/{credential_id}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Clients;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementClient(
            token: "<token>"
        );

        await client.Clients.Credentials.UpdateAsync(
            clientId: "client_id",
            credentialId: "credential_id",
            request: new PatchClientCredentialRequestContent()
        );
    }

}

package example

import (
    context "context"

    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.PatchClientCredentialRequestContent{}
    client.Clients.Credentials.Update(
        context.TODO(),
        "client_id",
        "credential_id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.resources.clients.credentials.requests.PatchClientCredentialRequestContent;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .token("<token>")
            .build();

        client.clients().credentials().update(
            "client_id",
            "credential_id",
            PatchClientCredentialRequestContent
                .builder()
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Management;
use Auth0\SDK\API\Management\Clients\Credentials\Requests\PatchClientCredentialRequestContent;

$client = new Management(
    token: '<token>',
);
$client->clients->credentials->update(
    'client_id',
    'credential_id',
    new PatchClientCredentialRequestContent([]),
);

from auth0.management import ManagementClient

client = ManagementClient(
    token="<token>",
)

client.clients.credentials.update(
    client_id="client_id",
    credential_id="credential_id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>")

client.clients.credentials.update(
  client_id: "client_id",
  credential_id: "credential_id"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.clients.credentials.update("client_id", "credential_id", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.clients.credentials.update("client_id", "credential_id", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/clients/{client_id}/credentials/{credential_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expires_at": "2023-11-07T05:31:56Z"
}
'

201

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

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

client_id · string · required

ID of the client.

credential_id · string · required

ID of the credential.

Body

application/jsonapplication/x-www-form-urlencoded

expires_at · string<date-time> | null

The ISO 8601 formatted date representing the expiration of the credential.

Response

201

application/json

Credential successfully updated.

id · string · default: cred_1m7sfABoNTTKYwTQ8qt6tX

ID of the credential. Generated on creation.

name · string · default: ""

The name given to the credential by the user.

kid · string · default: IZSSTECp...

The key identifier of the credential, generated on creation.

alg · enum<string> · default: RS256

Algorithm which will be used with the credential. Supported algorithms: RS256,RS384,PS256

Available options: RS256, RS384, PS256

credential_type · enum<string>

The type of credential.

Available options: public_key, cert_subject_dn, x509_cert

subject_dn · string

The X509 certificate's Subject Distinguished Name

thumbprint_sha256 · string

The X509 certificate's SHA256 thumbprint

created_at · string<date-time>

The ISO 8601 formatted date the credential was created.

updated_at · string<date-time>

The ISO 8601 formatted date the credential was updated.

expires_at · string<date-time>

The ISO 8601 formatted date representing the expiration of the credential.