API版

API版は、WebAPIを通してFIDO認証を実施する形態です。

PKaaSの認証画面が表示されないので、IdPの認証時の画面のみを表示したい方に便利な利用方法です。API版を利用する場合には、下記の開発が必要です。

• IdPの認証画面へJavaScriptを配置
• JavaScriptが呼び出すWebAuthnのエンドポイントおよびPKaaS APIの呼び出し

リダイレクト版

リダイレクト版は利用者のIdPの認証画面がPKaaSの認証画面にリダイレクトし、FIDO認証を実施する利用方法です。

FIDO認証用の画面を用意しないIdPにおすすめの使い方です。

現在リダイレクト版に関してはどなたにもご利用いただけません。

やさい大学のデモで挙動をご確認ください。

共通ヘッダー

これらすべてのAPIリクエストには下記のヘッダーを付与してください。

パラメータ	必須	値	説明
User-agent	◯	string	"Yahoo-AppID:"に続けて、前の手続きで取得したClientIDを入力してください。
origin	◯	string	前の手順にて申請済みの開発者サイトのドメインを入力してください。

登録のチャレンジ生成

リクエストURL

https://pkaas.yahooapis.jp/api/attestation/options

メソッド

POST

Content-Type

application/json

リクエストパラメータ

"appid"以外については、標準的なブラウザの実装により対応状況が異なります。MDNなどを参考にしてください。

サンプルリクエスト

curl 'https://pkaas.yahooapis.jp/api/attestation/options' \
  -H "Content-Type: application/json" \
  -H "User-agent: Yahoo-AppID:<Client ID>" \
  -H "Origin: <YOUR DOMAIN>" \
  --data-raw '{"username":"sample1234#example.com","displayName":"sample1234#example.com","authenticatorSelection":{"requireResidentKey":true,"userVerification":"preferred","authenticatorAttachment":"platform"},"attestation":"none"}'

レスポンスパラメータ

エラー時のレスポンスはYahoo!デベロッパーネットワークのエラーメッセージもしくは、LINE FIDO2 serverのエラーメッセージに準じます。

サンプルレスポンス

{
    "status": "ok",
    "errorMessage": "",
    "sessionId": "",
    "rp": {
        "name": "PKaaS Demo",
        "icon": "",
        "id": "example.com"
    },
    "user": {
        "name": "sample1234#example.com",
        "icon": "",
        "id": "n99PZyE5b_muRkeyRUyvCgg4XsXg5YA816PVVO0UqBI",
        "displayName": "sample1234#example.com"
    },
    "challenge": "PTlwETmKOkcS1m3__3__1LDf1kWX8OZIZCZYSqdWzoJRWUAkvRb9velN98Wvdgd0VwNCwBpX_-UKEA3Fv4dRRA",
    "pubKeyCredParams": [
        {
            "type": "public-key",
            "alg": -65535
        },
        {
            "type": "public-key",
            "alg": -257
        }
        // ... (その他のパラメータ)
    ],
    "timeout": 180000,
    "excludeCredentials": [],
    "authenticatorSelection": {
        "authenticatorAttachment": "platform",
        "requireResidentKey": true,
        "userVerification": "preferred"
    },
    "attestation": "none",
    "extensions": {
        "credProps": true
    }
}

登録の署名検証

リクエストURL

https://pkaas.yahooapis.jp/api/attestation/result

メソッド

POST

Content-Type

application/json

リクエストパラメータ

"appid"以外については、標準的なブラウザの実装により対応状況が異なります。MDNなどを参考にしてください。

サンプルリクエスト

curl 'https://pkaas.yahooapis.jp/api/attestation/result' \
  -H "Content-Type: application/json" \
  -H "User-agent: Yahoo-AppID:<Client ID>" \
  -H "Origin: <YOUR DOMAIN>" \
  --data-raw '{"rawId":"sampleSample","id":"sampleSample","response":{"clientDataJSON":"eyJ....","transports":["hybrid","internal"]},"type":"public-key","extensions":{"credProps":{"rk":true}}}'

レスポンスパラメータ

サンプルレスポンス

{"status":"ok","errorMessage":"","sessionId":""}

認証のチャレンジ発行

リクエストURL

https://pkaas.yahooapis.jp/api/assertion/options

メソッド

POST

Content-Type

application/json

リクエストパラメータ

標準的なブラウザの実装により対応状況が異なります。MDNなどを参考にしてください。

サンプルリクエスト

curl 'http://localhost:8888/assertion/options' \
  -H "Content-Type: application/json" \
  -H "User-agent: Yahoo-AppID:<Client ID>" \
  -H "Origin: <YOUR DOMAIN>" \
  --data-raw '{"username":"sample1234#example.com","userVerification":"preferred"}'

レスポンスパラメータ

サンプルレスポンス

{
    "status": "ok",
    "errorMessage": "",
    "sessionId": "",
    "challenge": "ssSafaXDbmLDxtQnFPALcUYWDdOT180yOoay-P0EdeDVj6uKvo28chUZOU2fLc_7LJK1wlj-ebg02iRQQPgVtw",
    "timeout": 180000,
    "rpId": "example.com",
    "allowCredentials": [
        {
            "type": "public-key",
            "id": "ugHWbvJQEDUeqLzA5wZqO6KEnT-lRLtMHbLbboNIDDc",
            "transports": [
                "internal"
            ]
        }
    ],
    "userVerification": "preferred",
    "extensions": {}
}

認証の署名検証

リクエストURL

https://pkaas.yahooapis.jp/api/assertion/result

メソッド

POST

Content-Type

application/json

リクエストパラメータ

標準的なブラウザの実装により対応状況が異なります。MDNなどを参考にしてください。

サンプルリクエスト

curl 'https://pkaas.yahooapis.jp/api/assertion/result' \
  -H "Content-Type: application/json" \
  -H "User-agent: Yahoo-AppID:<Client ID>" \
  -H "Origin: <YOUR DOMAIN>" \
  --data-raw '{"rawId":"sampleSample","id":"sampleSample","response":{"clientDataJSON":"eyJ...","signature":"...","authenticatorData":"..."},"type":"public-key","extensions":{}}'

レスポンスパラメータ

サンプルレスポンス

{"status":"ok","errorMessage":"","sessionId":""}