AppWorld

Authentication

Authenticate

External Authenticate

Send Two-Factor Code

Impersonate Authenticate

Delegated Impersonate Authenticate

Linked Account Authenticate

Refresh Token

Logout

Session

Accounts

Account

Profile

User Link

User Delegation

Friendship

User Administration

Roles

Get Roles

Get Role

Create or Update Role

Delete Role

Organization Unit

Communication

Chat

Push Notification

Notification

App (Tenant)

Is App Available

Resolve App (Heartbeat)

File Server

Create File

Get File

Delete File

Get All Files

Get Raw File

Get Raw File Small

Get File Stream Url

System

Audit Logs

Caching

Timing

Language

Web Logs

Webhooks

Getting Started

Ofmi Dev API Docs

Production

Sandbox

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 &apos;App-Id: 88&apos;To get your integration settings please follow these steps:1. Register/Login here: https://portal.appworldsa.com/#/account/login2. Create a new App from the Marketplace3. Select Manage App4. Navigate here: https://portal.appworldsa.com/#/app/main/projects/settings<div class="slate-div"></div><div class="slate-div"></div>

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 

To get your integration settings please follow these steps:

1. Register/Login here: https://portal.appworldsa.com/#/account/login

4. Navigate here: https://portal.appworldsa.com/#/app/main/projects/settings

userNameOrEmailAddress

password

twoFactorVerificationCode

rememberClient

twoFactorRememberClientToken

singleSignIn

returnUrl

captchaResponse

App-Id

accessToken

encryptedAccessToken

expireInSeconds

shouldResetPassword

passwordResetCode

userId

requiresTwoFactorVerification

twoFactorAuthProviders

refreshToken

refreshTokenExpireInSeconds

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.

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.

authProvider

providerKey

providerAccessCode

waitingForActivation

The &quot;Send Two-Factor Code&quot; 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.

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.

The provider parameter specifies the authentication provider for sending the two-factor authentication code.

provider

Authorization

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&apos;s account. This feature is useful for testing user-specific functionalities or troubleshooting issues on behalf of another user.

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.

impersonationToken

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.

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.

userDelegationId

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.

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.

switchAccountToken

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.

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.

The &quot;Logout&quot; 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.

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.

Sections