api.user.m7.org Endpoint Documentation

Generated on 2026-07-19 from cli/endpoints.php --json, config/general.json, and the PHP handlers under lib/php/thisProject/api.

Conventions

  • Base URL: https://api.user.m7.org
  • Response format: json; error format: json.
  • Request parameters are read from the parsed request payload ($this->r), which may include query, form, or JSON body values depending on the router parser.
  • ANY means the route is registered without an HTTP-method constraint. Prefer POST for mutations and request bodies unless the caller contract says otherwise.
  • "Detected request fields" are statically extracted from handlers and delegated service methods; table-backed filters may accept additional fields.

Authentication

  • No auth.m7_token block is present in config/general.json; handlers may still validate tokens directly.
  • The user API validates credentials in the base controller by default; login/exchange style handlers opt out with credentials => false.

Endpoint Summary

Method Path Auth Handler
ANY /api/v2/account/me/auth/request_log/search credentials validated by base controller by default me\auth\request_log\Search
ANY /api/v2/account/me/auth/request_log/view credentials validated by base controller by default me\auth\request_log\View
ANY /api/v2/account/me/email/add credentials validated by base controller by default me\AddEmail
ANY /api/v2/account/me/email/confirm/consume credentials validated by base controller by default me\ConfirmEmailConsume
ANY /api/v2/account/me/email/confirm/resend credentials validated by base controller by default me\ConfirmEmailResend
ANY /api/v2/account/me/email/confirm/send credentials validated by base controller by default me\ConfirmEmail
ANY /api/v2/account/me/email/delete credentials validated by base controller by default me\DeleteEmail
ANY /api/v2/account/me/email/get credentials validated by base controller by default me\GetEmail
ANY /api/v2/account/me/email/list credentials validated by base controller by default me\ListEmail
ANY /api/v2/account/me/email/setPrimary credentials validated by base controller by default me\SetPrimaryEmail
ANY /api/v2/account/me/get credentials validated by base controller by default me\GetProfile
ANY /api/v2/account/me/password credentials validated by base controller by default me\Password
ANY /api/v2/account/me/session/search credentials validated by base controller by default me\session\Search
ANY /api/v2/account/me/set credentials validated by base controller by default me\SetProfile
ANY /api/v2/account/preferences/get credentials validated by base controller by default settings\preferences\Get
ANY /api/v2/account/preferences/set credentials validated by base controller by default settings\preferences\Set
ANY /api/v2/admin/auth/request_log credentials validated by base controller by default; root user session required; admi... admin\auth\request_log\Controller
ANY /api/v2/admin/auth/request_log/search credentials validated by base controller by default; admin namespace; deployment/conf... admin\auth\request_log\Search
ANY /api/v2/admin/auth/request_log/view credentials validated by base controller by default; admin namespace; deployment/conf... admin\auth\request_log\View
ANY /api/v2/admin/session/search credentials validated by base controller by default; root user session required; admi... admin\session\Search
ANY /api/v2/admin/user credentials validated by base controller by default; root user session required; admi... admin\user\Controller
ANY /api/v2/admin/user/get credentials validated by base controller by default; admin namespace; deployment/conf... admin\user\Get
ANY /api/v2/admin/user/search credentials validated by base controller by default; admin namespace; deployment/conf... admin\user\Search
ANY /api/v2/admin/user/update_status credentials validated by base controller by default; admin namespace; deployment/conf... admin\user\UpdateStatus
ANY /api/v2/auth/member/exchange existing API credential not required by handler constructor; first-party OAuth relay... auth\member\Exchange
ANY /api/v2/auth/member/login existing API credential not required by handler constructor; first-party OAuth relay... auth\member\Login
ANY /api/v2/auth/member/root-session existing API credential not required by handler constructor auth\member\RootSession
ANY /api/v2/auth/signup existing API credential not required by handler constructor auth\Signup
ANY /api/v2/auth/user/exchange existing API credential not required by handler constructor; first-party OAuth relay... auth\user\Exchange
ANY /api/v2/auth/user/login existing API credential not required by handler constructor; first-party OAuth relay... auth\user\Login
ANY /api/v2/auth/user/root-session existing API credential not required by handler constructor auth\user\RootSession
ANY /api/v2/oauth credentials validated by base controller by default oauth\Controller
ANY /api/v2/oauth/client_credentials/issue credentials validated by base controller by default oauth\client_credentials\Issue
ANY /api/v2/oauth/client_credentials/issue/web credentials validated by base controller by default oauth\client_credentials\IssueWeb
ANY /api/v2/oauth/client_credentials/revoke credentials validated by base controller by default oauth\client_credentials\Revoke
ANY /api/v2/oauth/client_credentials/search/app credentials validated by base controller by default oauth\client_credentials\SearchApp
ANY /api/v2/oauth/client_credentials/view credentials validated by base controller by default oauth\client_credentials\View
ANY /api/v2/oauth/clients credentials validated by base controller by default oauth\clients\Controller
ANY /api/v2/oauth/clients/authorized credentials validated by base controller by default oauth\clients\authorized\Controller
ANY /api/v2/oauth/clients/authorized/search credentials validated by base controller by default oauth\clients\authorized\Search
ANY /api/v2/oauth/clients/authorized/update credentials validated by base controller by default oauth\clients\authorized\Update
ANY /api/v2/oauth/clients/authorized/update_status credentials validated by base controller by default oauth\clients\authorized\UpdateStatus
ANY /api/v2/oauth/clients/authorized/view credentials validated by base controller by default oauth\clients\authorized\View
ANY /api/v2/oauth/clients/connected credentials validated by base controller by default oauth\clients\connected\Controller
ANY /api/v2/oauth/clients/connected/insert credentials validated by base controller by default oauth\clients\connected\Insert
ANY /api/v2/oauth/clients/connected/search credentials validated by base controller by default oauth\clients\connected\Search
ANY /api/v2/oauth/clients/connected/update credentials validated by base controller by default oauth\clients\connected\Update
ANY /api/v2/oauth/clients/connected/view credentials validated by base controller by default oauth\clients\connected\View
ANY /api/v2/oauth/clients/connections credentials validated by base controller by default oauth\clients\connections\Controller
ANY /api/v2/oauth/clients/connections/delete credentials validated by base controller by default oauth\clients\connections\Delete
ANY /api/v2/oauth/clients/connections/insert credentials validated by base controller by default oauth\clients\connections\Insert
ANY /api/v2/oauth/clients/connections/recover credentials validated by base controller by default oauth\clients\connections\Recover
ANY /api/v2/oauth/clients/connections/search credentials validated by base controller by default oauth\clients\connections\Search
ANY /api/v2/oauth/clients/connections/update credentials validated by base controller by default oauth\clients\connections\Update
ANY /api/v2/oauth/clients/connections/update_status credentials validated by base controller by default oauth\clients\connections\UpdateStatus
ANY /api/v2/oauth/clients/connections/verify existing API credential not required by handler constructor oauth\clients\connections\Verify
ANY /api/v2/oauth/clients/connections/view credentials validated by base controller by default oauth\clients\connections\View
ANY /api/v2/oauth/clients/delete credentials validated by base controller by default oauth\clients\Delete
ANY /api/v2/oauth/clients/insert credentials validated by base controller by default oauth\clients\Insert
ANY /api/v2/oauth/clients/recover credentials validated by base controller by default oauth\clients\Recover
ANY /api/v2/oauth/clients/search credentials validated by base controller by default oauth\clients\Search
ANY /api/v2/oauth/clients/set_auth credentials validated by base controller by default oauth\clients\SetAuth
ANY /api/v2/oauth/clients/set_config_lock credentials validated by base controller by default oauth\clients\SetConfigLock
ANY /api/v2/oauth/clients/set_knobs credentials validated by base controller by default oauth\clients\SetKnobs
ANY /api/v2/oauth/clients/tenants credentials validated by base controller by default oauth\clients\Tenants
ANY /api/v2/oauth/clients/update credentials validated by base controller by default oauth\clients\Update
ANY /api/v2/oauth/clients/update_status credentials validated by base controller by default oauth\clients\UpdateStatus
ANY /api/v2/oauth/clients/view credentials validated by base controller by default oauth\clients\View
ANY /api/v2/oauth/device/issue credentials validated by base controller by default offline_access\oauth\device\Issue
ANY /api/v2/oauth/device/pickup credentials validated by base controller by default offline_access\oauth\device\Pickup
ANY /api/v2/oauth/device/refresh/bundle credentials validated by base controller by default offline_access\oauth\device\RefreshBundle
ANY /api/v2/oauth/device/revoke credentials validated by base controller by default offline_access\oauth\device\Revoke
ANY /api/v2/oauth/device/search credentials validated by base controller by default offline_access\oauth\device\Search
ANY /api/v2/oauth/device/search/app credentials validated by base controller by default offline_access\oauth\device\SearchApp
ANY /api/v2/oauth/device/search/user credentials validated by base controller by default offline_access\oauth\device\SearchUser
ANY /api/v2/oauth/device/update credentials validated by base controller by default offline_access\oauth\device\Update
ANY /api/v2/oauth/device/view credentials validated by base controller by default offline_access\oauth\device\View
ANY /api/v2/org/client/delete credentials validated by base controller by default client\Delete
ANY /api/v2/org/client/get credentials validated by base controller by default client\Get
ANY /api/v2/org/client/group/add credentials validated by base controller by default client\group\Add
ANY /api/v2/org/client/group/all credentials validated by base controller by default client\group\All
ANY /api/v2/org/client/group/get credentials validated by base controller by default client\group\Get
ANY /api/v2/org/client/group/remove credentials validated by base controller by default client\group\Remove
ANY /api/v2/org/client/group/search credentials validated by base controller by default client\group\Search
ANY /api/v2/org/client/group/set credentials validated by base controller by default client\group\Set
ANY /api/v2/org/client/insert credentials validated by base controller by default client\Insert
ANY /api/v2/org/client/password credentials validated by base controller by default client\ChangePass
ANY /api/v2/org/client/restore credentials validated by base controller by default client\Restore
ANY /api/v2/org/client/search credentials validated by base controller by default client\Search
ANY /api/v2/org/client/update credentials validated by base controller by default client\Set
ANY /api/v2/org/delete credentials validated by base controller by default org\Delete
ANY /api/v2/org/get credentials validated by base controller by default org\Get
ANY /api/v2/org/group/delete credentials validated by base controller by default group\Delete
ANY /api/v2/org/group/get credentials validated by base controller by default group\Get
ANY /api/v2/org/group/insert credentials validated by base controller by default group\Insert
ANY /api/v2/org/group/restore credentials validated by base controller by default group\Restore
ANY /api/v2/org/group/search credentials validated by base controller by default group\Search
ANY /api/v2/org/group/update credentials validated by base controller by default group\Set
ANY /api/v2/org/identity credentials validated by base controller by default org\identity\Controller
ANY /api/v2/org/identity/get credentials validated by base controller by default org\identity\Get
ANY /api/v2/org/identity/set credentials validated by base controller by default org\identity\Set
ANY /api/v2/org/insert credentials validated by base controller by default org\Insert
ANY /api/v2/org/restore credentials validated by base controller by default org\Restore
ANY /api/v2/org/search credentials validated by base controller by default org\Search
ANY /api/v2/org/update credentials validated by base controller by default org\Set
ANY /api/v2/session/me existing API credential not required by handler constructor session\Me

