APIの概要

xID Lite APIは、クライアント認証方式としてプライベートキーJWT (Private Key JWT) (private_key_jwt) を用いたOAuth 2.0 クライアントクレデンシャルフローを使用します。

バックエンドは、クライアントシークレットではなく、署名されたJWTアサーションによる認証を行うことで、短期間有効なアクセストークンを取得します。プライベートキー（秘密鍵）がインフラストラクチャの外部に出ることは決してなく、xIDが必要とするのはパブリックキー（公開鍵）のみです。

以下の手順でOnetimeCFJPKI APIの利用を開始することができます。

利用手順

非対称キーペアの生成とJWKセット（公開鍵）を用意する

当社に問い合わせのうえ、認可クライアントを発行する

検証環境を用意する

JWTアサーションを構築・署名し、アクセストークンを取得する

アクセストークンを使って任意のAPIリクエストを送信する

認可クライアント取得後、実際にトークンエンドポイントにJWTアサーションを送信してアクセストークンを取得し、各エンドポイントにリクエストを送ることができます。

ヒント

プライベートキーは安全に保管してください。
プライベートキーは安全に保管してください。シークレットマネージャー（AWS Secrets Manager, HashiCorp Vault, GCP Secret Managerなど）を使用してください。プライベートキーをソース管理（バージョン管理）にコミットしてはいけません。

サービス概要

統合を開始する前に、登録時に以下の情報をxIDに提供し、認証のセットアップを行う必要があります。

client_id: xIDと合意したシステムの固有識別子（例: testClient）

jwks_uri: JWKセット（公開鍵）がホストされているHTTPS URL

scope: 常に cfjpki を指定

署名アルゴリズム: JWTアサーションの署名に使用するアルゴリズム（例: RS256, ES256 など）

登録確認後、xIDより「トークンエンドポイントのURL」および「APIのベースURL」が提供されます。

Authentication

OAuth 2.0: OAuth2

OAuth 2.0 クライアントクレデンシャルフローを実施し、各APIへのリクエストに必要な access_token を取得します。認証方式には private_key_jwt を使用します。

項目	内容
Security Scheme Type	oauth2
OAuth Flow (clientCredentials)	Token URL: `https://hydra.x-id.io/oauth2/token` Client Authentication Method: `private_key_jwt` Scopes: • `onetimecfjpki`: OnetimeCFJPKI API

HTTP: Bearer Auth

取得したアクセストークンは、すべてのOnetimeCFJPKI API呼び出しにおいて Bearer トークンとして使用されます。

項目	内容
Security Scheme Type	http
HTTP Authorization Scheme	bearer
Bearer format	JWT

利用手順#

サービス概要#

Authentication#

OAuth 2.0: OAuth2#

HTTP: Bearer Auth#

利用手順

サービス概要

Authentication

OAuth 2.0: OAuth2

HTTP: Bearer Auth