v1

latestOpenAPI 3.0.22026-07-223907721.1 MB

appRegistration

Register App

Send a registration request for an (external) application

post/v2/authentication

Headers

x-tenant-idstring uuid required

The tenant ID for the target ERP instance.

x-challengecodestring required

You can enter any custom value here. The X-ChallengeCode is used during app registration and must be the same for all registration requests. The maximum length is 30 characters.

Request body

appIdstring

Unique identifier of the application

displayNamestring

Default display name of the application

descriptionstring

Default description of the application

versionstring

Version of the application to be registered

providerNamestring

Name of the application's provider

providerWebsitestring

Website of the application's provider

mandatoryApiScopesstring[]

Mandatory required API scopes for the application to work

optionalApiScopesstring[]

Optional (recommended) API scopes for the application

appIconstring byte

Base64 encoded data of an image.

registrationType0 | 1 | 2 | 3

0 = OneInstance, 1 = MultiInstance, 2 = PerUserInstance, 3 = PerUserLoginInstance

signaturestring byte

The Signature of the App, it combines AppId.SignatureData like myApp/v1.2025-08-03T25:48:00 in UTC Time

signatureDatastring date-time

The Data as DateTimeOffset must be in a range from 10 Minutes equals, and is base for the Signature and must be in UTC Time

Response

Status of the registration process (including the unique identifiers for application and registration request)

appIdstring

Unique identifier of the application

registrationRequestIdstring

Unique identifier of the registration request

status0 | 1 | 2

0 = Pending, 1 = Rejected, 2 = Accepted