> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 接続ユーザーの ID を取得

> OAuth 接続に付与された ID クレームを取得します。

OAuth 接続に付与された ID クレームを取得します。

```http theme={null}
GET https://api.voicecheap.ai/oauth/userinfo
```

## 認証

OAuth アクセストークンを Authorization: Bearer で送信してください。トークンには openid が必要です。メールのクレームには email も必要です。API キーとクエリ文字列の認証情報は受け付けられません。

## リクエスト例

このルートに記載されたエンコード方式と認証方法に従ってください。アクション API のエンベロープと冪等性のルールは、アクションの呼び出しにのみ適用されます。

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET 'https://api.voicecheap.ai/oauth/userinfo' \
    --header "Authorization: Bearer $VOICECHEAP_ACCESS_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const input = {};
  const response = await fetch('https://api.voicecheap.ai/oauth/userinfo', {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${process.env.VOICECHEAP_ACCESS_TOKEN}`,
    },
    redirect: 'manual',
  });
  console.log(response.status, await response.text());
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.request(
      "GET",
      "https://api.voicecheap.ai/oauth/userinfo",
      headers={"Authorization":"Bearer " + os.environ["VOICECHEAP_ACCESS_TOKEN"]},
      timeout=120,
      allow_redirects=False,
  )
  print(response.status_code, response.text)
  ```
</RequestExample>

## レスポンス

OAuth 接続に付与された ID クレームを取得します。

```json HTTP 200 theme={null}
{
  "sub": "voicecheap-user-id",
  "email": "customer@example.com",
  "email_verified": false
}
```

## レスポンスヘッダー

```json theme={null}
{
  "Cache-Control": "no-store",
  "Pragma": "no-cache"
}
```

## 操作の注意事項

* この環境で ID 連携が利用できない場合、OpenID Connect エンドポイントは HTTP 404 を返します。ID 機能を利用する前に検出情報を確認してください。
* sub はアカウントの安定した識別子です。email と email\_verified は、email が付与され、アカウントにメールアドレスがある場合のみ含まれます。email\_verified は実際の確認状態を反映し、false の場合もあります。削除済みまたは無効化されたアカウントでは UserInfo を利用できません。

## エラー

| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `invalid_request` | OAuth アクセストークンは Authorization ヘッダーでのみ送信してください。API キーと、クエリまたはボディの access\_token/api\_key 認証情報は拒否されます。 |
| 401 | `invalid_token` | OAuth アクセストークンが存在しない、無効、有効期限切れ、失効済み、または認可されていません。アカウントを再接続してください。 |
| 403 | `insufficient_scope` | トークンに openid がないか、アカウントが利用条件を満たさなくなりました。必要な ID 権限と利用可能なアカウントで再接続してください。詳細は WWW-Authenticate チャレンジを確認してください。 |
| 404 | `invalid_request` | この環境で ID 連携が利用できない場合、OpenID Connect エンドポイントは HTTP 404 を返します。ID 機能を利用する前に検出情報を確認してください。 |
| 429 | `temporarily_unavailable` | 公開 OAuth リクエストのレート上限に達しました。現在の制限期間が終わってから再試行してください。 |
| 500 | `server_error` | 認可を一時的に利用できません。後で再試行してください。 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.