Sign in
latestOpenAPI 3.1.0Apache License Version 2.02026-08-17498525913.3 KB

40169ccdec5c

mobile-app-controller

Save Or update Mobile app (saveMobileApp)

Create or update the Mobile app. When creating mobile app, platform generates Mobile App Id as time-based UUID. The newly created Mobile App Id will be present in the response. Specify existing Mobile App Id to update the mobile app. Referencing non-existing Mobile App Id will cause 'Not Found' error.

The pair of mobile app package name and platform type is unique for entire platform setup.

Available for users with 'SYS_ADMIN' or 'TENANT_ADMIN' authority.

post/api/mobile/app

Request body

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

pkgNamestring required

Application package name. Cannot be empty

titlestring

Application title

appSecretstring required

Application secret. The length must be at least 16 characters

platformType'WEB' | 'ANDROID' | 'IOS' required

Application platform type: ANDROID or IOS

status'DRAFT' | 'PUBLISHED' | 'DEPRECATED' | 'SUSPENDED' required

Application status: PUBLISHED, DEPRECATED, SUSPENDED, DRAFT

namestring

Mobile app package name

Example request

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "name": "my.mobile.app"
}

Response

OK

createdTimeinteger

Entity creation timestamp in milliseconds since Unix epoch

pkgNamestring required

Application package name. Cannot be empty

titlestring

Application title

appSecretstring required

Application secret. The length must be at least 16 characters

platformType'WEB' | 'ANDROID' | 'IOS' required

Application platform type: ANDROID or IOS

status'DRAFT' | 'PUBLISHED' | 'DEPRECATED' | 'SUSPENDED' required

Application status: PUBLISHED, DEPRECATED, SUSPENDED, DRAFT

namestring

Mobile app package name

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "DEVICE"
  },
  "createdTime": 1746028547220,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "name": "my.mobile.app"
}