Source: https://ailoot.ai/docs/ja/cabinet/profile/
Canonical: https://ailoot.ai/docs/ja/cabinet/profile/
Language: ja

[ダッシュボードAPI](https://ailoot.ai/docs/ja/) 

# プロフィールとセキュリティ

[Markdown](https://ailoot.ai/docs/ja/cabinet/profile/index.md)

メソッド、リクエストのフィールド、レスポンス。

このセクションには6メソッドがあります。メソッドを開くと、アクセス条件、リクエストのフィールド、レスポンスを確認できます。

| メソッドとパス | 説明 | アクセス |
| --- | --- | --- |
| `PUT /api/v1/user` | プロフィールの変更 | ダッシュボードのトークン |
| `GET /api/v1/user/passkeys` | passkeyの一覧 | ダッシュボードのトークン |
| `PUT /api/v1/user/password` | パスワードの変更 | ダッシュボードのトークン |
| `GET /api/v1/user/profile` | プロフィール、残高、連携情報 | ダッシュボードのトークン |
| `GET /api/v1/user/totp/status` | 2FA（TOTP）の状態 | ダッシュボードのトークン |
| `GET /api/v1/user/totp/verification-method` | TOTPの検証方法 | ダッシュボードのトークン |

**PUT /api/v1/user** — プロフィールの変更

アクセス：ダッシュボードのトークン

PUT`/api/v1/user`

## JSON／フォームのフィールド

| フィールド | タイプ | 必須 | 検証／説明 |
| --- | --- | --- | --- |
| `username` | `string` | いいえ | ；null可 |
| `avatar_url` | `string` | いいえ | ；null可 |
| `balance_notify_enabled` | `boolean` | いいえ | ；null可 |
| `balance_notify_threshold` | `number` | いいえ | ；null可 |

リクエストボディのテンプレート

```json
{
  "username": "PLACEHOLDER_USERNAME (string)",
  "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
  "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
  "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)"
}
```

PLACEHOLDERは、入力する値とその型を示します。値を置き換え、必要な任意フィールドだけを残してください。数値、boolean、オブジェクト、配列の代わりに、文字列のマーカーを送信しないでください。

リクエストのスキーマ：`UpdateProfileRequest`

## レスポンス

JSONレスポンスにはcode、message、dataが含まれます。dataの内容は、以下のスキーマで説明します。

レスポンスのデータスキーマ：`User`, `UserProfileResponse`。フィールドと型は、「データスキーマ」の各ページに記載されています。

レスポンスのスキーマ。値は例示用

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}
```

補足：すべての個人データとオブジェクトは、JWTの主体に限定されます。

補足：この操作は状態を変更するか、一度限りの認証手続きを継続します。例は契約仕様を説明するもので、実行されません。

補足：キーの支出制限（quota、quota\_used）は、プロフィールではなく、キーのレスポンスに含まれます。frozen\_balanceは仮確保中の金額であり、自由に使える残高として扱えません。

このメソッドはデータを変更します。再送が安全なのは、Idempotency-Keyが明示されているメソッドのみです。レスポンスが失われた場合は、先に結果（例：キーの一覧）を確認してから、再送するかを判断してください。

**GET /api/v1/user/passkeys** — passkeyの一覧

アクセス：ダッシュボードのトークン

GET`/api/v1/user/passkeys`

取得。IDは、以前取得したレスポンスの値を使います。

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/user/passkeys" \
  -H "Authorization: Bearer $TOKEN"
```

リクエストボディは不要です。上記のパラメータはURLで渡してください。

## レスポンス

JSONレスポンスにはcode、message、dataが含まれます。dataの内容は、以下のスキーマで説明します。

レスポンスのデータスキーマ：`PasskeyCredentialSummary`。フィールドと型は、「データスキーマ」の各ページに記載されています。

レスポンスのスキーマ。値は例示用

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "name": "PLACEHOLDER_NAME (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "last_used_at": "PLACEHOLDER_LAST_USED_AT (string)",
    "backup": "PLACEHOLDER_BACKUP (boolean)"
  }
}
```

補足：すべての個人データとオブジェクトは、JWTの主体に限定されます。

補足：credentialはnavigator.credentialsから、session\_tokenはbeginから取得します。Finish bodyは\<=65536バイト。登録と削除にはパスワードが必要です。

**PUT /api/v1/user/password** — パスワードの変更

アクセス：ダッシュボードのトークン

PUT`/api/v1/user/password`

## JSON／フォームのフィールド

| フィールド | タイプ | 必須 | 検証／説明 |
| --- | --- | --- | --- |
| `old_password` | `string` | はい | required |
| `new_password` | `string` | はい | required,min=6 |

リクエストボディのテンプレート

```json
{
  "old_password": "PLACEHOLDER_OLD_PASSWORD (string)",
  "new_password": "PLACEHOLDER_NEW_PASSWORD (string)"
}
```

PLACEHOLDERは、入力する値とその型を示します。値を置き換え、必要な任意フィールドだけを残してください。数値、boolean、オブジェクト、配列の代わりに、文字列のマーカーを送信しないでください。

リクエストのスキーマ：`ChangePasswordRequest`

## レスポンス

JSONレスポンスにはcode、message、dataが含まれます。dataの内容は、以下のスキーマで説明します。

レスポンスのスキーマ。値は例示用

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "message": "VALUE_FROM_RESPONSE"
  }
}
```

補足：すべての個人データとオブジェクトは、JWTの主体に限定されます。

補足：この操作は状態を変更するか、一度限りの認証手続きを継続します。例は契約仕様を説明するもので、実行されません。

