同意の署名鍵を登録する
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
同意の署名鍵を登録する
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>"
}
]
}承認
Bearer トークンと DPoP トークンは、API の設定に応じてサポートされます
Scopes
create:me:consent_signing_keys
ボディ
application/json
同意署名鍵を登録するためのリクエスト本文。
同意決定への署名用に登録する公開ECDSA P-256 JWK。秘密鍵の情報を指定してはなりません。鍵識別子はAuth0によって割り当てられるため、指定してはなりません。
- ec
- rsa
Show child attributes
Show child attributes
対応する秘密鍵を保持するデバイスの人が判読できるラベル。これは単なるラベルであり、鍵がそのデバイスに紐付いていることを保証するものではありません。
Required string length:
1 - 128鍵の有効期限日時。任意で、省略時は最長の2年間になります。現在から少なくとも1時間後であり、デフォルトの有効期限を超えない必要があります。
レスポンス
同意署名鍵が正常に登録されました
認証済みユーザーが登録した同意署名鍵。
登録済み署名鍵の一意の識別子。同意決定に署名する際にこれを指定すると、この鍵を使用して署名を検証できます。
例:
"csk_72jbvv7LfRKYp59gtRLtkn"
同意決定への署名に使用される、登録済みの公開ECDSA P-256 JWK。秘密鍵の情報が保存または返却されることはありません。
- ec
- rsa
Show child attributes
Show child attributes
対応する秘密鍵を保持するデバイスの人が判読できるラベル。
署名鍵が登録された日時。
署名鍵の有効期限日時。この時点以降、この鍵は同意決定への署名には使用できなくなり、置き換える必要があります。