デバイス認証情報を作成

指定した user_id のリフレッシュトークンローテーションを管理するための、デバイス認証情報の公開鍵を作成します。Device Credentials API はアドホックな管理用途のみを想定しており、GET リクエストではデフォルトでページングが有効です。

リフレッシュトークンローテーションが有効な場合、このエンドポイントは一貫性のある動作になります。詳細については、署名鍵を参照してください。

POST https://{tenantDomain}/api/v2/device-credentials

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.CreatePublicKeyDeviceCredentialRequestContent{
        DeviceName: "device_name",
        Type: management.DeviceCredentialPublicKeyTypeEnum(
            "public_key",
        ),
        Value: "value",
        DeviceId: "device_id",
    }
    client.DeviceCredentials.CreatePublicKey(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.deviceCredentials.createPublicKey({
        deviceName: "device_name",
        type: "public_key",
        value: "value",
        deviceId: "device_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.deviceCredentials.createPublicKey({
        deviceName: "device_name",
        type: "public_key",
        value: "value",
        deviceId: "device_id",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/device-credentials \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "device_id": "<string>",
  "device_name": "<string>",
  "type": "public_key",
  "value": "<string>",
  "client_id": "<string>"
}
'

import requests

url = "https://{tenantDomain}/api/v2/device-credentials"

payload = {
    "device_id": "<string>",
    "device_name": "<string>",
    "type": "public_key",
    "value": "<string>",
    "client_id": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/device-credentials",
  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([
    'device_id' => '<string>',
    'device_name' => '<string>',
    'type' => 'public_key',
    'value' => '<string>',
    'client_id' => '<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.post("https://{tenantDomain}/api/v2/device-credentials")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"device_id\": \"<string>\",\n  \"device_name\": \"<string>\",\n  \"type\": \"public_key\",\n  \"value\": \"<string>\",\n  \"client_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/device-credentials")

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  \"device_id\": \"<string>\",\n  \"device_name\": \"<string>\",\n  \"type\": \"public_key\",\n  \"value\": \"<string>\",\n  \"client_id\": \"<string>\"\n}"

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

201

{
  "id": "dcr_0000000000000001"
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

ボディ

application/jsonapplication/x-www-form-urlencoded

device_id · string · 必須

デバイスの一意の識別子。AndroidではAndroid_ID、iOSではidentifierForVendorの使用を推奨します。

Maximum string length: 36

Pattern: ^[-A-Fa-f0-9]+$

device_name · string · 必須

所有者が簡単に認識できる、このデバイスの名前。

Minimum string length: 1

type · enum<string> · 必須

認証情報の種類。public_key である必要があります。

利用可能なオプション: public_key

value · string · 必須

認証情報を含むBase64エンコード文字列。

Minimum string length: 1

client_id · string<client-id>

この認証情報の対象であるクライアント（アプリケーション）の client_id。

レスポンス

201

application/json

デバイス認証情報が正常に作成されました。

id · string · デフォルト: dcr_0000000000000001 · 必須

この認証情報の識別子