Endpoints

ANY /api/v2/account/me/auth/request_log/search

Searches auth request log.

  • Handler: thisProject\api\me\auth\request_log\Search
  • Source: lib/php/thisProject/api/me/auth/request_log/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.
  • Notable errors: Missing principal.

ANY /api/v2/account/me/auth/request_log/view

Gets auth request log.

  • Handler: thisProject\api\me\auth\request_log\View
  • Source: lib/php/thisProject/api/me/auth/request_log/View.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.
  • Notable errors: Missing principal.

ANY /api/v2/account/me/email/add

Adds email.

  • Handler: thisProject\api\me\AddEmail
  • Source: lib/php/thisProject/api/me/AddEmail.php
  • Delegates to: lib/php/thisProject/service/Mail.php::requestEmailConfirmation
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • display_name (optional/detected). Detected in handler or delegated service code.
    • email (optional/detected). Email address.
    • email_id (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • message_group (optional/detected). Message group id. Default: ''.
    • primary (optional/detected). Detected in handler or delegated service code.
    • reason (optional/detected). Human-readable reason.
    • uid (optional/detected). Detected in handler or delegated service code.
    • username (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): OK; data key(s): status, comment, data, requested, reason, error, provider, stub, env_confirmed, token_bundle, confirmation_id, confirmation_status, confirmation, id, job_activate_request, job_create_response.
  • Notable errors: invalid email address; email confirmation requires an email address.

ANY /api/v2/account/me/email/confirm/consume

Consumes email confirm.

  • Handler: thisProject\api\me\ConfirmEmailConsume
  • Source: lib/php/thisProject/api/me/ConfirmEmailConsume.php
  • Delegates to: lib/php/thisProject/service/Mail.php::consumeEmailConfirmationProof
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • code (required). One-time code or code id. Default: ''.
    • confirmation_id (required). Detected in handler or delegated service code. Default: ''.
    • email (optional/detected). Email address.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • job (optional/detected). Job id or job reference. Default: ''.
    • job_id (optional/detected). Job id. Some handlers also accept id as an alias. Default: ''.
    • secret (optional/detected). Secret code value. Default: ''.
  • Response: success comment(s): EMAIL ALREADY VERIFIED, EMAIL VERIFIED.
  • Notable errors: email record not found; email record is archived; code is required; confirmation_id is required.

ANY /api/v2/account/me/email/confirm/resend

Handles email confirm resend.

  • Handler: thisProject\api\me\ConfirmEmailResend
  • Source: lib/php/thisProject/api/me/ConfirmEmailResend.php
  • Delegates to: lib/php/thisProject/service/Mail.php::resendEmailConfirmation
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • confirmation_id (required). Detected in handler or delegated service code. Default: ''.
    • data.item.method.id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • data.item.methods (optional/detected). Detected in handler or delegated service code. Default: [].
    • email (optional/detected). Email address. Default: ''.
    • email_id (optional/detected). Detected in handler or delegated service code. Default: ''.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • job (optional/detected). Job id or job reference. Default: ''.
    • job_id (optional/detected). Job id. Some handlers also accept id as an alias. Default: ''.
    • uid (optional/detected). Detected in handler or delegated service code. Default: ''.
  • Response: success comment(s): EMAIL ALREADY VERIFIED, CONFIRMATION RESENT; data key(s): status, comment, data, provider, confirmation_id, proof_get_response, proof_send_request, proof_send_response, action, reference, requested_at.
  • Notable errors: confirmation_id is required; email record not found; email record is archived.

ANY /api/v2/account/me/email/confirm/send

Sends email confirm.

  • Handler: thisProject\api\me\ConfirmEmail
  • Source: lib/php/thisProject/api/me/ConfirmEmail.php
  • Delegates to: lib/php/thisProject/service/Mail.php::requestEmailConfirmation
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • display_name (optional/detected). Detected in handler or delegated service code.
    • email (optional/detected). Email address.
    • email_id (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • message_group (optional/detected). Message group id. Default: ''.
    • reason (optional/detected). Human-readable reason.
    • uid (optional/detected). Detected in handler or delegated service code.
    • username (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): EMAIL ALREADY VERIFIED, CONFIRMATION REQUESTED; data key(s): status, comment, data, provider, stub, env_confirmed, token_bundle, confirmation_id, confirmation_status, confirmation, id, job_activate_request, job_create_response, job_activate_response, action, reference.
  • Notable errors: email record not found; email record is archived; email confirmation requires an email address.

ANY /api/v2/account/me/email/delete

Deletes email.

  • Handler: thisProject\api\me\DeleteEmail
  • Source: lib/php/thisProject/api/me/DeleteEmail.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • email (optional/detected). Email address.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): deleted.
  • Notable errors: you do not own this record; invalid email address; invalid email; you cannot delete the last active email on your account; unable to resolve a replacement primary email.

ANY /api/v2/account/me/email/get

Gets email.

  • Handler: thisProject\api\me\GetEmail
  • Source: lib/php/thisProject/api/me/GetEmail.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • email (optional/detected). Email address.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • primary_email (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): OK, no email found. ready for input.
  • Notable errors: you do not own this record.

ANY /api/v2/account/me/email/list

Lists email.

  • Handler: thisProject\api\me\ListEmail
  • Source: lib/php/thisProject/api/me/ListEmail.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.

ANY /api/v2/account/me/email/setPrimary

Handles email set primary.

  • Handler: thisProject\api\me\SetPrimaryEmail
  • Source: lib/php/thisProject/api/me/SetPrimaryEmail.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • email (required). Email address.
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • verified (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): EMAIL ALREADY PRIMARY, PRIMARY EMAIL UPDATED.
  • Notable errors: id or email required; email record not found; email record is archived; only verified emails can be set as primary.

ANY /api/v2/account/me/get

Gets get profile.

  • Handler: thisProject\api\me\GetProfile
  • Source: lib/php/thisProject/api/me/GetProfile.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK, no profile found. ready for input.

ANY /api/v2/account/me/password

Handles password.

  • Handler: thisProject\api\me\Password
  • Source: lib/php/thisProject/api/me/Password.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • confirm (required). Password confirmation.
    • current (required). Detected in handler or delegated service code.
    • new (required). Detected in handler or delegated service code.
    • password (required). Detected in handler or delegated service code.
    • auth.pass (optional/detected). Nested auth password.
    • comment (optional/detected). Detected in handler or delegated service code.
    • current_password (optional/detected). Detected in handler or delegated service code.
    • data (optional/detected). Payload/data value. Default: [].
    • data.rows_affected (optional/detected). Detected in handler or delegated service code.
    • error (optional/detected). Detected in handler or delegated service code.
    • error_description (optional/detected). Detected in handler or delegated service code.
    • pass (optional/detected). Password credential.
    • rid (optional/detected). Detected in handler or delegated service code. Default: ''.
    • rows_affected (optional/detected). Detected in handler or delegated service code.
    • status (optional/detected). Status filter or value.
    • verified (optional/detected). Detected in handler or delegated service code. Default: 0.
  • Response: success comment(s): CHANGED.
  • Notable errors: Missing new / confirm; new password and confirmation do not match; Invalid current password; Current password is required; Missing principal; Unable to resolve current user rid.

ANY /api/v2/account/me/session/search

Searches session.

  • Handler: thisProject\api\me\session\Search
  • Source: lib/php/thisProject/api/me/session/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.
  • Notable errors: Missing principal.

ANY /api/v2/account/me/set

Handles set.

  • Handler: thisProject\api\me\SetProfile
  • Source: lib/php/thisProject/api/me/SetProfile.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.

ANY /api/v2/account/preferences/get

Gets preferences.

  • Handler: thisProject\api\settings\preferences\Get
  • Source: lib/php/thisProject/api/settings/preferences/Get.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): GET.

