API Docs
v6.1.0
  • v5.9.0
  • v6.1.0
ガード
API仕様よくある質問
ガード
API仕様よくある質問
v6.1.0
  • v5.9.0
  • v6.1.0
v6.1.0
  • v5.9.0
  • v6.1.0
  1. APIの利用を開始する
  • xID for Developersへようこそ
  • APIの利用を開始する
    • 利用者情報を暗号化する
    • 認可クライアントを取得する
    • 検証環境を利用する
    • アクセストークンを取得する
    • DEV-Stable環境を利用する
  1. APIの利用を開始する

アクセストークンを取得する

以下のエンドポイントを使うことで、利用者の access_tokenを取得することができます。access_tokenは、xIDの認証・認可を除く全てのAPIへのリクエスト時に必要となります。
Authorization
Token
この記事では、上記2つのAPIを使ってaccess_tokenを取得するまでの流れを説明します。

認証&認可フローを開始する#

以下のリクエストの各種パラメータを置き換えて、ブラウザで呼び出します。実際のリクエストに改行は含めないでください。
https://oidc-uat.x-id.io/oauth2/auth?
client_id={ client_id }&
redirect_uri={ redirect_uri }&
scope={ url encoded scopes }&
response_type=code&
response_mode=query&
state={ state }&
nonce={ nonce }
パラメーター詳細
client_id発行されたクライアント情報に記載されているclient_idです。
redirect_uriクライアント発行時にご指定いただいた redirect_uri です。
url encoded scopesクライアント発行時にご指定いただいた scope です。項目間のスペースはURLエンコードした文字列(%20)に置き換えてください。 例: openid%20verification%20signing
stateリプレイアタック対策を目的に使用するランダムな値です。8文字以上の英数字を指定してください。
nonceCross-Site Request Forgery (CSRF, XSRF) 対策を目的に使用するランダムな値です。8文字以上の英数字を指定してください。
呼び出しが正しく完了すると、xIDの認証画面が表示されます。画面表示に従ってxIDアプリで認証を完了して下さい。
xIDアプリで認証後、当該リクエストを開始したブラウザが認可画面に切り替わりますので、続けて認可を完了してください。

アクセストークンを取得する#

認可が完了すると、redirect_uriに対して、パラメータ付きでリダイレクトされます。パラメータの中の code 値を用いてアクセストークンを獲得します。
まずは、以下のコマンドをお使いのターミナルから実行し、Tokenエンドポイントに対しての認証情報を準備します。{ client_id } および { client_secret } はお手持ちの情報に置き換えてください。
実行結果で得られた、Base64エンコードされた文字列は後述のTokenエンドポイントへのリクエストに使用します。
e2NsaWVudF9pZH06e2NsaWVudF9zZWNyZXR9
続いて、上記実行結果、redirect_uriに付されたパラメータから取得したcodeを用いて、tokenエンドポイントへのリクエストを作成します。

アクセストークンの取得例#

{
  "access_token":  "dq2tO16OayqZAAlVC_xGjScYU5IWbh6SmzqDv9h_ysU.WzY1qpMNgCgUERilWp6Py7cqKuyiwMly3RHCuf9hjq4",
  "expires_in": 604799,
  "id_token": "eyJhbGciOiJSU ...LF1UGNVg",
  "scope": "openid verification signing",
  "token_type": "bearer"
}
ここまでのステップで、access_tokenが獲得できました。
access_tokenをリクエストヘッダ Authorization: Bearer {access_token}として含めることで、各APIエンドポイントの利用が可能になります。
取得したaccess_tokenを使って、Userdataから利用者の個人情報を取得してみましょう。
更新日時 2026-06-05 04:36:24
前へ
検証環境を利用する
次へ
DEV-Stable環境を利用する
Built with