К содержанию
ActionPulse

API: Me

Current user profile, password change, and active organization memberships.

Кому
Разработчики, интегрирующие ActionPulse по HTTP
Проверено
На этой странице

Раздел собран из спецификации OpenAPI продукта: 8 метод(ов). Поверхность — query-api (основной API, база /api/v1). Все методы требуют аутентификации.

Методы раздела
PATCH /me

Update the current user's display name

Аутентификация
Bearer: токен доступа (JWT)
operationId
patchMe

The name is trimmed and limited to 200 characters. An empty name is allowed and clears it (users.name defaults to '').

Тело запроса application/json , обязательно

Поле Тип Описание
name обязательно string

Ответы

Код Что означает Тело
200 Updated user object
401 Missing or invalid credentials (code=unauthorized) Error
422 Request failed validation (code=validation_failed) Error
GET /me/mfa

Read the current user's local TOTP status

Аутентификация
Bearer: токен доступа (JWT)
operationId
getMeMfa

Ответы

Код Что означает Тело
200 MFA status without any secret material MFAStatus
401 Missing or invalid credentials (code=unauthorized) Error
DELETE /me/mfa

Disable optional MFA and replace the current session

Аутентификация
Bearer: токен доступа (JWT)
operationId
deleteMeMfa

Requires the local password and a current TOTP or recovery code. OIDC-authenticated sessions receive 403 because their second factor is managed by the identity provider. All existing refresh sessions are revoked before a fresh non-MFA product session is issued.

Тело запроса application/json , обязательно

Поле Тип Описание
password необязательно string
code обязательно string

Ответы

Код Что означает Тело
200 MFA disabled; fresh product session TokenResponse
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
422 Request failed validation (code=validation_failed) Error
POST /me/mfa/recovery-codes

Replace every existing recovery code

Аутентификация
Bearer: токен доступа (JWT)
operationId
postMeMfaRecoveryCodes

Тело запроса application/json , обязательно

Поле Тип Описание
password необязательно string
code обязательно string

Ответы

Код Что означает Тело
200 New recovery codes, shown exactly once MFARecoveryCodes
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
422 Request failed validation (code=validation_failed) Error
429 Rate limit (code=rate_limited) or plan quota exceeded (code=quota_exceeded). On ingest operations a live trial that exhausted its total event cap answers code=trial_quota_exceeded instead of quota_exceeded. Заголовки: Retry-After. Error
POST /me/mfa/setup

Start optional Google Authenticator-compatible TOTP enrollment

Аутентификация
Bearer: токен доступа (JWT)
operationId
postMeMfaSetup

Тело запроса application/json , обязательно

Поле Тип Описание
password необязательно string Required for local-password sessions. OIDC sessions receive 403.

Ответы

Код Что означает Тело
200 Short-lived provisioning secret; never cached and returned only during setup MFASetup
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
422 Request failed validation (code=validation_failed) Error
429 Rate limit (code=rate_limited) or plan quota exceeded (code=quota_exceeded). On ingest operations a live trial that exhausted its total event cap answers code=trial_quota_exceeded instead of quota_exceeded. Заголовки: Retry-After. Error
POST /me/mfa/setup/confirm

Confirm enrollment and return one-time recovery codes

Аутентификация
Bearer: токен доступа (JWT)
operationId
postMeMfaSetupConfirm

Тело запроса application/json , обязательно

Поле Тип Описание
code обязательно string

Ответы

Код Что означает Тело
200 MFA enabled; prior sessions revoked and a fresh verified session issued TokenResponse
401 Missing or invalid credentials (code=unauthorized) Error
403 Authenticated but not permitted (code=forbidden) Error
422 Request failed validation (code=validation_failed) Error
429 Rate limit (code=rate_limited) or plan quota exceeded (code=quota_exceeded). On ingest operations a live trial that exhausted its total event cap answers code=trial_quota_exceeded instead of quota_exceeded. Заголовки: Retry-After. Error
GET /me/orgs

List organizations available to the current user

Аутентификация
Bearer: токен доступа (JWT)
operationId
getMeOrgs

Returns only active memberships for the authenticated user. `current` is derived from the signed access-token org claim; client-side stored organization ids are hints and never authorize access.

Ответы

Код Что означает Тело
200 Active organization memberships OrganizationMembershipListResponse
401 Missing or invalid credentials (code=unauthorized) Error
POST /me/password

Change the current user's password (requires the old one)

Аутентификация
Bearer: токен доступа (JWT)
operationId
postMePassword

A wrong old password yields 422 (the user is authenticated — it is a form input error, not 401). On success all refresh tokens are revoked (other sessions die) and a fresh access token + refresh cookie are issued for the current session.

Тело запроса application/json , обязательно

Поле Тип Описание
old_password обязательно string
new_password обязательно string

Ответы

Код Что означает Тело
200 Password changed; fresh access token + refresh cookie for the current session Заголовки: Set-Cookie. TokenResponse
401 Missing or invalid credentials (code=unauthorized) Error
422 Request failed validation (code=validation_failed) Error

Источник раздела — docs/api/openapi.yaml репозитория продукта, версия API 1.0.0, OpenAPI 3.0.3, снимок 095579325c2d. Расхождение снимка со спецификацией роняет сборку документации.

← Все разделы API Reference