ANY /api/v2/account/preferences/set

Handles preferences set.

  • Handler: thisProject\api\settings\preferences\Set
  • Source: lib/php/thisProject/api/settings/preferences/Set.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): SET.
  • Notable errors: Invalid int preference value; Invalid float preference value; Invalid json preference value.

ANY /api/v2/admin/auth/request_log

Handles auth request log.

  • Handler: thisProject\api\admin\auth\request_log\Controller
  • Source: lib/php/thisProject/api/admin/auth/request_log/Controller.php
  • Auth: credentials validated by base controller by default; root user session required; admin namespace; deployment/config may restrict access
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): service, status, routes, search, view.

ANY /api/v2/admin/auth/request_log/search

Searches auth request log.

  • Handler: thisProject\api\admin\auth\request_log\Search
  • Source: lib/php/thisProject/api/admin/auth/request_log/Search.php
  • Auth: credentials validated by base controller by default; admin namespace; deployment/config may restrict access
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.

ANY /api/v2/admin/auth/request_log/view

Gets auth request log.

  • Handler: thisProject\api\admin\auth\request_log\View
  • Source: lib/php/thisProject/api/admin/auth/request_log/View.php
  • Auth: credentials validated by base controller by default; admin namespace; deployment/config may restrict access
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.

ANY /api/v2/admin/session/search

Searches session.

  • Handler: thisProject\api\admin\session\Search
  • Source: lib/php/thisProject/api/admin/session/Search.php
  • Auth: credentials validated by base controller by default; root user session required; admin namespace; deployment/config may restrict access
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.

ANY /api/v2/admin/user

