Enregistrer une clé de connexion de consentement

curl --request POST \
  --url https://{host}/me/v1/consent-signing-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jwk": {
    "kty": "EC",
    "crv": "P-256",
    "alg": "ES256",
    "use": "sig",
    "x": "<string>",
    "y": "<string>"
  },
  "device_identifier": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://{host}/me/v1/consent-signing-keys"

payload = {
    "jwk": {
        "kty": "EC",
        "crv": "P-256",
        "alg": "ES256",
        "use": "sig",
        "x": "<string>",
        "y": "<string>"
    },
    "device_identifier": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    jwk: {
      kty: 'EC',
      crv: 'P-256',
      alg: 'ES256',
      use: 'sig',
      x: '<string>',
      y: '<string>'
    },
    device_identifier: '<string>',
    expires_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://{host}/me/v1/consent-signing-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/me/v1/consent-signing-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'jwk' => [
        'kty' => 'EC',
        'crv' => 'P-256',
        'alg' => 'ES256',
        'use' => 'sig',
        'x' => '<string>',
        'y' => '<string>'
    ],
    'device_identifier' => '<string>',
    'expires_at' => '2023-11-07T05:31:56Z'
  ]),
  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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/me/v1/consent-signing-keys"

	payload := strings.NewReader("{\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"alg\": \"ES256\",\n    \"use\": \"sig\",\n    \"x\": \"<string>\",\n    \"y\": \"<string>\"\n  },\n  \"device_identifier\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/me/v1/consent-signing-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"alg\": \"ES256\",\n    \"use\": \"sig\",\n    \"x\": \"<string>\",\n    \"y\": \"<string>\"\n  },\n  \"device_identifier\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/me/v1/consent-signing-keys")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"alg\": \"ES256\",\n    \"use\": \"sig\",\n    \"x\": \"<string>\",\n    \"y\": \"<string>\"\n  },\n  \"device_identifier\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "kid": "csk_72jbvv7LfRKYp59gtRLtkn",
  "jwk": {
    "kty": "EC",
    "crv": "P-256",
    "alg": "ES256",
    "use": "sig",
    "x": "<string>",
    "y": "<string>",
    "kid": "<string>"
  },
  "device_identifier": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

POST

https://{host}/me/v1

consent-signing-keys

Enregistrer une clé de connexion de consentement

curl --request POST \
  --url https://{host}/me/v1/consent-signing-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "jwk": {
    "kty": "EC",
    "crv": "P-256",
    "alg": "ES256",
    "use": "sig",
    "x": "<string>",
    "y": "<string>"
  },
  "device_identifier": "<string>",
  "expires_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://{host}/me/v1/consent-signing-keys"

payload = {
    "jwk": {
        "kty": "EC",
        "crv": "P-256",
        "alg": "ES256",
        "use": "sig",
        "x": "<string>",
        "y": "<string>"
    },
    "device_identifier": "<string>",
    "expires_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    jwk: {
      kty: 'EC',
      crv: 'P-256',
      alg: 'ES256',
      use: 'sig',
      x: '<string>',
      y: '<string>'
    },
    device_identifier: '<string>',
    expires_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://{host}/me/v1/consent-signing-keys', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/me/v1/consent-signing-keys",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'jwk' => [
        'kty' => 'EC',
        'crv' => 'P-256',
        'alg' => 'ES256',
        'use' => 'sig',
        'x' => '<string>',
        'y' => '<string>'
    ],
    'device_identifier' => '<string>',
    'expires_at' => '2023-11-07T05:31:56Z'
  ]),
  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;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/me/v1/consent-signing-keys"

	payload := strings.NewReader("{\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"alg\": \"ES256\",\n    \"use\": \"sig\",\n    \"x\": \"<string>\",\n    \"y\": \"<string>\"\n  },\n  \"device_identifier\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/me/v1/consent-signing-keys")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"alg\": \"ES256\",\n    \"use\": \"sig\",\n    \"x\": \"<string>\",\n    \"y\": \"<string>\"\n  },\n  \"device_identifier\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/me/v1/consent-signing-keys")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"jwk\": {\n    \"kty\": \"EC\",\n    \"crv\": \"P-256\",\n    \"alg\": \"ES256\",\n    \"use\": \"sig\",\n    \"x\": \"<string>\",\n    \"y\": \"<string>\"\n  },\n  \"device_identifier\": \"<string>\",\n  \"expires_at\": \"2023-11-07T05:31:56Z\"\n}"

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

{
  "kid": "csk_72jbvv7LfRKYp59gtRLtkn",
  "jwk": {
    "kty": "EC",
    "crv": "P-256",
    "alg": "ES256",
    "use": "sig",
    "x": "<string>",
    "y": "<string>",
    "kid": "<string>"
  },
  "device_identifier": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "expires_at": "2023-11-07T05:31:56Z"
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

{
  "type": "<string>",
  "status": 123,
  "title": "<string>",
  "detail": "<string>",
  "validation_errors": [
    {
      "detail": "<string>",
      "field": "<string>",
      "pointer": "<string>",
      "source": "<string>"
    }
  ]
}

Autorisations

Authorization

string

header

requis

Les jetons Bearer et DPoP sont pris en charge selon la configuration de l’API

Scopes

create:me:consent_signing_keys

Corps

application/json

Corps de la requête d’enregistrement d’une clé de connexion de consentement.

jwk

ec · object

requis

Une JWK ECDSA P-256 publique à enregistrer pour signer les décisions de consentement. Le matériel de clé privée ne doit jamais être fourni. L’identifiant de la clé est attribué par Auth0 et ne doit pas être fourni.

Show child attributes

device_identifier

string

requis

Une étiquette lisible par l’utilisateur pour l’appareil qui détient la clé privée correspondante. Il s’agit uniquement d’une étiquette et non d’une garantie que la clé est liée à cet appareil.

Required string length: 1 - 128

expires_at

string<date-time>

Date à laquelle la clé doit expirer. Facultatif ; la durée de vie maximale par défaut est de 2 ans. Cette date doit être située à au moins 1 heure dans l’avenir et ne pas dépasser la valeur par défaut.

Réponse

Clé de connexion de consentement enregistrée avec succès

Une clé de connexion de consentement enregistrée par l’utilisateur authentifié.

kid

string

requis

L’identifiant unique de la clé de connexion enregistrée. Fournissez-le lorsque vous signez une décision de consentement afin que la signature puisse être vérifiée à l’aide de cette clé.

Exemple:

"csk_72jbvv7LfRKYp59gtRLtkn"

jwk

ec · object

requis

Une JWK ECDSA P-256 publique enregistrée, utilisée pour signer les décisions de consentement. Le matériel de clé privée n’est jamais stocké ni renvoyé.

Show child attributes

device_identifier

string

requis

L’étiquette lisible par l’utilisateur de l’appareil contenant la clé privée correspondante.

created_at

string<date-time>

requis

La date et l’heure auxquelles la clé de connexion a été enregistrée.

expires_at

string<date-time>

requis

La date et l’heure d’expiration de la clé de connexion. Après cette date, la clé ne peut plus servir à signer des décisions de consentement et doit être remplacée.