Skip to main content
PATCH
/
authentication
/
foreign
/
{registrationId}
/
registration
Update Foreign App By Registration Id
curl --request PATCH \
  --url https://api.jtl-cloud.com/erp/authentication/foreign/{registrationId}/registration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --header 'x-appid: <x-appid>' \
  --header 'x-appversion: <x-appversion>' \
  --header 'x-challengecode: <x-challengecode>' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "AppId": "<string>",
  "DisplayName": "<string>",
  "Description": "<string>",
  "LocalizedDisplayNames": [
    {
      "LanguageIso": "<string>",
      "Name": "<string>"
    }
  ],
  "LocalizedDescriptions": [
    {
      "LanguageIso": "<string>",
      "Name": "<string>"
    }
  ],
  "Version": "<string>",
  "ProviderName": "<string>",
  "ProviderWebsite": "<string>",
  "MandatoryApiScopes": [
    "<string>"
  ],
  "OptionalApiScopes": [
    "<string>"
  ],
  "AppIcon": "aSDinaTvuI8gbWludGxpZnk=",
  "RegistrationType": 0,
  "Signature": "aSDinaTvuI8gbWludGxpZnk=",
  "SignatureData": "2023-11-07T05:31:56Z"
}
'
{
  "RequestStatusInfo": {
    "AppId": "<string>",
    "RegistrationRequestId": "<string>",
    "Status": 0
  },
  "Token": {
    "ApiKey": "<string>"
  },
  "GrantedScopes": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

x-api-key
string
header
required

Optional: If no token is present, the API Gateway injects it.

Headers

api-version
string

Specify the desired API version, e.g. '1.0'. If not provided, the last available version is set.

x-appid
string
required

This is the name of your application, e.g. "MyApp/1.0.0". It is used to identify your application.

x-appversion
string
required

This is where the version number of your application is entered, e.g. "1.0.0".

x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

X-SessionId
string<uuid>

The id of a session in which the call will be executed.

x-challengecode
string
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.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

registrationId
string<guid>
required

Unique identifier of the registration request

Body

application/json

Contains the registration request's data

Model Class: UpdateAppRegistrationRequest

AppId
string

Unique identifier of the application

DisplayName
string

Default display name of the application

Description
string

Default description of the application

LocalizedDisplayNames
object[]

Localized display names of the application

LocalizedDescriptions
object[]

Localized descriptions of the application

Version
string

Version of the application to be registered

ProviderName
string

Name of the application's provider

ProviderWebsite
string

Website of the application's provider

MandatoryApiScopes
string[]

Mandatory required API scopes for the application to work

OptionalApiScopes
string[]

Optional (recommended) API scopes for the application

AppIcon
string<byte>

Base64 encoded data of an image.

RegistrationType
enum<integer>

multiple instances of the application possible

Available options:
0,
1,
2,
3
Signature
string<byte>

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

SignatureData
string<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

The App Registration is Updated

Model Class: RegistrationInformation

RequestStatusInfo
object
required

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

Token
object

Generated token for the application to access the API

GrantedScopes
string[]

API scopes (both mandatory and optional) granted to the application