Handles user.

  • Handler: thisProject\api\admin\user\Controller
  • Source: lib/php/thisProject/api/admin/user/Controller.php
  • Auth: credentials validated by base controller by default; root user session required; admin namespace; deployment/config may restrict access
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): service, status, routes, search, get, update_status.

ANY /api/v2/admin/user/get

Gets user.

  • Handler: thisProject\api\admin\user\Get
  • Source: lib/php/thisProject/api/admin/user/Get.php
  • Auth: credentials validated by base controller by default; admin namespace; deployment/config may restrict access
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.

ANY /api/v2/admin/user/search

Searches user.

  • Handler: thisProject\api\admin\user\Search
  • Source: lib/php/thisProject/api/admin/user/Search.php
  • Auth: credentials validated by base controller by default; admin namespace; deployment/config may restrict access
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.

ANY /api/v2/admin/user/update_status

Updates status for user.

  • Handler: thisProject\api\admin\user\UpdateStatus
  • Source: lib/php/thisProject/api/admin/user/UpdateStatus.php
  • Auth: credentials validated by base controller by default; admin namespace; deployment/config may restrict access
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): UPDATE_STATUS.

ANY /api/v2/auth/member/exchange

Handles auth exchange.

  • Handler: thisProject\api\auth\member\Exchange
  • Source: lib/php/thisProject/api/auth/member/Exchange.php
  • Auth: existing API credential not required by handler constructor; first-party OAuth relay required
  • Detected request fields:
    • auth.dpop (optional/detected). DPoP proof value forwarded to downstream auth services.
    • auth.fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • auth.htu (optional/detected). HTTP target URI used with DPoP validation.
    • auth.method (optional/detected). Method selector or delivery method. Default: 'refresh'.
    • auth.org (optional/detected). Nested auth organization id.
    • auth.token (optional/detected). Nested auth token.
    • binding_chain (optional/detected). Binding-chain identifier for token continuity.
    • binding_link (optional/detected). Binding-link identifier for token continuity.
    • dpop (optional/detected). DPoP proof value forwarded to downstream auth services.
    • fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • htu (optional/detected). HTTP target URI used with DPoP validation.
    • org (optional/detected). Organization id or slug depending on the handler.
    • token (optional/detected). Token value.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: DERP DERP SORRY; Invalid Path; Invalid auth server response.

ANY /api/v2/auth/member/login

Handles auth login.

  • Handler: thisProject\api\auth\member\Login
  • Source: lib/php/thisProject/api/auth/member/Login.php
  • Auth: existing API credential not required by handler constructor; first-party OAuth relay required
  • Detected request fields:
    • auth.code (required). Nested auth one-time code.
    • auth.org (required). Nested auth organization id.
    • auth.pass (required). Nested auth password.
    • auth.user (required). Nested auth username.
    • aud (optional/detected). Requested token audience.
    • auth.fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • auth.id (optional/detected). Nested auth identity id.
    • comment (optional/detected). Detected in handler or delegated service code.
    • data.expires (optional/detected). Expiration timestamp.
    • data.expires_in (optional/detected). Detected in handler or delegated service code.
    • data.iat (optional/detected). Detected in handler or delegated service code.
    • data.token (optional/detected). Token value.
    • fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • scope (optional/detected). Requested OAuth scope string. Default: ''.
    • status (optional/detected). Status filter or value.
  • Response: success comment(s): OK.
  • Notable errors: Invalid Path; Missing credentials user/org $username, $orgID; missing pass / auth code; Failed to obtain token:; Failed to obtain access token:.

ANY /api/v2/auth/member/root-session

Handles auth root session.

  • Handler: thisProject\api\auth\member\RootSession
  • Source: lib/php/thisProject/api/auth/member/RootSession.php
  • Auth: existing API credential not required by handler constructor
  • Detected request fields:
    • auth.code (required). Nested auth one-time code.
    • auth.org (required). Nested auth organization id.
    • auth.id (optional/detected). Nested auth identity id.
    • auth.pass (optional/detected). Nested auth password.
    • auth.user (optional/detected). Nested auth username.
    • dpop (optional/detected). DPoP proof value forwarded to downstream auth services.
    • fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • htu (optional/detected). HTTP target URI used with DPoP validation.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: Invalid Path; tenant-auth/login: Missing credentials : username ($username); tenant-auth/login: Missing credentials : org; tenant-auth/login: Missing credentials : password or code.

ANY /api/v2/auth/signup

Handles auth signup.

  • Handler: thisProject\api\auth\Signup
  • Source: lib/php/thisProject/api/auth/Signup.php
  • Delegates to: lib/php/thisProject/service/Mail.php::requestEmailConfirmation
  • Auth: existing API credential not required by handler constructor
  • Detected request fields:
    • confirm (required). Password confirmation.
    • pass (required). Password credential.
    • user (required). Username or user id, depending on the endpoint.
    • display_name (optional/detected). Detected in handler or delegated service code.
    • displayname (optional/detected). Display name.
    • email (optional/detected). Email address.
    • email_id (optional/detected). Detected in handler or delegated service code.
    • message_group (optional/detected). Message group id. Default: ''.
    • reason (optional/detected). Human-readable reason.
    • uid (optional/detected). Detected in handler or delegated service code.
    • user.local.id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • username (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): OK; data key(s): status, comment, error, data, provider, stub, env_confirmed, token_bundle, confirmation_id, confirmation_status, confirmation, id, job_activate_request, job_create_response, job_activate_response, action.
  • Notable errors: Invalid Path; Missing user / pass / confirm; email requried; unable to create a user, try again or contact the administrator; email confirmation requires an email address.

ANY /api/v2/auth/user/exchange

Handles auth user exchange.

  • Handler: thisProject\api\auth\user\Exchange
  • Source: lib/php/thisProject/api/auth/user/Exchange.php
  • Auth: existing API credential not required by handler constructor; first-party OAuth relay required
  • Detected request fields:
    • auth.dpop (optional/detected). DPoP proof value forwarded to downstream auth services.
    • auth.fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • auth.htu (optional/detected). HTTP target URI used with DPoP validation.
    • auth.method (optional/detected). Method selector or delivery method. Default: 'refresh'.
    • auth.token (optional/detected). Nested auth token.
    • binding_chain (optional/detected). Binding-chain identifier for token continuity.
    • binding_link (optional/detected). Binding-link identifier for token continuity.
    • dpop (optional/detected). DPoP proof value forwarded to downstream auth services.
    • fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • htu (optional/detected). HTTP target URI used with DPoP validation.
    • token (optional/detected). Token value.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: Invalid Path; Invalid auth server response.

ANY /api/v2/auth/user/login

