Update App Settings

The Update App Settings API will update the app settings details which is configured in the realm settings.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

HTTP request URL

PUT http://{hostname}/auth/realms/{tenantId}/v4_realm/appsettings

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body

Field Name	Type	Description
flutter_ios_version	String	flutter_ios_version is the result of the ios version.
flutter_android_link	String	flutter_android_link is the URL for the playstore.
flutter_android_version	String	flutter_android_version is the result of the andriod version.
flutter_android_update_by	String	flutter_android_update_by results the timestamp of the last update.
flutter_ios_update_by	String	flutter_ios_update_by results the timestamp of the last update.
flutter_ios_link	String	flutter_ios_link is the URL for the appstore.
flutter_android_build_number	String	flutter_android_build_number is the number of android releases for a version. (Every build has its own unique number)
flutter_ios_build_number	String	flutter_ios_build_number is the number of ios releases for a version. (Every build has its own unique number)
macos_link	String	macos_link is the URL for the playstore.
macos_version	String	macos_version is the result of the macos version.
macos_update_by	String	macos_update_by results the timestamp of the last update.
macos_build_number	String	macos_build_number is the number of macos releases for a version. (Every build has its own unique number)
windows_link	String	windows_link is the URL for the playstore.
windows_version	String	windows_version is the result of the windows version.
windows_update_by	String	windows_update_by results the timestamp of the last update.
windows_build_number	String	windows_build_number is the number of windows releases for a version. (Every build has its own unique number)
huawei_version	String	huawei_version is the result of the huawei version.
huawei_link	String	huawei_link is the URL for the playstore.
huawei_update_by	String	huawei_update_by results the timestamp of the last update.
huawei_build_number	String	huawei_build_number is the number of huawei releases for a version. (Every build has its own unique number)

Sample Request

{
    "flutter_ios_version": "2.5.5",
    "flutter_android_link": "https://google.com",
    "macos_link": "",
    "macos_version": "",
    "windows_link": "",
    "windows_version": "",
    "macos_build_number": "",
    "flutter_ios_build_number": "000",
    "flutter_android_version": "2.5.5",
    "flutter_android_update_by": "30.07.2023",
    "flutter_ios_update_by": "30.07.2023",
    "windows_update_by": "",
    "flutter_ios_link": "https://google.com",
    "macos_update_by": "",
    "flutter_android_build_number": "000",
    "windows_build_number": ""
    "huawei_version": "2.5.5",
    "huawei_link": "https://google.com",
    "huawei_update_by": "30.07.2023",
    "huawei_build_number": "000"
}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

 { 

    "message": "Tenant updated successfully",
    "status": "OK",
    "subSystem": 1

}

Response Status Information

Status Code	Status
200	OK
404	Realm does not exist
401	HTTP 401 Unauthorized