Ofmi Dev API Docs ## Sections • [Authenticate](https://app.theneo.io/appworldsa/ofmi/authentication/authenticate.md): The Authenticate section allows users to securely log in to their account and obtain access tokens for authentication purposes. By providing the necessary credentials, users can authenticate their identity and access protected resources within the API. This section facilitates the secure verification process for users to interact with the API seamlessly. Important: Set the correct App Id in the header of the request --header 'App-Id: 88' To get your integration settings please follow these steps: 1. Register/Login here: https://portal.appworldsa.com/#/account/login 2. Create a new App from the Marketplace 3. Select Manage App 4. Navigate here: https://portal.appworldsa.com/#/app/main/projects/settings • [External Authenticate](https://app.theneo.io/appworldsa/ofmi/authentication/external-authenticate.md): The External Authenticate section allows users to authenticate via external providers and gain access to the system. By providing the necessary authentication details, users can securely sign in using their external credentials and obtain access tokens for seamless integration with the platform. This functionality simplifies the login process and enhances user experience by enabling external authentication methods. • [Send Two-Factor Code](https://app.theneo.io/appworldsa/ofmi/authentication/send-two-factor-code.md): The "Send Two-Factor Code" section allows users to trigger the delivery of a two-factor authentication code to a specified user. This functionality enhances security by requiring an additional verification step before granting access to the system. Users can easily implement this feature to strengthen their authentication process and protect sensitive data. • [Impersonate Authenticate](https://app.theneo.io/appworldsa/ofmi/authentication/impersonate-authenticate.md): The Impersonate Authenticate section allows users to authenticate as another user within the system. By providing the necessary parameters, users can generate an access token that grants them temporary access to the specified user's account. This feature is useful for testing user-specific functionalities or troubleshooting issues on behalf of another user. • [Delegated Impersonate Authenticate](https://app.theneo.io/appworldsa/ofmi/authentication/delegated-impersonate-authenticate.md): This section enables users to authenticate as a different user in a delegated manner. By using this feature, users can securely impersonate another user for specific actions or tasks within the system. This functionality enhances security and access control for delegated actions. • [Linked Account Authenticate](https://app.theneo.io/appworldsa/ofmi/authentication/linked-account-authenticate.md): The Linked Account Authenticate section allows users to securely authenticate linked accounts and retrieve access tokens for authorized actions. By using this functionality, users can seamlessly switch between accounts and access sensitive data within the platform. This process enhances user experience and ensures data security during account interactions. • [Refresh Token](https://app.theneo.io/appworldsa/ofmi/authentication/refresh-token.md): The Refresh Token section allows users to generate a new access token to maintain secure access to their resources. By utilizing this functionality, users can extend their session expiration time without the need to re-authenticate. • [Logout](https://app.theneo.io/appworldsa/ofmi/authentication/logout.md): The "Logout" section allows users to securely end their current session and log out of the system. By accessing this functionality, users can ensure their account remains protected and confidential information is not accessible to unauthorized individuals. • [Get Current Login Information](https://app.theneo.io/appworldsa/ofmi/authentication/session/get-current-login-information.md): This section allows users to retrieve the current login information associated with the user and tenant, including details like user name, email address, profile picture, and subscription details. By accessing this endpoint, users can obtain essential information about their current login session without the need for additional authentication. • [Update Signin Token](https://app.theneo.io/appworldsa/ofmi/authentication/session/update-signin-token.md): The "Api Services App Session Updateusersignintoken Put" section allows users to update the sign-in token for a user session within the application. By using this API service, users can seamlessly manage user authentication and security tokens, ensuring a secure and efficient user experience. This feature enhances the overall functionality of the application by enabling seamless user session maintenance. • [Register](https://app.theneo.io/appworldsa/ofmi/accounts/account/register.md): The "Api Services App Account Register Post" section allows users to register a new account within the application. By providing the necessary information, users can create an account and gain access to the platform's features. This API call enables seamless user onboarding and account creation processes. • [Send Password Reset Code](https://app.theneo.io/appworldsa/ofmi/accounts/account/send-password-reset-code.md) • [Reset Password](https://app.theneo.io/appworldsa/ofmi/accounts/account/reset-password.md) • [Send Email Activation Link](https://app.theneo.io/appworldsa/ofmi/accounts/account/send-email-activation-link.md) • [Activate Email](https://app.theneo.io/appworldsa/ofmi/accounts/account/activate-email.md) • [Change Email](https://app.theneo.io/appworldsa/ofmi/accounts/account/change-email.md) • [Verify Authenticator Code](https://app.theneo.io/appworldsa/ofmi/accounts/profile/google-authenticator/verify-authenticator-code.md) • [Update Google Authenticator Key](https://app.theneo.io/appworldsa/ofmi/accounts/profile/google-authenticator/update-google-authenticator-key.md) • [Generate Google Authenticator Key](https://app.theneo.io/appworldsa/ofmi/accounts/profile/google-authenticator/generate-google-authenticator-key.md) • [View Recovery Codes](https://app.theneo.io/appworldsa/ofmi/accounts/profile/google-authenticator/view-recovery-codes.md) • [Disable Google Authenticator](https://app.theneo.io/appworldsa/ofmi/accounts/profile/google-authenticator/disable-google-authenticator.md) • [Verify SMS Code](https://app.theneo.io/appworldsa/ofmi/accounts/profile/sms/verify-sms-code.md) • [Send Verification SMS](https://app.theneo.io/appworldsa/ofmi/accounts/profile/sms/send-verification-sms.md) • [Get Avatars](https://app.theneo.io/appworldsa/ofmi/accounts/profile/avatar/get-avatars.md) • [Set Avatar](https://app.theneo.io/appworldsa/ofmi/accounts/profile/avatar/set-avatar.md) • [Get User Profile](https://app.theneo.io/appworldsa/ofmi/accounts/profile/get-user-profile.md) • [Update Profile](https://app.theneo.io/appworldsa/ofmi/accounts/profile/update-profile.md) • [Retrieve Profile Collected Data](https://app.theneo.io/appworldsa/ofmi/accounts/profile/retrieve-profile-collected-data.md) • [Change Password](https://app.theneo.io/appworldsa/ofmi/accounts/profile/change-password.md) • [Update Profile Picture](https://app.theneo.io/appworldsa/ofmi/accounts/profile/update-profile-picture.md) • [Get Profile Picture](https://app.theneo.io/appworldsa/ofmi/accounts/profile/get-profile-picture.md) • [Get Profile Picture by Username](https://app.theneo.io/appworldsa/ofmi/accounts/profile/get-profile-picture-by-username.md) • [Get Profile Picture by User Id](https://app.theneo.io/appworldsa/ofmi/accounts/profile/get-profile-picture-by-user-id.md) • [Change Language](https://app.theneo.io/appworldsa/ofmi/accounts/profile/change-language.md) • [Get User Login Attempts](https://app.theneo.io/appworldsa/ofmi/accounts/profile/get-user-login-attempts.md) • [Delete Me](https://app.theneo.io/appworldsa/ofmi/accounts/profile/delete-me.md) • [Link to User](https://app.theneo.io/appworldsa/ofmi/accounts/user-link/link-to-user.md) • [Get Linked Users](https://app.theneo.io/appworldsa/ofmi/accounts/user-link/get-linked-users.md) • [Get Recently Used Linked Users](https://app.theneo.io/appworldsa/ofmi/accounts/user-link/get-recently-used-linked-users.md) • [User Link Unlink](https://app.theneo.io/appworldsa/ofmi/accounts/user-link/user-link-unlink.md) • [Get Delegated Users](https://app.theneo.io/appworldsa/ofmi/accounts/user-delegation/get-delegated-users.md) • [Delegate New User](https://app.theneo.io/appworldsa/ofmi/accounts/user-delegation/delegate-new-user.md) • [Remove Delegation](https://app.theneo.io/appworldsa/ofmi/accounts/user-delegation/remove-delegation.md) • [Get Active User Delegations](https://app.theneo.io/appworldsa/ofmi/accounts/user-delegation/get-active-user-delegations.md) • [Get Friend Profile Picture](https://app.theneo.io/appworldsa/ofmi/accounts/friendship/get-friend-profile-picture.md) • [Create Friendship Request](https://app.theneo.io/appworldsa/ofmi/accounts/friendship/create-friendship-request.md) • [Create Friendship by Username](https://app.theneo.io/appworldsa/ofmi/accounts/friendship/create-friendship-by-username.md) • [Block User](https://app.theneo.io/appworldsa/ofmi/accounts/friendship/block-user.md) • [Unblock User](https://app.theneo.io/appworldsa/ofmi/accounts/friendship/unblock-user.md) • [Accept Friendship Request](https://app.theneo.io/appworldsa/ofmi/accounts/friendship/accept-friendship-request.md) • [Remove Friend](https://app.theneo.io/appworldsa/ofmi/accounts/friendship/remove-friend.md) • [Get Users](https://app.theneo.io/appworldsa/ofmi/accounts/user-administration/get-users.md) • [Get Users to Excel](https://app.theneo.io/appworldsa/ofmi/accounts/user-administration/get-users-to-excel.md) • [Get User](https://app.theneo.io/appworldsa/ofmi/accounts/user-administration/get-user.md) • [Create or Update User](https://app.theneo.io/appworldsa/ofmi/accounts/user-administration/create-or-update-user.md) • [Delete User](https://app.theneo.io/appworldsa/ofmi/accounts/user-administration/delete-user.md) • [Unlock User](https://app.theneo.io/appworldsa/ofmi/accounts/user-administration/unlock-user.md) • [Get All Permissions](https://app.theneo.io/appworldsa/ofmi/accounts/user-administration/permission/get-all-permissions.md) • [Update User Permissions](https://app.theneo.io/appworldsa/ofmi/accounts/user-administration/permission/update-user-permissions.md) • [Reset User Permissions](https://app.theneo.io/appworldsa/ofmi/accounts/user-administration/permission/reset-user-permissions.md) • [Get Roles](https://app.theneo.io/appworldsa/ofmi/roles/get-roles.md) • [Get Role](https://app.theneo.io/appworldsa/ofmi/roles/get-role.md) • [Create or Update Role](https://app.theneo.io/appworldsa/ofmi/roles/create-or-update-role.md) • [Delete Role](https://app.theneo.io/appworldsa/ofmi/roles/delete-role.md) • [Get Organization Units](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/get-organization-units.md) • [Get Organization Unit Users](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/get-organization-unit-users.md) • [Get Organization Unit Roles](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/get-organization-unit-roles.md) • [Create Organization Unit](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/create-organization-unit.md) • [Update Organization Unit](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/update-organization-unit.md) • [Move Organization Unit](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/move-organization-unit.md) • [Delete Organization Unit](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/delete-organization-unit.md) • [Remove User from Organization Unit](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/remove-user-from-organization-unit.md) • [Remove Role from Organization Unit](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/remove-role-from-organization-unit.md) • [Add Users to Organization Unit](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/add-users-to-organization-unit.md) • [Add Roles to Organization Unit](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/add-roles-to-organization-unit.md) • [Find Organization Unit Users](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/find-organization-unit-users.md) • [Find Organization Unit Roles](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/find-organization-unit-roles.md) • [Organization Units](https://app.theneo.io/appworldsa/ofmi/roles/organization-unit/organization-units.md) • [Get Friend Settings](https://app.theneo.io/appworldsa/ofmi/communication/chat/get-friend-settings.md) • [Get Chat Messages](https://app.theneo.io/appworldsa/ofmi/communication/chat/get-chat-messages.md) • [Mark All Unread Messages as Read](https://app.theneo.io/appworldsa/ofmi/communication/chat/mark-all-unread-messages-as-read.md) • [Register New Device](https://app.theneo.io/appworldsa/ofmi/communication/push-notification/register-new-device.md) • [Get User Notifications](https://app.theneo.io/appworldsa/ofmi/communication/notification/get-user-notifications.md) • [Set All Notifications as Read](https://app.theneo.io/appworldsa/ofmi/communication/notification/set-all-notifications-as-read.md) • [Set All Version Notifications as Read](https://app.theneo.io/appworldsa/ofmi/communication/notification/set-all-version-notifications-as-read.md) • [Set Notification as Read](https://app.theneo.io/appworldsa/ofmi/communication/notification/set-notification-as-read.md) • [Get Notification Settings](https://app.theneo.io/appworldsa/ofmi/communication/notification/get-notification-settings.md) • [Should User Update App](https://app.theneo.io/appworldsa/ofmi/communication/notification/should-user-update-app.md) • [Update Notification Settings](https://app.theneo.io/appworldsa/ofmi/communication/notification/update-notification-settings.md) • [Delete Notification](https://app.theneo.io/appworldsa/ofmi/communication/notification/delete-notification.md) • [Delete Notifications](https://app.theneo.io/appworldsa/ofmi/communication/notification/delete-notifications.md) • [Send Mass Notification](https://app.theneo.io/appworldsa/ofmi/communication/notification/send-mass-notification.md) • [Send New Version Released Notification](https://app.theneo.io/appworldsa/ofmi/communication/notification/send-new-version-released-notification.md) • [Get All Notifiers](https://app.theneo.io/appworldsa/ofmi/communication/notification/get-all-notifiers.md) • [Get Notifications Published by User](https://app.theneo.io/appworldsa/ofmi/communication/notification/get-notifications-published-by-user.md) • [Is App Available](https://app.theneo.io/appworldsa/ofmi/app-tenant/is-app-available.md) • [Resolve App (Heartbeat)](https://app.theneo.io/appworldsa/ofmi/app-tenant/resolve-app-heartbeat.md) • [Create File](https://app.theneo.io/appworldsa/ofmi/file-server/create-file.md) • [Get File](https://app.theneo.io/appworldsa/ofmi/file-server/get-file.md) • [Delete File](https://app.theneo.io/appworldsa/ofmi/file-server/delete-file.md) • [Get All Files](https://app.theneo.io/appworldsa/ofmi/file-server/get-all-files.md) • [Get Raw File](https://app.theneo.io/appworldsa/ofmi/file-server/get-raw-file.md) • [Get Raw File Small](https://app.theneo.io/appworldsa/ofmi/file-server/get-raw-file-small.md) • [Get File Stream Url](https://app.theneo.io/appworldsa/ofmi/file-server/get-file-stream-url.md) • [Get Audit Logs](https://app.theneo.io/appworldsa/ofmi/system/audit-logs/get-audit-logs.md) • [Get Audit Logs to Excel](https://app.theneo.io/appworldsa/ofmi/system/audit-logs/get-audit-logs-to-excel.md) • [Get Entity Changes](https://app.theneo.io/appworldsa/ofmi/system/audit-logs/change-tracking/get-entity-changes.md) • [Get Entity Changes to Excel](https://app.theneo.io/appworldsa/ofmi/system/audit-logs/change-tracking/get-entity-changes-to-excel.md) • [Get Entity Property Changes](https://app.theneo.io/appworldsa/ofmi/system/audit-logs/change-tracking/get-entity-property-changes.md) • [Get Entity Type Changes](https://app.theneo.io/appworldsa/ofmi/system/audit-logs/change-tracking/get-entity-type-changes.md) • [Get Entity History Object Types](https://app.theneo.io/appworldsa/ofmi/system/audit-logs/change-tracking/get-entity-history-object-types.md) • [Get All Caches](https://app.theneo.io/appworldsa/ofmi/system/caching/get-all-caches.md) • [Clear Cache](https://app.theneo.io/appworldsa/ofmi/system/caching/clear-cache.md) • [Clear All Caches](https://app.theneo.io/appworldsa/ofmi/system/caching/clear-all-caches.md) • [Can Clear Caches](https://app.theneo.io/appworldsa/ofmi/system/caching/can-clear-caches.md) • [Get Time Zones](https://app.theneo.io/appworldsa/ofmi/system/timing/get-time-zones.md) • [Get Time Zones Selection](https://app.theneo.io/appworldsa/ofmi/system/timing/get-time-zones-selection.md) • [Get Languages](https://app.theneo.io/appworldsa/ofmi/system/language/get-languages.md) • [Get Language](https://app.theneo.io/appworldsa/ofmi/system/language/get-language.md) • [Create or Update Language](https://app.theneo.io/appworldsa/ofmi/system/language/create-or-update-language.md) • [Delete Language](https://app.theneo.io/appworldsa/ofmi/system/language/delete-language.md) • [Set Default Language](https://app.theneo.io/appworldsa/ofmi/system/language/set-default-language.md) • [Get Language Texts](https://app.theneo.io/appworldsa/ofmi/system/language/get-language-texts.md) • [Update Language Text](https://app.theneo.io/appworldsa/ofmi/system/language/update-language-text.md) • [Get Latest Web Logs](https://app.theneo.io/appworldsa/ofmi/system/web-logs/get-latest-web-logs.md) • [Download Web Logs](https://app.theneo.io/appworldsa/ofmi/system/web-logs/download-web-logs.md) • [Webhooks](https://app.theneo.io/appworldsa/ofmi/system/webhooks.md): The WebhookSendAttempt section allows users to track the status of a webhook delivery attempt. By accessing this API, users can monitor the success or failure of sending webhooks and take appropriate actions based on the response. This section provides valuable insights into the delivery status of webhooks, helping users ensure timely and accurate communication with their integrated systems. • [Get Webhook Event](https://app.theneo.io/appworldsa/ofmi/system/webhooks/get-webhook-event.md): This section allows users to retrieve webhooks events associated with their app. By making a request to this API service, users can access information such as webhook names, data, creation time, tenant ID, and more. This functionality enables users to monitor and manage webhook events relevant to their application. • [Webhook Send Attempt Get All](https://app.theneo.io/appworldsa/ofmi/system/webhooks/webhook-send-attempt-get-all.md): The Webhook Send Attempt Get All section allows users to retrieve all webhook send attempts within a specific subscription. Users can access information such as webhook event IDs, response data, and creation timestamps to track the status of their webhook notifications effectively. This section provides an overview of all send attempts for monitoring and troubleshooting purposes. • [Webhook Send Attempt Get](https://app.theneo.io/appworldsa/ofmi/system/webhooks/webhook-send-attempt-get.md): This API section allows users to retrieve all send attempts associated with a specific webhook event. Users can access details such as the response status code, creation time, and webhook subscription ID for each send attempt. This functionality provides valuable insights into the delivery status of webhook notifications. • [Webhook Send Attempt Resend](https://app.theneo.io/appworldsa/ofmi/system/webhooks/webhook-send-attempt-resend.md): This section allows users to trigger a resend attempt for a webhook send operation. By utilizing this functionality, users can ensure that any missed or failed webhook notifications are reattempted for successful delivery. This feature helps maintain consistent communication between the application and external services.