Ternis-API-Dokumentation

live generiert

Die Referenz wird bei jeder Anfrage aus den registrierten Routen erstellt — immer synchron.

User API (Self-Service)

Versioned user-data endpoints: profile, avatar, sessions, own audit trail, memberships, authorized apps, addresses, emails, domains and synced OAuth accounts.

Auth: Bearer token (Passport, auth:api) on all endpoints.

Methode Endpunkt Auth Routenname
GET auth.wbbx.de/api/v1/user bearer auth.api.v1.user
GET auth.wbbx.de/api/v1/user/addresses bearer auth.api.v1.user.addresses
POST auth.wbbx.de/api/v1/user/addresses bearer auth.api.v1.user.addresses.store
PUT auth.wbbx.de/api/v1/user/addresses/{id} bearer auth.api.v1.user.addresses.update
DELETE auth.wbbx.de/api/v1/user/addresses/{id} bearer auth.api.v1.user.addresses.destroy
POST auth.wbbx.de/api/v1/user/apps/{clientId}/email-permission bearer auth.api.v1.user.apps.email_permission
GET auth.wbbx.de/api/v1/user/authorized-apps bearer auth.api.v1.user.authorized_apps
DELETE auth.wbbx.de/api/v1/user/authorized-apps/{clientId} bearer auth.api.v1.user.authorized_apps.revoke
POST auth.wbbx.de/api/v1/user/avatar bearer auth.api.v1.user.avatar.update
DELETE auth.wbbx.de/api/v1/user/avatar bearer auth.api.v1.user.avatar.destroy
GET auth.wbbx.de/api/v1/user/domains bearer auth.api.v1.user.domains
POST auth.wbbx.de/api/v1/user/domains bearer auth.api.v1.user.domains.store
DELETE auth.wbbx.de/api/v1/user/domains/{id} bearer auth.api.v1.user.domains.destroy
POST auth.wbbx.de/api/v1/user/domains/{id}/verify bearer auth.api.v1.user.domains.verify
GET auth.wbbx.de/api/v1/user/emails bearer auth.api.v1.user.emails
POST auth.wbbx.de/api/v1/user/emails bearer auth.api.v1.user.emails.store
DELETE auth.wbbx.de/api/v1/user/emails/{id} bearer auth.api.v1.user.emails.destroy
POST auth.wbbx.de/api/v1/user/emails/{id}/verify bearer auth.api.v1.user.emails.verify
GET auth.wbbx.de/api/v1/user/notifications bearer auth.api.v1.user.notifications
POST auth.wbbx.de/api/v1/user/notifications/clear-read bearer auth.api.v1.user.notifications.clear_read
GET auth.wbbx.de/api/v1/user/notifications/preferences bearer auth.api.v1.user.notifications.preferences
PUT auth.wbbx.de/api/v1/user/notifications/preferences bearer auth.api.v1.user.notifications.preferences.update
POST auth.wbbx.de/api/v1/user/notifications/read-all bearer auth.api.v1.user.notifications.read_all
GET auth.wbbx.de/api/v1/user/notifications/stats bearer auth.api.v1.user.notifications.stats
DELETE auth.wbbx.de/api/v1/user/notifications/{id} bearer auth.api.v1.user.notifications.destroy
POST auth.wbbx.de/api/v1/user/notifications/{id}/archive bearer auth.api.v1.user.notifications.archive
POST auth.wbbx.de/api/v1/user/notifications/{id}/pin bearer auth.api.v1.user.notifications.pin
PATCH auth.wbbx.de/api/v1/user/notifications/{id}/read bearer auth.api.v1.user.notifications.mark_read
GET auth.wbbx.de/api/v1/user/oauth-accounts bearer auth.api.v1.user.oauth_accounts
DELETE auth.wbbx.de/api/v1/user/oauth-accounts/{provider} bearer auth.api.v1.user.oauth_accounts.destroy
POST auth.wbbx.de/api/v1/user/oauth-accounts/{provider}/sync bearer auth.api.v1.user.oauth_accounts.sync
GET auth.wbbx.de/api/v1/user/sessions bearer auth.api.v1.user.sessions
DELETE auth.wbbx.de/api/v1/user/sessions/others bearer auth.api.v1.user.sessions.destroy_others
DELETE auth.wbbx.de/api/v1/user/sessions/{id} bearer auth.api.v1.user.sessions.destroy
GET auth.wbbx.de/api/v1/userinfo bearer auth.api.v1.userinfo