Profil og sikkerhet

Metoder, forespørselsfelter og svar.

Fullstendig guide

Seksjonen har 6 metoder. Åpne en metode for å se tilgangsvilkår, forespørselsfelter og svar.

Metode og endepunkt	Beskrivelse	Tilgang
`PUT /api/v1/user`	Endre profil	Kontrollpaneltoken
`GET /api/v1/user/passkeys`	Liste over passnøkler	Kontrollpaneltoken
`PUT /api/v1/user/password`	Endre passord	Kontrollpaneltoken
`GET /api/v1/user/profile`	Profil, saldo og tilknytninger	Kontrollpaneltoken
`GET /api/v1/user/totp/status`	2FA-status (TOTP)	Kontrollpaneltoken
`GET /api/v1/user/totp/verification-method`	TOTP-valideringsmetode	Kontrollpaneltoken

PUT /api/v1/user — Endre profil

Tilgang: kontrollpaneltoken

PUT/api/v1/user

JSON- / skjemafelter

Feltet	Type	Påkrevd	Validering / beskrivelse
`username`	`string`	nei	; kan være null
`avatar_url`	`string`	nei	; kan være null
`balance_notify_enabled`	`boolean`	nei	; kan være null
`balance_notify_threshold`	`number`	nei	; kan være null

Mal for forespørselskropp

{
  "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 angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.

Forespørselsskjema: UpdateProfileRequest

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: User, UserProfileResponse. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

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

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.

Merknader: Nøklenes forbruksgrenser (quota, quota_used) returneres i nøkkelsvaret, ikke i profilen. frozen_balance er det reserverte beløpet og må ikke regnes som tilgjengelig saldo.

GET /api/v1/user/passkeys — Liste over passnøkler

Tilgang: kontrollpaneltoken

GET/api/v1/user/passkeys

Lesing; ID hentes fra ditt forrige svar

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

Forespørselskropp er ikke nødvendig. Send parameterne ovenfor i URL-en.

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: PasskeyCredentialSummary. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

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

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: credential hentes fra navigator.credentials; session_token fra begin. Forespørselskroppen til Finish <=65536 byte; registrering og sletting krever passord.

PUT /api/v1/user/password — Endre passord

Tilgang: kontrollpaneltoken

PUT/api/v1/user/password

JSON- / skjemafelter

Feltet	Type	Påkrevd	Validering / beskrivelse
`old_password`	`string`	ja	required
`new_password`	`string`	ja	required,min=6

Mal for forespørselskropp

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

PLACEHOLDER angir dine inndata og typen deres. Erstatt verdiene og behold bare de valgfrie feltene du trenger; strengmarkører skal ikke sendes i stedet for tall, boolean, objekter eller lister.

Forespørselsskjema: ChangePasswordRequest

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Svarskjema, verdiene er illustrative

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

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: Operasjonen endrer tilstand eller fortsetter en engangsautentisering; eksemplet beskriver kontrakten og utføres ikke.

GET /api/v1/user/profile — Profil, saldo og tilknytninger

Tilgang: kontrollpaneltoken

GET/api/v1/user/profile

Lesing; ID hentes fra ditt forrige svar

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

Forespørselskropp er ikke nødvendig. Send parameterne ovenfor i URL-en.

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: User, UserProfileResponse. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

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

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: Nøklenes forbruksgrenser (quota, quota_used) returneres i nøkkelsvaret, ikke i profilen. frozen_balance er det reserverte beløpet og må ikke regnes som tilgjengelig saldo.

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

Tilgang: kontrollpaneltoken

GET/api/v1/user/totp/status

Lesing; ID hentes fra ditt forrige svar

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

Forespørselskropp er ikke nødvendig. Send parameterne ovenfor i URL-en.

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Dataskjemaer for svaret: TotpStatusResponse. Felter og typer finnes på sidene «Dataskjemaer».

Svarskjema, verdiene er illustrative

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

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: secret og setup_token er hemmelige; valideringen avhenger av TOTP- og brukerinnstillingene.

GET /api/v1/user/totp/verification-method — TOTP-valideringsmetode

Tilgang: kontrollpaneltoken

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

Lesing; ID hentes fra ditt forrige svar

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

Forespørselskropp er ikke nødvendig. Send parameterne ovenfor i URL-en.

Svar

JSON-svaret inneholder code, message og data. Innholdet i data beskrives i skjemaene nedenfor.

Svarskjema, verdiene er illustrative

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

Merknader: Alle personopplysninger og objekter er avgrenset til JWT-subjektet.

Merknader: secret og setup_token er hemmelige; valideringen avhenger av TOTP- og brukerinnstillingene.

TotpVerificationMethod

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

Flere spørsmål? Send Request ID og en beskrivelse, så hjelper vi deg.Kontakt brukerstøtte