Config

Get tenant core configuration

get

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/config

Returns the tenant name, favicon URLs, effective public URI, enabled extensions, and tenant language settings.

Authorization

Requires tenant.core:read scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Responses

200

Configuration returned.

text/plainapplication/jsontext/json

Tenant core configuration response

namestring · min: 1Required

Name of the tenant.

logoUrlstring · nullableOptional

Optional logo URL.

appTitlestring · nullableOptional

Optional browser/application title override.

statusinteger · enumOptional

Tenant operational status.

Possible values:

purposeinteger · enumOptional

Tenant usage purpose.

Possible values:

publicUristring · min: 1Required

Effective public base URI used for end-user links.

defaultLanguagestring · min: 1Required

Default language configured for the tenant.

availableLanguagesstring[]Required

List of languages available for the tenant.

extensionsstring[]Required

List of enabled extensions for this tenant.

get

/api/{tenantId}/admin/config

HTTPcURLJavaScriptPython

GET /api/{tenantId}/admin/config HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

Configuration returned.

{
  "name": "text",
  "favicons": {
    "faviconUrl": null,
    "rawFaviconUrl": "text",
    "rawLargeFaviconUrl": null,
    "rawAppleFaviconUrl": null
  },
  "logoUrl": null,
  "appTitle": null,
  "status": 1,
  "purpose": 1,
  "publicUri": "text",
  "defaultLanguage": "text",
  "availableLanguages": [
    "text"
  ],
  "extensions": [
    "text"
  ]
}

Update tenant core configuration

patch

https://app.neostore.cloudhttps://app-qa.neostore.cloud

/api/{tenantId}/admin/config

Updates editable core fields in config.yml. Status and purpose can only be modified by global administrators.

Authorization

Requires tenant.configuration.general:write scope.

Required scopes

This endpoint requires the following scopes:

Authorizations

admin-bearerapiKey

OAuth2implicitRequired

Authorization URL:

Path parameters

tenantIdstringRequired

Body

application/jsontext/jsonapplication/*+json

Tenant core configuration patch request.

logoUrlstring · nullableOptional

Optional logo URL.

faviconUrlstring · nullableOptional

Optional 48x48 favicon URL.

largeFaviconUrlstring · nullableOptional

Optional 192x192 favicon URL. Set empty string to clear.

appleFaviconUrlstring · nullableOptional

Optional Apple touch icon URL. Set empty string to clear.

appTitlestring · nullableOptional

Optional application title override. Set empty string to clear.

defaultLanguagestring · nullableOptional

Optional default language.

availableLanguagesstring[] · nullableOptional

Optional available languages.

statusinteger · enumOptional

Optional tenant status (global administrators only).

Possible values:

purposeinteger · enumOptional

Optional tenant purpose (global administrators only).

Possible values:

Responses

200

Configuration updated and returned.

text/plainapplication/jsontext/json

Tenant core configuration response

namestring · min: 1Required

Name of the tenant.

logoUrlstring · nullableOptional

Optional logo URL.

appTitlestring · nullableOptional

Optional browser/application title override.

statusinteger · enumOptional

Tenant operational status.

Possible values:

purposeinteger · enumOptional

Tenant usage purpose.

Possible values:

publicUristring · min: 1Required

Effective public base URI used for end-user links.

defaultLanguagestring · min: 1Required

Default language configured for the tenant.

availableLanguagesstring[]Required

List of languages available for the tenant.

extensionsstring[]Required

List of enabled extensions for this tenant.

400

Invalid language configuration.

text/plainapplication/jsontext/json

403

Status or purpose update attempted without global-admin role.

text/plainapplication/jsontext/json

patch

/api/{tenantId}/admin/config

HTTPcURLJavaScriptPython

PATCH /api/{tenantId}/admin/config HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "logoUrl": null,
  "faviconUrl": null,
  "largeFaviconUrl": null,
  "appleFaviconUrl": null,
  "appTitle": null,
  "defaultLanguage": null,
  "availableLanguages": [
    "text"
  ],
  "status": 1,
  "purpose": 1
}

application/jsontext/jsonapplication/*+json

{
  "name": "text",
  "favicons": {
    "faviconUrl": null,
    "rawFaviconUrl": "text",
    "rawLargeFaviconUrl": null,
    "rawAppleFaviconUrl": null
  },
  "logoUrl": null,
  "appTitle": null,
  "status": 1,
  "purpose": 1,
  "publicUri": "text",
  "defaultLanguage": "text",
  "availableLanguages": [
    "text"
  ],
  "extensions": [
    "text"
  ]
}