Handles auth user login.

  • Handler: thisProject\api\auth\user\Login
  • Source: lib/php/thisProject/api/auth/user/Login.php
  • Auth: existing API credential not required by handler constructor; first-party OAuth relay required
  • Detected request fields:
    • auth.code (required). Nested auth one-time code.
    • code (required). One-time code or code id.
    • aud (optional/detected). Requested token audience.
    • auth.fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • auth.id (optional/detected). Nested auth identity id.
    • auth.pass (optional/detected). Nested auth password.
    • auth.user (optional/detected). Nested auth username.
    • comment (optional/detected). Detected in handler or delegated service code.
    • data.expires (optional/detected). Expiration timestamp.
    • data.expires_in (optional/detected). Detected in handler or delegated service code.
    • data.iat (optional/detected). Detected in handler or delegated service code.
    • data.token (optional/detected). Token value.
    • fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • scope (optional/detected). Requested OAuth scope string. Default: ''.
    • status (optional/detected). Status filter or value.
  • Response: success comment(s): OK.
  • Notable errors: Invalid Path; auth/login: Missing credentials : username ($username); auth/login: Missing credentials : password or code; Failed to obtain refresh token:; Failed to obtain access token:.

ANY /api/v2/auth/user/root-session

Handles auth user root session.

  • Handler: thisProject\api\auth\user\RootSession
  • Source: lib/php/thisProject/api/auth/user/RootSession.php
  • Auth: existing API credential not required by handler constructor
  • Detected request fields:
    • auth.code (required). Nested auth one-time code.
    • auth.id (optional/detected). Nested auth identity id.
    • auth.pass (optional/detected). Nested auth password.
    • auth.user (optional/detected). Nested auth username.
    • dpop (optional/detected). DPoP proof value forwarded to downstream auth services.
    • fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • htu (optional/detected). HTTP target URI used with DPoP validation.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: Invalid Path; auth/login: Missing credentials : username ($username); auth/login: Missing credentials : password or code.

ANY /api/v2/oauth

Handles oauth.

  • Handler: thisProject\api\oauth\Controller
  • Source: lib/php/thisProject/api/oauth/Controller.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): service, status, routes, clients, client_credentials, secrets, redirects, logout_redirects, scopes, grants.

ANY /api/v2/oauth/client_credentials/issue

Issues oauth client credentials.

  • Handler: thisProject\api\oauth\client_credentials\Issue
  • Source: lib/php/thisProject/api/oauth/client_credentials/Issue.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • aud (required). Requested token audience.
    • client_id (required). Detected in handler or delegated service code.
    • access_expires (optional/detected). Detected in handler or delegated service code.
    • expires (optional/detected). Expiration timestamp.
    • fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • scope (optional/detected). Requested OAuth scope string.
  • Response: success comment(s): ISSUE.
  • Notable errors: client_id is required; aud is required; id.m7 client_credentials exchange failed.

ANY /api/v2/oauth/client_credentials/issue/web

Handles oauth client credentials web.

  • Handler: thisProject\api\oauth\client_credentials\IssueWeb
  • Source: lib/php/thisProject/api/oauth/client_credentials/IssueWeb.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • client_secret (required). Detected in handler or delegated service code.
    • access_expires (optional/detected). Detected in handler or delegated service code.
    • auth.fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • claims (optional/detected). Detected in handler or delegated service code.
    • expires (optional/detected). Expiration timestamp.
    • expires_in (optional/detected). Detected in handler or delegated service code.
    • fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • label (optional/detected). Display label. Default: ''.
    • options.expires (optional/detected). Expiration timestamp.
    • options.expires_in (optional/detected). Detected in handler or delegated service code.
    • payload (optional/detected). Payload to store or encrypt.
    • scope (optional/detected). Requested OAuth scope string.
  • Response: success comment(s): ISSUE_WEB.
  • Notable errors: Missing principal; oauth client not found; invalid field name; client_credentials requires a confidential client; Unsupported client_credentials token_endpoint_auth_method; client_secret must be a string; client_secret is required.

ANY /api/v2/oauth/client_credentials/revoke

Revokes oauth client credentials.

  • Handler: thisProject\api\oauth\client_credentials\Revoke
  • Source: lib/php/thisProject/api/oauth/client_credentials/Revoke.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • client_id (optional/detected). Detected in handler or delegated service code. Default: ''.
    • method (optional/detected). Method selector or delivery method. Default: ''.
    • principal_type (optional/detected). Detected in handler or delegated service code. Default: ''.
    • status (optional/detected). Status filter or value. Default: ''.
    • variant (optional/detected). Detected in handler or delegated service code. Default: ''.
  • Response: success comment(s): REVOKE.
  • Notable errors: Missing principal; Missing offline access id; Invalid offline access id; Offline access record not found; Offline access record is not oauth; Offline access record is not client_credentials; Offline access record is not an app-owned client_credentials record; Offline access record missing oauth client id.

ANY /api/v2/oauth/client_credentials/search/app

Handles oauth client credentials app.

  • Handler: thisProject\api\oauth\client_credentials\SearchApp
  • Source: lib/php/thisProject/api/oauth/client_credentials/SearchApp.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): SEARCH_APP.
  • Notable errors: Missing principal.

ANY /api/v2/oauth/client_credentials/view

Gets oauth client credentials.

  • Handler: thisProject\api\oauth\client_credentials\View
  • Source: lib/php/thisProject/api/oauth/client_credentials/View.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.
  • Notable errors: Missing principal.

ANY /api/v2/oauth/clients

Handles oauth clients.

  • Handler: thisProject\api\oauth\clients\Controller
  • Source: lib/php/thisProject/api/oauth/clients/Controller.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): service, status, endpoints, list, create, read, update, delete.

ANY /api/v2/oauth/clients/authorized

Handles oauth clients authorized.

  • Handler: thisProject\api\oauth\clients\authorized\Controller
  • Source: lib/php/thisProject/api/oauth/clients/authorized/Controller.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): service, status, endpoints, search, view, update, update_status.

ANY /api/v2/oauth/clients/authorized/search

Searches oauth clients authorized.

  • Handler: thisProject\api\oauth\clients\authorized\Search
  • Source: lib/php/thisProject/api/oauth/clients/authorized/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • provider_cid (optional/detected). Detected in handler or delegated service code.
    • provider_client_id (optional/detected). Detected in handler or delegated service code.
    • status (optional/detected). Status filter or value.
  • Response: success comment(s): OK.
  • Notable errors: invalid provider_cid.

ANY /api/v2/oauth/clients/authorized/update

Updates oauth clients authorized.

  • Handler: thisProject\api\oauth\clients\authorized\Update
  • Source: lib/php/thisProject/api/oauth/clients/authorized/Update.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): UPDATE.
  • Notable errors: missing id.

ANY /api/v2/oauth/clients/authorized/update_status

Updates status for oauth clients authorized.

  • Handler: thisProject\api\oauth\clients\authorized\UpdateStatus
  • Source: lib/php/thisProject/api/oauth/clients/authorized/UpdateStatus.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • status (required). Status filter or value.
  • Response: success comment(s): UPDATE_STATUS.
  • Notable errors: missing id; missing status.

ANY /api/v2/oauth/clients/authorized/view

Gets oauth clients authorized.

  • Handler: thisProject\api\oauth\clients\authorized\View
  • Source: lib/php/thisProject/api/oauth/clients/authorized/View.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): OK.
  • Notable errors: missing id.

