Create or replace custom signing keys

Create or replace entire jwks representation of custom signing keys.

PUT https://{tenantDomain}/api/v2/keys/custom-signing

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Keys;
using System.Collections.Generic;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Keys.CustomSigning.SetAsync(
            new SetCustomSigningKeysRequestContent {
                Keys = new List<CustomSigningKeyJwk>(){
                    new CustomSigningKeyJwk {
                        Kty = CustomSigningKeyTypeEnum.Ec
                    },
                }

            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &keys.SetCustomSigningKeysRequestContent{
        Keys: []*management.CustomSigningKeyJwk{
            &management.CustomSigningKeyJwk{
                Kty: management.CustomSigningKeyTypeEnumEc,
            },
        },
    }
    mgmt.Keys.CustomSigning.Set(
        context.TODO(),
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.keys.types.SetCustomSigningKeysRequestContent;
import com.auth0.client.mgmt.types.CustomSigningKeyJwk;
import com.auth0.client.mgmt.types.CustomSigningKeyTypeEnum;
import java.util.Arrays;

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

        client.keys().customSigning().set(
            SetCustomSigningKeysRequestContent
                .builder()
                .keys(
                    Arrays.asList(
                        CustomSigningKeyJwk
                            .builder()
                            .kty(CustomSigningKeyTypeEnum.EC)
                            .build()
                    )
                )
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Keys\CustomSigning\Requests\SetCustomSigningKeysRequestContent;
use Auth0\SDK\API\Management\Types\CustomSigningKeyJwk;
use Auth0\SDK\API\Management\Types\CustomSigningKeyTypeEnum;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->keys->customSigning->set(
    new SetCustomSigningKeysRequestContent([
        'keys' => [
            new CustomSigningKeyJwk([
                'kty' => CustomSigningKeyTypeEnum::Ec->value,
            ]),
        ],
    ]),
);

from auth0.management import ManagementClient, CustomSigningKeyJwk

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.keys.custom_signing.set(
    keys=[
        CustomSigningKeyJwk(
            kty="EC",
        )
    ],
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.keys.custom_signing.set(keys: [{
  kty: "EC"
}])

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.keys.customSigning.set({
        keys: [
            {
                kty: "EC",
            },
        ],
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.keys.customSigning.set({
        keys: [
            {
                kty: "EC",
            },
        ],
    });
}
main();

curl --request PUT \
  --url https://{tenantDomain}/api/v2/keys/custom-signing \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keys": [
    {
      "kid": "<string>",
      "use": "sig",
      "key_ops": [
        "verify"
      ],
      "n": "<string>",
      "e": "<string>",
      "x": "<string>",
      "y": "<string>",
      "x5u": "<string>",
      "x5c": [
        "<string>"
      ],
      "x5t": "<string>",
      "x5t#S256": "<string>"
    }
  ]
}
'

200

{
  "keys": [
    {
      "kid": "<string>",
      "use": "sig",
      "key_ops": [
        "verify"
      ],
      "n": "<string>",
      "e": "<string>",
      "x": "<string>",
      "y": "<string>",
      "x5u": "<string>",
      "x5c": [
        "<string>"
      ],
      "x5t": "<string>",
      "x5t#S256": "<string>"
    }
  ]
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Body

application/jsonapplication/x-www-form-urlencoded

JWKS representing an array of custom public signing keys.

keys · object[] · required

An array of custom public signing keys.

Minimum array length: 1

Show child attributes

Response

200

application/json

Custom signing keys were successfully created or replaced.

JWKS representing an array of custom public signing keys.

keys · object[]

An array of custom public signing keys.

Show child attributes