OpenAPI で認証を取得する

Last updated on February 4, 2026

注釈：本資料はAI技術を用いて翻訳されています。

概要​

OpenAPI は、API の設計とドキュメント作成を支援することで API 開発を簡素化するツールセットです。AccelByte は OpenAPI を使用して AccelByte Gaming Services (AGS) の API エンドポイント を開発および管理しています。AGS OpenAPI を呼び出すためのアクセスを取得するには、まず AGS OAuth API を通じてアクセストークンを作成して認証を取得する 必要があります。

AGS OAuth API には 2 種類の アクセストークン があります：

  1. ユーザートークン：ユーザーに付与されるアクセストークン。その権限レベルは、割り当てられたユーザーロールに依存します。
  2. クライアントトークン：Confidential IAM Client タイプに付与されるアクセストークン。その権限レベルは、それに割り当てられた権限に依存します。主に AGS の管理エンドポイントへのサーバー間 (S2S) 呼び出しに使用されます。

ユーザーロールと IAM クライアントの違いの詳細については、認証 セクションを参照してください。

このガイドでは、これら 2 つのトークンタイプについて、API Explorer または Curl を使用してアクセストークンを作成する方法を説明します。

ユーザートークンタイプ​

前提条件​

  • この OAuth 承認フローには Client ID（Confidential Client タイプを使用する場合は Client Secret も）が必要なため、IAM Client を準備する必要があります。Public Client タイプの使用を推奨します。

API Explorer を使用してユーザーアクセストークンを作成する​

API Explorer を使用して認証を取得するには、以下の手順に従ってください。

  1. AGS Token API にアクセスします。

  2. 画面右上の Authorize ボタンをクリックします。

  3. Basic authorization の下で、Username フィールドに Client ID を貼り付けます。

  4. Confidential Client タイプを使用する場合は、Password フィールドに Client Secret を貼り付けます。Public Client タイプを使用する場合は、Password フィールドにランダムな文字列を入力してから削除します。Authorize をクリックします。

    注記

    Public Client タイプを使用する場合は、Authorize を押す前に Password に何か入力してから削除する必要があります。そうしないと、OpenAPI はパスワードを空文字列ではなく undefined として扱い、ログインできなくなります。

  5. Try it out をクリックし、以下を実行します：

    • Grant Type で password を選択します。
    • User Name と Password に、AGS Admin Portal のユーザー名とパスワードを入力します。

    完了したら、Execute をクリックします。必要なアクセストークンがサーバーレスポンスで返されます。

    Example image of an access token string

  6. Response ボディの内容を "access_token" から始めてコピーします。上の画像のように、これは長い文字列になります。

  7. 右上の Authorize をクリックして、認証ウィンドウに戻ります。

  8. authorization (apiKey) セクションで、すべて大文字で BEARER という単語を入力し、その後にスペースを 1 つ入れます。次に、アクセストークンを貼り付けて Authorize をクリックします。

  9. Close をクリックします。これで API エンドポイントをテストできます。

Curl を使用してユーザーアクセストークンを作成する​

Curl を使用する場合は、以下のコードを使用して OpenAPI のアクセストークンを取得することもできます。

curl -X 'POST' \
  '<<base_url>>/iam/v3/oauth/token' \
  -H 'accept: application/json' \
  -H 'authorization: Basic <<client_credential>>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=password&username=<<username>>&password=<<password>>'

上記のコードをコマンドプロンプトに入力します：

  • <<base_url>> をベース URL に置き換えます。
  • <<client_credential>> を base64 エンコーディングで client_id:client_secret の形式の IAM Client に置き換えます。
  • <<username>> をユーザー名に置き換えます。
  • <<password>> をパスワードに置き換えます。

完了したら、Enter を押します。

ユーザーアクセストークンのレスポンス​

以下は、ユーザーアクセストークンリクエストが成功した場合のレスポンス例です：

{
  "access_token": "string",
  "bans": [
    {
      "ban": "string",
      "disabledDate": "2022-09-01T03:19:32.816Z",
      "enabled": true,
      "endDate": "2022-09-01T03:19:32.816Z",
      "targetedNamespace": "string"
    }
  ],
  "display_name": "string",
  "expires_in": 0,
  "is_comply": true,
  "jflgs": 0,
  "namespace": "string",
  "namespace_roles": [
    {
      "namespace": "string",
      "roleId": "string"
    }
  ],
  "refresh_expires_in": 0,
  "refresh_token": "string",
  "scope": "string",
  "token_type": "string",
  "user_id": "string"
}
ヒント

レスポンスから access_token の値をコピーし、API Explorer の手順 セクションの手順 8 のように、BEARER という単語を前に付けて OpenAPI に貼り付けることができます。

クライアントトークンタイプ​

前提条件​

  • この OAuth 承認フローには Client ID と Client Secret が必要なため、Confidential IAM Client を準備する必要があります。

API Explorer を使用してクライアントアクセストークンを作成する​

API Explorer を使用して認証を取得するには、以下の手順に従ってください。

  1. AGS Token API にアクセスします。

  2. 画面右上の Authorize ボタンをクリックします。

  3. Basic authorization の下で、Username フィールドに Client ID を、Password フィールドに Client Secret を貼り付けます。

  4. Try it out をクリックし、Grant Type を client_credentials に設定します。

    完了したら、Execute をクリックします。必要なアクセストークンがサーバーレスポンスで返されます。

    Example image of an access token string

  5. Response ボディの内容を "access_token" から始めてコピーします。上の画像のように、これは長い文字列になります。

  6. 右上の Authorize をクリックして、認証ウィンドウに戻ります。

  7. authorization (apiKey) セクションで、すべて大文字で BEARER という単語を入力し、その後にスペースを 1 つ入れます。次に、アクセストークンを貼り付けて Authorize をクリックします。

  8. Close をクリックします。これで API エンドポイントをテストできます。

Curl を使用してクライアントアクセストークンを作成する​

Curl を使用する場合は、以下のコードを使用して OpenAPI のアクセストークンを取得することもできます。

curl -X 'POST' \
  '<<base_url>>/iam/v3/oauth/token' \
  -H 'accept: application/json' \
  -H 'authorization: Basic <<client_credential>>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'grant_type=client_credential'

上記のコードをコマンドプロンプトに入力します：

  • <<base_url>> をベース URL に置き換えます。
  • <<client_credential>> を base64 エンコーディングで client_id:client_secret の形式の IAM Client に置き換えます。

完了したら、Enter を押します。

クライアントアクセストークンのレスポンス​

以下は、クライアントアクセストークンリクエストが成功した場合のレスポンス例です：

{
  "access_token": "string",
  "expires_in": 0,
  "is_comply": true,
  "namespace": "string",
  "scope": "string",
  "token_type": "string"
}
ヒント

レスポンスから access_token の値をコピーし、API Explorer の手順 セクションの手順 7 のように、BEARER という単語を前に付けて OpenAPI に貼り付けることができます。

に最終更新
On this page