ANY /api/v2/oauth/clients/connected

Handles oauth clients connected.

  • Handler: thisProject\api\oauth\clients\connected\Controller
  • Source: lib/php/thisProject/api/oauth/clients/connected/Controller.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): service, status, endpoints, search, view, insert, update.

ANY /api/v2/oauth/clients/connected/insert

Creates oauth clients connected.

  • Handler: thisProject\api\oauth\clients\connected\Insert
  • Source: lib/php/thisProject/api/oauth/clients/connected/Insert.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • audience (required). Detected in handler or delegated service code.
    • consumer_cid (required). Detected in handler or delegated service code.
  • Response: success comment(s): INSERT.
  • Notable errors: missing consumer_cid; missing audience; provider and consumer cannot be the same.

ANY /api/v2/oauth/clients/connected/search

Searches oauth clients connected.

  • Handler: thisProject\api\oauth\clients\connected\Search
  • Source: lib/php/thisProject/api/oauth/clients/connected/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • consumer_cid (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • status (optional/detected). Status filter or value.
  • Response: success comment(s): OK.
  • Notable errors: invalid consumer_cid.

ANY /api/v2/oauth/clients/connected/update

Updates oauth clients connected.

  • Handler: thisProject\api\oauth\clients\connected\Update
  • Source: lib/php/thisProject/api/oauth/clients/connected/Update.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): UPDATE.
  • Notable errors: missing id; nothing to update.

ANY /api/v2/oauth/clients/connected/view

Gets oauth clients connected.

  • Handler: thisProject\api\oauth\clients\connected\View
  • Source: lib/php/thisProject/api/oauth/clients/connected/View.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): OK.
  • Notable errors: missing id.

ANY /api/v2/oauth/clients/connections

Handles oauth clients connections.

  • Handler: thisProject\api\oauth\clients\connections\Controller
  • Source: lib/php/thisProject/api/oauth/clients/connections/Controller.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): service, status, endpoints, search, view, insert, update, verify, delete, recover, update_status.

ANY /api/v2/oauth/clients/connections/delete

Deletes oauth clients connections.

  • Handler: thisProject\api\oauth\clients\connections\Delete
  • Source: lib/php/thisProject/api/oauth/clients/connections/Delete.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • archived (optional/detected). Archived/deleted filter flag.
  • Response: success comment(s): DELETE, ARCHIVE.
  • Notable errors: missing id.

ANY /api/v2/oauth/clients/connections/insert

Creates oauth clients connections.

  • Handler: thisProject\api\oauth\clients\connections\Insert
  • Source: lib/php/thisProject/api/oauth/clients/connections/Insert.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • audience (required). Detected in handler or delegated service code.
    • consumer_cid (required). Detected in handler or delegated service code.
  • Response: success comment(s): INSERT.
  • Notable errors: missing consumer_cid; missing audience; provider and consumer cannot be the same.

ANY /api/v2/oauth/clients/connections/recover

Recovers oauth clients connections.

  • Handler: thisProject\api\oauth\clients\connections\Recover
  • Source: lib/php/thisProject/api/oauth/clients/connections/Recover.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): RECOVER.
  • Notable errors: missing id.

ANY /api/v2/oauth/clients/connections/search

Searches oauth clients connections.

  • Handler: thisProject\api\oauth\clients\connections\Search
  • Source: lib/php/thisProject/api/oauth/clients/connections/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • consumer_cid (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • provider_cid (optional/detected). Detected in handler or delegated service code.
    • provider_client_id (optional/detected). Detected in handler or delegated service code.
    • side (optional/detected). Detected in handler or delegated service code.
    • status (optional/detected). Status filter or value.
  • Response: success comment(s): OK.
  • Notable errors: invalid provider_cid; invalid consumer_cid; not found.

ANY /api/v2/oauth/clients/connections/update

Updates oauth clients connections.

  • Handler: thisProject\api\oauth\clients\connections\Update
  • Source: lib/php/thisProject/api/oauth/clients/connections/Update.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): UPDATE.
  • Notable errors: missing id; nothing to update.

ANY /api/v2/oauth/clients/connections/update_status

Updates status for oauth clients connections.

  • Handler: thisProject\api\oauth\clients\connections\UpdateStatus
  • Source: lib/php/thisProject/api/oauth/clients/connections/UpdateStatus.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • status (required). Status filter or value.
  • Response: success comment(s): UPDATE_STATUS.
  • Notable errors: missing id; missing status.

ANY /api/v2/oauth/clients/connections/verify

Verifies oauth clients connections.

  • Handler: thisProject\api\oauth\clients\connections\Verify
  • Source: lib/php/thisProject/api/oauth/clients/connections/Verify.php
  • Auth: existing API credential not required by handler constructor
  • Detected request fields:
    • token (required). Token value.
    • aud (optional/detected). Requested token audience.
    • client_id (optional/detected). Detected in handler or delegated service code.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • scope (optional/detected). Requested OAuth scope string.
    • sub (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): VERIFY.
  • Notable errors: missing token.

ANY /api/v2/oauth/clients/connections/view

Gets oauth clients connections.

  • Handler: thisProject\api\oauth\clients\connections\View
  • Source: lib/php/thisProject/api/oauth/clients/connections/View.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): OK.
  • Notable errors: missing id.

ANY /api/v2/oauth/clients/delete

Deletes oauth clients.

  • Handler: thisProject\api\oauth\clients\Delete
  • Source: lib/php/thisProject/api/oauth/clients/Delete.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: missing id; not found.

ANY /api/v2/oauth/clients/insert

Creates oauth clients.

  • Handler: thisProject\api\oauth\clients\Insert
  • Source: lib/php/thisProject/api/oauth/clients/Insert.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): TEST, INSERT.

ANY /api/v2/oauth/clients/recover

Recovers oauth clients.

  • Handler: thisProject\api\oauth\clients\Recover
  • Source: lib/php/thisProject/api/oauth/clients/Recover.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • status (optional/detected). Status filter or value.
  • Response: success comment(s): RECOVER.
  • Notable errors: missing id; not found.

ANY /api/v2/oauth/clients/search

Searches oauth clients.

  • Handler: thisProject\api\oauth\clients\Search
  • Source: lib/php/thisProject/api/oauth/clients/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.

ANY /api/v2/oauth/clients/set_auth

Handles oauth clients set auth.

  • Handler: thisProject\api\oauth\clients\SetAuth
  • Source: lib/php/thisProject/api/oauth/clients/SetAuth.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • token_endpoint_auth_method (required). Detected in handler or delegated service code.
  • Response: success comment(s): SET_AUTH.
  • Notable errors: missing id; missing token_endpoint_auth_method; not found.

ANY /api/v2/oauth/clients/set_config_lock

Handles oauth clients set config lock.

  • Handler: thisProject\api\oauth\clients\SetConfigLock
  • Source: lib/php/thisProject/api/oauth/clients/SetConfigLock.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • config_lock_hash_new (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): SET_CONFIG_LOCK.
  • Notable errors: missing id; not found.

