Configuring the emm-web-agent config.json file

Users can change the default functionality related configurations by editing the config.json file that is in the <EMM_HOME>/repository/deployment/server /jaggeryapps/emm-web-agent/config directory using the information given below. This information is provided as reference for users who are already familiar with the product features and want to know how to configure them. If you need introductory information on a specific concept, such as message receivers and formatters, see the relevant topics in the User Guide. For sample values, see the Example below the table.

appContext
apiContext
httpsURL
httpURL
enrollmentDir
iOSConfigRoot
iOSAPIRoot
dynamicClientRegistrationEndPoint
adminService
idPServer
callBackUrl
adminUser
usernameLength
device
- ios
  - location
  - bundleID
  - version
  - appName
androidAgentApp
windowsConfigRoot
ssoConfiguration
- enabled
- issuer
- appName
- identityProviderURL
- responseSigningEnabled
- keyStorePassword
- identityAlias
- keyStoreName
generalConfig
- host
- companyName
- browserTitle
- copyrightText

Property	Description			Data Type	Example
`appContext`	WSO2 EMM has 4 main Jaggery applications, such as emm, emm-web-agent, store and publisher. Depending on the production environment if required these applications can be hosted separately. The emm application is used to manage devices that register with WSO2 EMM. Therefore if you are changing the name of the folder from its default name `emm` the `config.json` file must be updated accordingly.	Yes	N/A	String	/emm/
`apiContext`	The api jaggery application contains the API that can be used by users. Therefore if you are changing the name of the folder from its default name api the `config.json` file must be updated accordingly.	Yes	N/A	String	api
`httpsURL`	The HTTPS URL of the hosted EMM server. It should be in the `https://<EMM_HOST>:<EMM_HTTPS_PORT>` format.	Yes	N/A	String	https://10.100.7.98:9443
`httpURL`	The HTTP URL of the hosted EMM server. It should be in the `http://<EMM_HOST>:<EMM_HTTP_PORT>` format.	Yes	N/A	String	https://10.100.7.98:9763
`enrollmentDir`	The path and the directory name that handles device enrollment.	Yes	N/A	String	/emm-web-agent/enrollment
`iOSConfigRoot`	The URL path to the iOS enrollment APIs. If the APIs are moved to a different location the `iOSConfigRoot` property must be configured withe the new URL path.	Yes	N/A	String	https://10.100.7.98:9443/ ios-enrollment/
`iOSAPIRoot`	The operations carried out by the iOS devices enrolled with WSO2 EMM are handled via the `ios` APIs. If the APIs are moved from its default location the `iOSAPIRoot` property must be updated accordingly.	Yes	N/A	String	https://10.100.7.98:9443 /ios
`dynamicClientRegistrationEndPoint`	Provide the URL path to access dynamic client registration. Dynamic client registration is the mechanisms for dynamically registering OAuth 2.0 clients with the authorization servers.	Yes	N/A	String	https://10.100.7.98:9443 /dynamic-client-web/register/
`adminService`	The URL where the WSO2 carbon is hosted. Some of the requests received by the EMM front end will require it to directly call the Carbon components. In a production environment if the UI layer and the carbon layer are hosted in two different locations it will be mandatory for the UI layer to know where the carbon components are hosted.	Yes	N/A	String	https://10.100.7.98:9443
`idPServer`	The IdP server allows users to authenticate against any given identity provider. If your IdP server and the EMM server are hosted in different locations you need to provide the the URL of the separately hosted IdP server.	Yes	N/A	String	https://10.100.7.98:9443
`callBackUrl`	Provide the URL path that contains the backend JAXRSs.	Yes	N/A	String	https://10.100.7.98:9443 /mdm-admin
`adminUser`	Defines the username of the default administrator for the EMM.	Yes	N/A	String	admin
`usernameLength`	Defines the maximum length of a username.	Yes	N/A	Integer	30
`device`	Provide the device type. In this configuration it is referred to as `ios`.	Yes	N/A	iOS	-
`androidAgentApp`	The name of the `.apk` file that the user downloads when enrolling an Android device with WSO2 EMM.	Yes	N/A	String	andorid-agent.apk
`windowsConfigRoot`	The URL to access the Windows federated authentication. When a Windows device registers with the EMM it will be navigated to the Windows Work Place application to continue with the registration process. Therefore it is important that you configure this property.	Yes	N/A	String	https://10.100.7.98:9443 /mdm-windows agent /services/federated /bst/authentication
`ssoConfiguration`	Contains the SSO configuration properties.	Yes	N/A	ssoConfiguration	-
`generalConfig`	Contains the general configuration properties.	Yes	N/A	generalConfig	-

