Get a consent signing key by key ID

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.getConsentSigningKey("id", "kid");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.getConsentSigningKey("id", "kid");
}
main();

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    mgmt.Users.GetConsentSigningKey(
        context.TODO(),
        "id",
        "kid",
    )
}

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

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.Users.GetConsentSigningKeyAsync(
            "id",
            "kid"
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.users().getConsentSigningKey("id", "kid");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->getConsentSigningKey(
    'id',
    'kid',
);

{
  "kid": "<string>",
  "device_identifier": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "statusCode": 400,
  "error": "Bad Request"
}

{
  "message": "<string>",
  "statusCode": 401,
  "error": "Unauthorized"
}

{
  "message": "<string>",
  "statusCode": 403,
  "error": "Forbidden"
}

{
  "message": "<string>",
  "statusCode": 404,
  "error": "Not Found"
}

{
  "message": "<string>",
  "statusCode": 429,
  "error": "Too Many Requests"
}

GET

https://{tenantDomain}/api/v2

users

{id}

consent-signing-keys

{kid}

TypeScript

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.getConsentSigningKey("id", "kid");
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.users.getConsentSigningKey("id", "kid");
}
main();

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    mgmt.Users.GetConsentSigningKey(
        context.TODO(),
        "id",
        "kid",
    )
}

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

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.Users.GetConsentSigningKeyAsync(
            "id",
            "kid"
        );
    }

}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;

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

        client.users().getConsentSigningKey("id", "kid");
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->users->getConsentSigningKey(
    'id',
    'kid',
);

{
  "kid": "<string>",
  "device_identifier": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>",
  "statusCode": 400,
  "error": "Bad Request"
}

{
  "message": "<string>",
  "statusCode": 401,
  "error": "Unauthorized"
}

{
  "message": "<string>",
  "statusCode": 403,
  "error": "Forbidden"
}

{
  "message": "<string>",
  "statusCode": 404,
  "error": "Not Found"
}

{
  "message": "<string>",
  "statusCode": 429,
  "error": "Too Many Requests"
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string<user-id>

required

The ID of the user.

kid

string

required

The key identifier of the consent signing key.

Response

The consent signing key was returned.

kid

string

required

The key identifier of the consent signing key.

device_identifier

string

required

A human-readable label for the device holding the corresponding private key.

created_at

string<date-time>

required

The ISO 8601 timestamp at which the key was registered.

expires_at

string<date-time>

required

The ISO 8601 timestamp at which the key expires and can no longer be used to verify consent decisions.