ANY /api/v2/oauth/clients/set_knobs

Handles oauth clients set knobs.

  • Handler: thisProject\api\oauth\clients\SetKnobs
  • Source: lib/php/thisProject/api/oauth/clients/SetKnobs.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): SET_KNOBS.
  • Notable errors: missing id; not found.

ANY /api/v2/oauth/clients/tenants

Lists tenants for oauth clients.

  • Handler: thisProject\api\oauth\clients\Tenants
  • Source: lib/php/thisProject/api/oauth/clients/Tenants.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): TENANTS.

ANY /api/v2/oauth/clients/update

Updates oauth clients.

  • Handler: thisProject\api\oauth\clients\Update
  • Source: lib/php/thisProject/api/oauth/clients/Update.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • tenant (optional/detected). Detected in handler or delegated service code.
  • Response: success comment(s): UPDATE.
  • Notable errors: missing id; not found.

ANY /api/v2/oauth/clients/update_status

Updates status for oauth clients.

  • Handler: thisProject\api\oauth\clients\UpdateStatus
  • Source: lib/php/thisProject/api/oauth/clients/UpdateStatus.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • status (optional/detected). Status filter or value.
  • Response: success comment(s): UPDATE_STATUS.
  • Notable errors: missing id; not found.

ANY /api/v2/oauth/clients/view

Gets oauth clients.

  • Handler: thisProject\api\oauth\clients\View
  • Source: lib/php/thisProject/api/oauth/clients/View.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): OK.
  • Notable errors: missing id; not found.

ANY /api/v2/oauth/device/issue

Issues oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Issue
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Issue.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.

ANY /api/v2/oauth/device/pickup

Picks up oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Pickup
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Pickup.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • access_token (optional/detected). Detected in handler or delegated service code. Default: ''.
    • client_id (optional/detected). Detected in handler or delegated service code. Default: ''.
    • closed (optional/detected). Detected in handler or delegated service code. Default: null.
    • exp (optional/detected). Detected in handler or delegated service code. Default: null.
    • expires_in (optional/detected). Detected in handler or delegated service code. Default: null.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • jti (optional/detected). Detected in handler or delegated service code. Default: ''.
    • principal (optional/detected). Detected in handler or delegated service code. Default: ''.
    • principal_type (optional/detected). Detected in handler or delegated service code. Default: 'user'.
    • refresh_expires_in (optional/detected). Detected in handler or delegated service code. Default: null.
    • refresh_token (optional/detected). Detected in handler or delegated service code. Default: ''.
    • status (optional/detected). Status filter or value. Default: ''.
    • tenant (optional/detected). Detected in handler or delegated service code. Default: static::PRIMARY_TENANT.
  • Response: data key(s): status, data, id, error, comment.

ANY /api/v2/oauth/device/refresh/bundle

Handles oauth device refresh bundle.

  • Handler: thisProject\api\offline_access\oauth\device\RefreshBundle
  • Source: lib/php/thisProject/api/offline_access/oauth/device/RefreshBundle.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.

ANY /api/v2/oauth/device/revoke

Revokes oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Revoke
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Revoke.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (required). Record identifier. Many handlers accept this as the primary lookup key. Default: ''.
    • password (required). Detected in handler or delegated service code.
    • principal (required). Detected in handler or delegated service code. Default: ''.
    • access_token_hash (optional/detected). Detected in handler or delegated service code. Default: ''.
    • access_token_jti (optional/detected). Detected in handler or delegated service code. Default: ''.
    • closed (optional/detected). Detected in handler or delegated service code. Default: null.
    • comment (optional/detected). Detected in handler or delegated service code.
    • expires (optional/detected). Expiration timestamp. Default: null.
    • force (optional/detected). Detected in handler or delegated service code. Default: false.
    • method (optional/detected). Method selector or delivery method. Default: ''.
    • pass (optional/detected). Password credential.
    • principal_type (optional/detected). Detected in handler or delegated service code. Default: ''.
    • refresh_expires (optional/detected). Detected in handler or delegated service code. Default: null.
    • refresh_token_hash (optional/detected). Detected in handler or delegated service code. Default: ''.
    • refresh_token_jti (optional/detected). Detected in handler or delegated service code. Default: ''.
    • status (optional/detected). Status filter or value. Default: ''.
  • Response: data key(s): status, data, id, action, upstream, comment, rows_affected.
  • Notable errors: Machine credentials cannot revoke offline access records here; Offline access record cannot be revoked here without force; Missing principal; Missing offline access id; Invalid offline access id; Offline access record not found; Offline access record is not oauth; Only user-owned offline access records can be revoked here.

ANY /api/v2/oauth/device/search

Searches oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Search
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.
  • Notable errors: Missing principal.

ANY /api/v2/oauth/device/search/app

Handles oauth device app.

  • Handler: thisProject\api\offline_access\oauth\device\SearchApp
  • Source: lib/php/thisProject/api/offline_access/oauth/device/SearchApp.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.
  • Notable errors: Missing principal.

ANY /api/v2/oauth/device/search/user

Handles oauth device user.

  • Handler: thisProject\api\offline_access\oauth\device\SearchUser
  • Source: lib/php/thisProject/api/offline_access/oauth/device/SearchUser.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data.
  • Notable errors: Missing principal.

ANY /api/v2/oauth/device/update

Updates oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\Update
  • Source: lib/php/thisProject/api/offline_access/oauth/device/Update.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, comment.

ANY /api/v2/oauth/device/view

Gets oauth device.

  • Handler: thisProject\api\offline_access\oauth\device\View
  • Source: lib/php/thisProject/api/offline_access/oauth/device/View.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): status, data, id.

ANY /api/v2/org/client/delete

Deletes org client.

  • Handler: thisProject\api\client\Delete
  • Source: lib/php/thisProject/api/client/Delete.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): DELETED.
  • Notable errors: you do not own this org; client does not exist.

ANY /api/v2/org/client/get

Gets org client.

  • Handler: thisProject\api\client\Get
  • Source: lib/php/thisProject/api/client/Get.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • name (optional/detected). Name field.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: you do not own this org; client not found.

ANY /api/v2/org/client/group/add

Adds org client group.

  • Handler: thisProject\api\client\group\Add
  • Source: lib/php/thisProject/api/client/group/Add.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • group (optional/detected). Group id.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): ADDED.
  • Notable errors: you do not own this org; client is already a member of this group.

ANY /api/v2/org/client/group/all

Lists all org client group.

  • Handler: thisProject\api\client\group\All
  • Source: lib/php/thisProject/api/client/group/All.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): Groups.
  • Notable errors: you do not own this org.

ANY /api/v2/org/client/group/get

Gets org client group.

  • Handler: thisProject\api\client\group\Get
  • Source: lib/php/thisProject/api/client/group/Get.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • group (optional/detected). Group id.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • name (optional/detected). Name field.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: you do not own this org; client not found.

ANY /api/v2/org/client/group/remove

