Create or replace custom signing keys

Create or replace entire jwks representation of custom signing keys.

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

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &keys.SetCustomSigningKeysRequestContent{
        Keys: []*management.CustomSigningKeyJwk{
            &management.CustomSigningKeyJwk{
                Kty: management.CustomSigningKeyTypeEnumEc,
            },
        },
    }
    client.Keys.CustomSigning.Set(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

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

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        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>"
    }
  ]
}
'

import requests

url = "https://{tenantDomain}/api/v2/keys/custom-signing"

payload = { "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>"
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/keys/custom-signing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.put("https://{tenantDomain}/api/v2/keys/custom-signing")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"keys\": [\n    {\n      \"kid\": \"<string>\",\n      \"use\": \"sig\",\n      \"key_ops\": [\n        \"verify\"\n      ],\n      \"n\": \"<string>\",\n      \"e\": \"<string>\",\n      \"x\": \"<string>\",\n      \"y\": \"<string>\",\n      \"x5u\": \"<string>\",\n      \"x5c\": [\n        \"<string>\"\n      ],\n      \"x5t\": \"<string>\",\n      \"x5t#S256\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/keys/custom-signing")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"keys\": [\n    {\n      \"kid\": \"<string>\",\n      \"use\": \"sig\",\n      \"key_ops\": [\n        \"verify\"\n      ],\n      \"n\": \"<string>\",\n      \"e\": \"<string>\",\n      \"x\": \"<string>\",\n      \"y\": \"<string>\",\n      \"x5u\": \"<string>\",\n      \"x5c\": [\n        \"<string>\"\n      ],\n      \"x5t\": \"<string>\",\n      \"x5t#S256\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

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