iOS

Property	Description			Data Type	Example
`location`	Define the location of the iOS agent file that the user downloads when registering an iOS device with WSO2 EMM.	Yes	N/A	String	https://10.100.7.98:9443 /mdm-windows-agent /services/federated /bst/authentication
`bundleID`	The Bundle ID is the unique identifier of an application. WSO2 EMM gives the source of the Application to the customer, if required they can change the identifier by configuring the `bundleID` property.	Yes	N/A	String	org.wso2.carbon.emm.iOSMDMAgen
`version`	Provide the version of the iOS agent.	Yes	N/A	String	1.0
`appName`	Provide the name of the application.	Yes	N/A	String	EMM iOS Agent

ssoConfiguration

Property	Description			Data Type	Example
`enabled`	Enable SSO by defining `true` as the value or disable SSO by defining `false` as the value.	Yes	true	Boolean	false
`issuer`	The entity ID of your Identity provider. The default entity ID is `mdm` but this may change when in the production environment. In such situations you need to configure this field accordingly.	Yes	N/A	String	mdm
`appName`	The client name used to connect to the SSO, IdP.	Yes	N/A	String	admin_emm
`identityProviderURL`	The HTTPS URL of the hosted SSO server.	Yes	N/A	String	https://10.100.7.98:9443 / sso/samlsso.jag
`responseSigningEnabled`	Once response signing is enabled, a SAML response will be signed from the IdP and the client has to validate it using the public key provided by the IdP.	Yes	true	Boolean	false
`keyStorePassword`	Define the password to the keystore. The key store is the repository of security certificates, such as SSL, RA and many more certificates. The default keystore password is `wso2carbon`.	Yes	wso2carbon	String	keyStore_password
`identityAlias`	Provide the public certificate alias of wso2carbon.jks.	Yes	N/A	String	wso2carbon
`keyStoreName`	Define the location and the name of the keystore. WSO2 Carbon-based products are shipped with a default keystore named wso2carbon.jks, which is stored in the `<PRODUCT_HOME>/repository/resources/security` directory.	Yes	/repository/resources/security/wso2carbon.jks	String	-

generalConfig

Property	Description			Data Type	Example
`host`	Provide the HTTPS URL of the running EMM server.	Yes	N/A	String	https://localhost:9443
`companyName`	Provide the Organization name.	Yes	N/A	String	WSO2 Enterprise Mobility Manager
`browserTitle`	Provide the content that should appear on the browser title.	Yes	N/A	String	WSO2 EMM
`copyrightText`	Provide the copyright text.	Yes	N/A	String	\u00A9 %date-year%, WSO2 Inc. (http://www.wso2.org) All Rights Reserved.

Example

{
    "appContext" : "/emm-web-agent/",
    "apiContext" : "api",
    "httpsURL" : "%https.ip%",
    "httpURL" : "%http.ip%",
    "enrollmentDir": "/emm-web-agent/enrollment",
    "iOSConfigRoot" : "%https.ip%/ios-enrollment/",
    "iOSAPIRoot" : "%https.ip%/ios/",
    "dynamicClientRegistrationEndPoint" : "%https.ip%/dynamic-client-web/register/",
    "adminService":"%https.ip%",
    "idPServer":"%https.ip%",
    "callBackUrl":"%https.ip%/mdm-admin",
    "adminUser":"admin",
    "usernameLength":30,
    "device" : {
        "ios" : {
            "location" : "%http.ip%/emm-web-agent/public/asset-download-agent-ios/asset/ios-agent.ipa",
            "bundleID" : "org.wso2.carbon.emm.iOSMDMAgent",
            "version" : "1.0",
            "appName" : "EMM iOS Agent"
        }
    },
    "androidAgentApp" : "android-agent.apk",
    "windowsConfigRoot" : "%http.ip%/mdm-windows-agent/services/federated/bst/authentication",
    "ssoConfiguration" : {
        "enabled" : false,
        "issuer" : "mdm",
        "appName" : "admin_emm-web-agent",
        "identityProviderURL" : "%https.ip%/sso/samlsso.jag",
        "responseSigningEnabled" : "true",
        "keyStorePassword" : "wso2carbon",
        "identityAlias" : "wso2carbon",
        "keyStoreName" : "/repository/resources/security/wso2carbon.jks"
    },
    "generalConfig" : {
        "host" : "http://localhost:9763",
        "companyName" : "WSO2 Enterprise Mobility Manager",
        "browserTitle" : "WSO2 EMM",
        "copyrightText" : "\u00A9 %date-year%, WSO2 Inc. (http://www.wso2.org) All Rights Reserved."
    }
}