Removes org client group.

  • Handler: thisProject\api\client\group\Remove
  • Source: lib/php/thisProject/api/client/group/Remove.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • group (optional/detected). Group id.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): REMOVED.
  • Notable errors: you do not own this org.

ANY /api/v2/org/client/group/search

Searches org client group.

  • Handler: thisProject\api\client\group\Search
  • Source: lib/php/thisProject/api/client/group/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • name (optional/detected). Name field.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): Groups.
  • Notable errors: you do not own this org; requires id or name.

ANY /api/v2/org/client/group/set

Handles org client group set.

  • Handler: thisProject\api\client\group\Set
  • Source: lib/php/thisProject/api/client/group/Set.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • client (optional/detected). Client id.
    • group (optional/detected). Group id.
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): update.
  • Notable errors: you do not own this org.

ANY /api/v2/org/client/insert

Creates org client.

  • Handler: thisProject\api\client\Insert
  • Source: lib/php/thisProject/api/client/Insert.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • name (required). Name field.
    • org (required). Organization id or slug depending on the handler.
  • Response: success comment(s): OK.
  • Notable errors: Invalid Path; missing org; missing name; you do not own this org; unable to create a client, try again or contact the administrator.

ANY /api/v2/org/client/password

Handles org client password.

  • Handler: thisProject\api\client\ChangePass
  • Source: lib/php/thisProject/api/client/ChangePass.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • confirm (required). Password confirmation.
    • data.id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • id (required). Record identifier. Many handlers accept this as the primary lookup key.
    • org (required). Organization id or slug depending on the handler.
    • pass (required). Password credential.
    • auth.dpop (optional/detected). DPoP proof value forwarded to downstream auth services.
    • auth.fingerprint (optional/detected). Caller/device fingerprint value used for token binding.
    • auth.htu (optional/detected). HTTP target URI used with DPoP validation.
  • Response: success comment(s): PASSWORDCREATED, CHANGED.
  • Notable errors: Invalid Path; missing org; Missing id / pass / confirm; you do not own this org; client not found; client is aliased to a user, user must directly manage instead.; client password was unable to be created; unable to change password.

ANY /api/v2/org/client/restore

Restores org client.

  • Handler: thisProject\api\client\Restore
  • Source: lib/php/thisProject/api/client/Restore.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): RESTORED.
  • Notable errors: you do not own this org; client does not exist.

ANY /api/v2/org/client/search

Searches org client.

  • Handler: thisProject\api\client\Search
  • Source: lib/php/thisProject/api/client/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • archived (optional/detected). Archived/deleted filter flag.
    • org (optional/detected). Organization id or slug depending on the handler.
    • search (optional/detected). Free-text or key/value search string.
  • Response: success comment(s): ok.
  • Notable errors: you do not own this org.

ANY /api/v2/org/client/update

Updates org client.

  • Handler: thisProject\api\client\Set
  • Source: lib/php/thisProject/api/client/Set.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): update.
  • Notable errors: you do not own this org; client not found.

ANY /api/v2/org/delete

Deletes org.

  • Handler: thisProject\api\org\Delete
  • Source: lib/php/thisProject/api/org/Delete.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): DELETED.

ANY /api/v2/org/get

Gets org.

  • Handler: thisProject\api\org\Get
  • Source: lib/php/thisProject/api/org/Get.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: JSON response from the handler/delegated service.

ANY /api/v2/org/group/delete

Deletes org group.

  • Handler: thisProject\api\group\Delete
  • Source: lib/php/thisProject/api/group/Delete.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): DELETED.
  • Notable errors: you do not own this org.

ANY /api/v2/org/group/get

Gets org group.

  • Handler: thisProject\api\group\Get
  • Source: lib/php/thisProject/api/group/Get.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: you do not own this org.

ANY /api/v2/org/group/insert

Creates org group.

  • Handler: thisProject\api\group\Insert
  • Source: lib/php/thisProject/api/group/Insert.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): INSERT.
  • Notable errors: you do not own this org.

ANY /api/v2/org/group/restore

Restores org group.

  • Handler: thisProject\api\group\Restore
  • Source: lib/php/thisProject/api/group/Restore.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): RESTORED.
  • Notable errors: you do not own this org.

ANY /api/v2/org/group/search

Searches org group.

  • Handler: thisProject\api\group\Search
  • Source: lib/php/thisProject/api/group/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • archived (optional/detected). Archived/deleted filter flag.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: JSON response from the handler/delegated service.
  • Notable errors: you do not own this org.

ANY /api/v2/org/group/update

Updates org group.

  • Handler: thisProject\api\group\Set
  • Source: lib/php/thisProject/api/group/Set.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
    • org (optional/detected). Organization id or slug depending on the handler.
  • Response: success comment(s): update.
  • Notable errors: you do not own this org.

ANY /api/v2/org/identity

Handles org identity.

  • Handler: thisProject\api\org\identity\Controller
  • Source: lib/php/thisProject/api/org/identity/Controller.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: data key(s): ep.

ANY /api/v2/org/identity/get

Gets org identity.

  • Handler: thisProject\api\org\identity\Get
  • Source: lib/php/thisProject/api/org/identity/Get.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): GET.

ANY /api/v2/org/identity/set

Handles org identity set.

  • Handler: thisProject\api\org\identity\Set
  • Source: lib/php/thisProject/api/org/identity/Set.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • confirm (required). Password confirmation.
    • pass (required). Password credential.
    • active (optional/detected). Detected in handler or delegated service code. Default: false.
  • Response: success comment(s): CREATED, RECREATED, UPDATED.
  • Notable errors: Missing pass / confirm.

ANY /api/v2/org/insert

Creates org.

  • Handler: thisProject\api\org\Insert
  • Source: lib/php/thisProject/api/org/Insert.php
  • Auth: credentials validated by base controller by default
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): INSERT.

ANY /api/v2/org/restore

Restores org.

  • Handler: thisProject\api\org\Restore
  • Source: lib/php/thisProject/api/org/Restore.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): RESTORED.

ANY /api/v2/org/search

Searches org.

  • Handler: thisProject\api\org\Search
  • Source: lib/php/thisProject/api/org/Search.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • archived (optional/detected). Archived/deleted filter flag.
  • Response: JSON response from the handler/delegated service.

ANY /api/v2/org/update

Updates org.

  • Handler: thisProject\api\org\Set
  • Source: lib/php/thisProject/api/org/Set.php
  • Auth: credentials validated by base controller by default
  • Detected request fields:
    • id (optional/detected). Record identifier. Many handlers accept this as the primary lookup key.
  • Response: success comment(s): update.

ANY /api/v2/session/me

Handles session.

  • Handler: thisProject\api\session\Me
  • Source: lib/php/thisProject/api/session/Me.php
  • Auth: existing API credential not required by handler constructor
  • Detected request fields: none in the handler; endpoint may be informational or delegates opaque input.
  • Response: success comment(s): OK.
  • Notable errors: Invalid Path; Invalid token; application tokens are not supported here; unsupported {$type} token for {$principal} principal.
1