このメソッドはデータを変更します。再送が安全なのは、Idempotency-Keyが明示されているメソッドのみです。レスポンスが失われた場合は、先に結果（例：キーの一覧）を確認してから、再送するかを判断してください。

**GET /api/v1/user/profile** — プロフィール、残高、連携情報

アクセス：ダッシュボードのトークン

GET`/api/v1/user/profile`

取得。IDは、以前取得したレスポンスの値を使います。

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"
```

リクエストボディは不要です。上記のパラメータはURLで渡してください。

## レスポンス

JSONレスポンスにはcode、message、dataが含まれます。dataの内容は、以下のスキーマで説明します。

レスポンスのデータスキーマ：`User`, `UserProfileResponse`。フィールドと型は、「データスキーマ」の各ページに記載されています。

レスポンスのスキーマ。値は例示用

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "id": "PLACEHOLDER_ID (integer)",
    "email": "PLACEHOLDER_EMAIL (string)",
    "username": "PLACEHOLDER_USERNAME (string)",
    "role": "PLACEHOLDER_ROLE (string)",
    "balance": "PLACEHOLDER_BALANCE (number)",
    "frozen_balance": "PLACEHOLDER_FROZEN_BALANCE (number)",
    "concurrency": "PLACEHOLDER_CONCURRENCY (integer)",
    "status": "PLACEHOLDER_STATUS (string)",
    "last_active_at": "PLACEHOLDER_LAST_ACTIVE_AT (string)",
    "created_at": "PLACEHOLDER_CREATED_AT (string)",
    "updated_at": "PLACEHOLDER_UPDATED_AT (string)",
    "deleted_at": "PLACEHOLDER_DELETED_AT (string)",
    "balance_notify_enabled": "PLACEHOLDER_BALANCE_NOTIFY_ENABLED (boolean)",
    "balance_notify_threshold_type": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD_TYPE (string)",
    "balance_notify_threshold": "PLACEHOLDER_BALANCE_NOTIFY_THRESHOLD (number)",
    "balance_notify_extra_emails": "PLACEHOLDER_BALANCE_NOTIFY_EXTRA_EMAILS (array)",
    "total_recharged": "PLACEHOLDER_TOTAL_RECHARGED (number)",
    "rpm_limit": "PLACEHOLDER_RPM_LIMIT (integer)",
    "api_keys": "PLACEHOLDER_API_KEYS (array)",
    "avatar_url": "PLACEHOLDER_AVATAR_URL (string)",
    "email_bound": "PLACEHOLDER_EMAIL_BOUND (boolean)"
  }
}
```

補足：すべての個人データとオブジェクトは、JWTの主体に限定されます。

補足：キーの支出制限（quota、quota\_used）は、プロフィールではなく、キーのレスポンスに含まれます。frozen\_balanceは仮確保中の金額であり、自由に使える残高として扱えません。

**GET /api/v1/user/totp/status** — 2FA（TOTP）の状態

アクセス：ダッシュボードのトークン

GET`/api/v1/user/totp/status`

取得。IDは、以前取得したレスポンスの値を使います。

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/status" \
  -H "Authorization: Bearer $TOKEN"
```

リクエストボディは不要です。上記のパラメータはURLで渡してください。

## レスポンス

JSONレスポンスにはcode、message、dataが含まれます。dataの内容は、以下のスキーマで説明します。

レスポンスのデータスキーマ：`TotpStatusResponse`。フィールドと型は、「データスキーマ」の各ページに記載されています。

レスポンスのスキーマ。値は例示用

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "enabled": "PLACEHOLDER_ENABLED (boolean)",
    "enabled_at": "PLACEHOLDER_ENABLED_AT (integer)",
    "feature_enabled": "PLACEHOLDER_FEATURE_ENABLED (boolean)"
  }
}
```

補足：すべての個人データとオブジェクトは、JWTの主体に限定されます。

補足：secretとsetup\_tokenは秘密情報です。検証は、TOTPとユーザーの設定によって異なります。

**GET /api/v1/user/totp/verification-method** — TOTPの検証方法

アクセス：ダッシュボードのトークン

GET`/api/v1/user/totp/verification-method`

取得。IDは、以前取得したレスポンスの値を使います。

```bash
curl --fail-with-body "https://ailoot.ai/api/v1/user/totp/verification-method" \
  -H "Authorization: Bearer $TOKEN"
```

リクエストボディは不要です。上記のパラメータはURLで渡してください。

## レスポンス

JSONレスポンスにはcode、message、dataが含まれます。dataの内容は、以下のスキーマで説明します。

レスポンスのスキーマ。値は例示用

```json
{
  "code": 0,
  "message": "success",
  "data": {
    "method": "email"
  }
}
```

補足：すべての個人データとオブジェクトは、JWTの主体に限定されます。

補足：secretとsetup\_tokenは秘密情報です。検証は、TOTPとユーザーの設定によって異なります。

## TotpVerificationMethod

```json
{
  "type": "object",
  "required": [
    "method"
  ],
  "properties": {
    "method": {
      "type": "string",
      "enum": [
        "email",
        "password"
      ]
    }
  }
}
```

ご不明な点はありますか？Request IDと状況の説明をお送りください。調査をお手伝いします。[サポートに問い合わせる](mailto:support@ailoot.ai)

## Ailoot · 企業とそのプロジェクト群





Ailootは、蓄積した運営経験、幅広い顧客基盤、安定したサービス、継続的なKPI管理を基盤としています。





企業とそのプロジェクト群：数百万の顧客、毎月数十億規模の売上。





Ailootはこの運営経験を、お客様の製品、エージェント、アプリケーション、自動化でAI機能を利用するためのAPIアクセスに活かしています。
