Profil und Sicherheit

Methoden, Request-Felder und Antworten.

Vollständiger Leitfaden

Dieser Abschnitt enthält 6 Methoden. Öffnen Sie eine Methode, um Zugriffsbedingungen, Request-Felder und Antwort einzusehen.

Methode und Pfad	Beschreibung	Zugriff
`PUT /api/v1/user`	Profil ändern	Token des Kundenbereichs
`GET /api/v1/user/passkeys`	Passkeys auflisten	Token des Kundenbereichs
`PUT /api/v1/user/password`	Passwort ändern	Token des Kundenbereichs
`GET /api/v1/user/profile`	Profil, Guthaben und Verknüpfungen	Token des Kundenbereichs
`GET /api/v1/user/totp/status`	2FA-Status (TOTP)	Token des Kundenbereichs
`GET /api/v1/user/totp/verification-method`	TOTP-Prüfmethode	Token des Kundenbereichs

PUT /api/v1/user — Profil ändern

Zugriff: Token des Kundenbereichs

PUT/api/v1/user

JSON- / Formularfelder

Das Feld	Typ	Erforderlich	Validierung / Beschreibung
`username`	`string`	nein	; kann null sein
`avatar_url`	`string`	nein	; kann null sein
`balance_notify_enabled`	`boolean`	nein	; kann null sein
`balance_notify_threshold`	`number`	nein	; kann null sein

Vorlage für den Request-Body

{
  "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 steht für Ihre Eingabe und deren Typ. Ersetzen Sie die Werte und behalten Sie nur die benötigten optionalen Felder; String-Platzhalter dürfen nicht anstelle von Zahlen, boolean, Objekten oder Arrays gesendet werden.

Request-Schema: UpdateProfileRequest

Antwort

Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den nachfolgenden Schemata beschrieben.

Datenschemata der Antwort: User, UserProfileResponse. Felder und Typen finden Sie auf den Seiten „Datenschemata“.

Antwortschema mit beispielhaften Werten

{
  "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)"
  }
}

Besonderheiten: Alle personenbezogenen Daten und Objekte sind auf das Subjekt des JWT beschränkt.

Besonderheiten: Der Vorgang ändert den Zustand oder setzt eine einmalige Authentifizierung fort; das Beispiel beschreibt den Vertrag und wird nicht ausgeführt.

Besonderheiten: Ausgabenlimits der Schlüssel (quota, quota_used) stehen in der Antwort zu den Schlüsseln, nicht im Profil. frozen_balance ist der reservierte Betrag und darf nicht als frei verfügbares Guthaben betrachtet werden.

GET /api/v1/user/passkeys — Passkeys auflisten

Zugriff: Token des Kundenbereichs

GET/api/v1/user/passkeys

Lesezugriff; die ID stammt aus Ihrer vorherigen Antwort

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

Ein Request-Body ist nicht erforderlich. Übergeben Sie die oben genannten Parameter in der URL.

Antwort

Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den nachfolgenden Schemata beschrieben.

Datenschemata der Antwort: PasskeyCredentialSummary. Felder und Typen finden Sie auf den Seiten „Datenschemata“.

Antwortschema mit beispielhaften Werten

{
  "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)"
  }
}

Besonderheiten: Alle personenbezogenen Daten und Objekte sind auf das Subjekt des JWT beschränkt.

Besonderheiten: credential stammt aus navigator.credentials; session_token aus begin. Finish body <=65536 Bytes; Registrierung und Löschung erfordern ein Passwort.

PUT /api/v1/user/password — Passwort ändern

Zugriff: Token des Kundenbereichs

PUT/api/v1/user/password

JSON- / Formularfelder

Das Feld	Typ	Erforderlich	Validierung / Beschreibung
`old_password`	`string`	ja	required
`new_password`	`string`	ja	required,min=6

Vorlage für den Request-Body

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

Request-Schema: ChangePasswordRequest

Antwort

Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den nachfolgenden Schemata beschrieben.

Antwortschema mit beispielhaften Werten

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

Besonderheiten: Alle personenbezogenen Daten und Objekte sind auf das Subjekt des JWT beschränkt.

Besonderheiten: Der Vorgang ändert den Zustand oder setzt eine einmalige Authentifizierung fort; das Beispiel beschreibt den Vertrag und wird nicht ausgeführt.

GET /api/v1/user/profile — Profil, Guthaben und Verknüpfungen

Zugriff: Token des Kundenbereichs

GET/api/v1/user/profile

Lesezugriff; die ID stammt aus Ihrer vorherigen Antwort

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

Ein Request-Body ist nicht erforderlich. Übergeben Sie die oben genannten Parameter in der URL.

Antwort

Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den nachfolgenden Schemata beschrieben.

Datenschemata der Antwort: User, UserProfileResponse. Felder und Typen finden Sie auf den Seiten „Datenschemata“.

Antwortschema mit beispielhaften Werten

{
  "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)"
  }
}

Besonderheiten: Alle personenbezogenen Daten und Objekte sind auf das Subjekt des JWT beschränkt.

GET /api/v1/user/totp/status — 2FA-Status (TOTP)

Zugriff: Token des Kundenbereichs

GET/api/v1/user/totp/status

Lesezugriff; die ID stammt aus Ihrer vorherigen Antwort

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

Ein Request-Body ist nicht erforderlich. Übergeben Sie die oben genannten Parameter in der URL.

Antwort

Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den nachfolgenden Schemata beschrieben.

Datenschemata der Antwort: TotpStatusResponse. Felder und Typen finden Sie auf den Seiten „Datenschemata“.

Antwortschema mit beispielhaften Werten

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

Besonderheiten: Alle personenbezogenen Daten und Objekte sind auf das Subjekt des JWT beschränkt.

Besonderheiten: secret und setup_token sind geheim; die Prüfung hängt von den TOTP-Einstellungen und vom Nutzer ab.

GET /api/v1/user/totp/verification-method — TOTP-Prüfmethode

Zugriff: Token des Kundenbereichs

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

Lesezugriff; die ID stammt aus Ihrer vorherigen Antwort

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

Ein Request-Body ist nicht erforderlich. Übergeben Sie die oben genannten Parameter in der URL.

Antwort

Die JSON-Antwort enthält code, message und data. Der Inhalt von data wird in den nachfolgenden Schemata beschrieben.

Antwortschema mit beispielhaften Werten

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

Besonderheiten: Alle personenbezogenen Daten und Objekte sind auf das Subjekt des JWT beschränkt.

Besonderheiten: secret und setup_token sind geheim; die Prüfung hängt von den TOTP-Einstellungen und vom Nutzer ab.

TotpVerificationMethod

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

Noch Fragen? Senden Sie uns die Request ID und eine Beschreibung — wir helfen Ihnen weiter.Support kontaktieren