Configuring iOS Platform Settings

Description

Configure the iOS platform settings using this REST API. For more information on configuring the iOS platform settings via the WSO2 EMM console, see iOS Platform Configurations.

Resource Path /

URL /ios/configuration

HTTP Method POST

Request/Response Format application/json

cURL command

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/ios/configuration

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
Define the path to the JSON file, which includes the required properties to update the platform configurations as the <JSON_PAYLOAD> value. For more information, see the Sample JSON Definition.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Example:

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 4aa2a532e52b8b45c81cd815e0943538" -d @'configurations.json' -k -v https://localhost:9443/ios/configuration

Sample output

> POST /ios/configuration HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 8919b4080f240a9100c640923445b811
> Content-Length: 10007
> Expect: 100-continue
< HTTP/1.1 100 Continue
< HTTP/1.1 200 OK
< Date: Fri, 18 Mar 2016 05:21:35 GMT
< Content-Type: application/json
< Content-Length: 93
< Server: WSO2 Carbon Server
{"responseCode":"Created","responseMessage":"IOS platform configuration saved successfully."}

Sample JSON
Definition

{  
   "type":"ios",
   "configuration":[  
      {  
         "name":"configCountry",
         "value":"USA",
         "contentType":"text"
      },
      {  
         "name":"configState",
         "value":"Colorado",
         "contentType":"text"
      },
      {  
         "name":"configLocality",
         "value":"Coloradosprings",
         "contentType":"text"
      },
      {  
         "name":"configOrganization",
         "value":"abc.pvt.ltd",
         "contentType":"text"
      },
      {  
         "name":"configOrganizationUnit",
         "value":"IT",
         "contentType":"text"
      },
      {  
         "name":"MDMCertPassword",
         "value":"dilshan",
         "contentType":"text"
      },
      {  
         "name":"MDMCertTopicID",
         "value":"com.apple.mgmt.External.6ac44747-c3f0-46a9-99c1-afa1688e4298",
         "contentType":"text"
      },
      {  
         "name":"APNSCertPassword",
         "value":"dilshan",
         "contentType":"text"
      },
      {  
         "name":"MDMCert",
         "value":"data: application/x-pkcs12;base64,MIILwQIBAzCCC4cGCSqGSIb3DQEHAaCCC3gEggt0MIILcDCCBicGCSqGSIb3DQEHBqCCBhgwggYUAgEAMIIGDQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQI5O3lFWd
SyvACAggAgIIF4BLaDS5mzPb+0DbEtoOgESgBnchkwksFvpMCL4Eo+AYzPTXSLxs43NJ81l/CgchNlUcIsY1E+nAK6sViN9P3IUfFEvioUOMrMvdcWTKZaGyPC7M78WPI0yEQLAg4d/rdyRSg7gvtnz+Niwwk9hYDP7OhtA+ZeHgCgkEyZkaPSs
hkTYTIrxXjAgifPaZ1NU7GSehCZECCqGp2wSf27lGM+NFxTXUGTkmz+wvIJx+WjpLsopm+zJEB/zglMcUBe/Iyz0ChV3yxdUK+6OgHORjf0T4BHA+kMQPAy6+8+Sdil1cZsNPyU+7g6Z1BUEsajK3mB0wdC+DIsyAy2oRPCSFzXPFbJ7Cy+hrY9
j+B4q87nzBoV35uFXQ+QhKCHFoIIeIgvnq4PKiYblHeAaw4kUM4XAQBpzAHzeRVseZ9abGJsfw1d2XHr7UdF5nckM1YMH4ajl5BfZwP4AEz0AbZ2ws8QkDjD5a3sFmf7lOrACWYsjKELenkPjIBk798jcogExThhHUhTlKIpv0DoWezB2moBQ8w
ITR1D/VCkD17xts4jWsz4P5iFjTGNB3lnQ1Zly8lG1SuU2nhAgLtFf9FKaR7HGEt9+TFSNewo0VHO5CJnKImoF+V/XIYq5jLAWBuiMOoNgNV/3B1NvqRoL/Kl02XRSmTuSOvkkhKw52H3/6tmKSgqJucYCky1f13MeKnWsKWYd1/Z9Z3bc0DLSr
JAJqVXUkBsCy4oBUPBDy03jgSm/uszjY4EA4jxJe9QlHJkXo1+H/S8H7aji0MeSucARp12zGhie/pN3QQnPpl8lh2/AGauqLvgAfzXMEjGnYS6IC1n+9h/IdgL1RUU7g6Cki+2HG7NPxGFd/qxcdLTI6EF1QResWyn3qUsTScra/Zs8nKq/dTPx
gxZSF+oHFHeX3FP07D1xZ+I6nG2+MJ35DtqMv2OACn02GcZXfiRz8bqiMIfE56Zb5nof/Ejytqr7btAEMUjiEjWUjHOwlCSagMK/JoLJmNj7a1/089g1WQ5vM7c8yl1/zqtm8DM6yV4Rx0TaptzJSFYCc0kY8wuUEMz5aSXGjGgEgLSWoZNn+Gl
fGF6E4DD/0WBBrypwrdriRmiLz1IjzygPjaYfcPwYah5YPmHQCQfJDiBSF0xlEhSM5zeGC4+ImZO1seKNjW3N/j/BSlkmTYuHRHiJtu/Ll+uYVYs0XIYSwnkejdHe1S5kYMZB7fz0hvYdTIIdKw8ADiaiGYX061fXxjR+trDfpWrpTSVpqpmnKW
l2NNilsIfp0KLQ1KisEKm72dSl8zjhKRm+qc+fiPmjpHs1BCyXTEto96Ag3bM9AiiXSMvzuwr6ZM4gmbdEOHgJCyvyizkzYaaP4U39v73aVSQAZahwzdwjEqkGMiXVY/p6hN42nqiJFZQYQ/MctAia2bBcIlh5pu4QApvekuEV8eQrkH985PM2w
3HxTdk6PYs48IlTN5ht6n11QzTK4cFICDuJV02V9a2htWMwGYqL/N2yyNXZAI8qF1VbibBblCH6ZCkKwMnGdsCTJl1HyuDadvNRXUrTxXlpy92BcrrmJ9uQ12PcRRAaI0EziwopEL9UmLjCT7HT+9/pgexXzrAxLr1QT/GeuQo/R0+FtjvfiqNv
A+emiyDFkxue+mqwJua9h8cIApmbJz5z51U4lrLthdKxRs5cjlHs9/SfUM4ZL1xzeVjnBvzzOCGkLG1m1HZQfV5hucN2U+tONjcW71KJ0uBYnT85U4PNFNsoMCGkOtKKZGE753Gr73I/e2uKaqyfglrkMOJKfik2zx4xJ7aX5/4oVOQYdAiP3ei
3Vpw5wjtpCB6QaBIAHdZnG+dWDLaih0k6q+kZQ5eSxta5Ph89WeuPZLfC7jlICB99hKsrPIKUnL6UTdG1AJyzxAwsYGpVqtGg5XvcyvELKA8EPN1rp091Kjc0oCCQtUWWq0Q35+HjvntZmXHxYLsDLmADpEl936NPsWkFrkXCyUaRvhRyQggA+G
mufNQpUwggVBBgkqhkiG9w0BBwGgggUyBIIFLjCCBSowggUmBgsqhkiG9w0BDAoBAqCCBO4wggTqMBwGCiqGSIb3DQEMAQMwDgQIph7jBM9hUn0CAggABIIEyJxonL3d0XEgEqFNmjwPWF/xDruq9a/SU2RC7EEo2Yyi6vsZqTyVPzMw3Hc1hDR
/bwWlEVBYPew9eAOfR0wT0tFVkwSzTcYLCiPeToVOucMhNs3mc6SF4Id7oiACUpNs3MvF5Pr7au2nWUFWVuMISzWAq9OIRg7mrhiVkRdUMJGWZMnZPEKmssgx6OaX3YMUBKM6TqpNekRHFRnInel2q9UQBPekVCefVxOj0A9+JoKXB0uetMfUE
vGoR590BZCSOUbHgArHceub1yPV+PiYlDEzCDZ9Hquu5XMs/TQB8QzyrPz6CRmwOtmXyohoszPpg5HNyzS4y5v3DXDNikrRlYm3UbmnysCBHLGX3xd9ADB3xk+i1560DdOY23qmaS3u+iuPDzIm5lZBWzFdyhYU9YxJWbzJKN4hW/3Mg07TMjFh
w/CMeEz/hnp0bTTlz2ZoR8kNwu3G9t+T4zgCqyFEJMHDHqVJCeAiQXxRfniJtPAZSu5pGW5tgAK0lR0vdQMBeRJo8DdkOAwiAqMj3avimh+upJ3k1F0D+aq2lmK7At+zyYesPPgSkSNPGOxEUqmzJZ2WuNhjkZVWiNl1Jdy0jTS+afmw+RqczPY
+wpcqh35AOjxh9AcRUUVubKd234BYfDI3U+Tf4+JTuJOB68lzAPEP82vclwpiIsl4VaPemUEtr0PscpNo04YYjoADvLnyzYaDNpxM+87lHh5QNAG3tpl4V/P9s2WH6O1FfFZCvpCY/bGTZkF2ZGaiUnL7llP33zD39g0RUAChCf1p9eLiDBqPjR
iehlpXsqwjLtBWdunCsxK5vtFl8RPEwca0iGaSc/SkhK5SxIdkut4yf6epr6egqQMAs7tC61kzbIQgioVmXhESFoWR16UZdmnadkYPUBle452UtFtSn+BIor5bKgqYF7GzXUPg1sCOiaCj+toWVFJ/ZKn13rOsyEov6lBbNcyk1FWG1GSlVoceMn
PeQjPN1kVywmIKOHkl00ySsWx7Jw6Qln7WX4pPphxWTtIrgIRJfWUAD4U+ble2kW0wBgPyfgeXnoXnKY/yMbeQI2d3rd3JAV+UNjGyutwX1Sw2KsH9tB4gPKSrzWGISmCYvUAT5A6N9hofnDzo2d7qBxG8oQKsMXhZU72KQT2X7TrU3rfjjtG8c
4ilPaq/Dy9mgapuSt+utY5HHk4zdEiXyVznYyf7lHfRq69dcEUQyq4Lgk3UfhI4O6olonEc3MFsDLFVx8q+vC3it/me+MyyLHnvecqgWOdbsdP0Q+sk91hEKnf+C1beY3OxrO4v3q1L/668bYUwU8ZJslqgDqdYzTWkQdS9zF7Qp9Ox+OxJNOR8
BOMvE8me9uIrQTf9Sp0kelJ4HG0MRk7pCJgkFupxkiKID4XZxbRlj/9mXNH9PTBKA5WhRSpy3WJ/N0YgULuMmtnyigj7T+1sT49sk1niQdN73gFSnlEAxfc56Tgi71ewkpJCCKKOiXxktLzgQjA5E86tzXaWbux5faB9E81ch71eF0ivqr8LCE8
p/g1PNwucgOX0Xnitjm4AFbi4gQDBr/qOfdmt8dpTFUbVfhXXLPDwWqpQwWmKy3CJOmtQu1XX10b2ZRp/R+L+9F3lK0rfZ+JvVm0CujjdDElMCMGCSqGSIb3DQEJFTEWBBSgBWuGHL9CTrTsQrBDXRZT/DTu+zAxMCEwCQYFKw4DAhoFAAQU26O
htWhEVtHhu8RK6wfU9Tmk69EECO+elowywvbeAgIIAA==",
         "contentType":"text"
      },
      {  
         "name":"MDMCertName",
         "value":"MDM_APNSCert.pfx",
         "contentType":"text"
      },
      {  
         "name":"APNSCert",
         "value":"data: application/x-pkcs12;base64,MIIMpwIBAzCCDG4GCSqGSIb3DQEHAaCCDF8EggxbMIIMVzCCBtcGCSqGSIb3DQEHBqCCBsgwggbEAgEAMIIGvQYJKoZIhvcNAQcBMBwGCiqGSIb3DQEMAQYwDgQI9/88uAJi
cloCAggAgIIGkEyJPk3tAsyAsiS4UjwSLy5c+KB0t3aeT+n/BRMAqPshZYB6piqu+d1GIZ6PHfiCniTJ09FxdGzW5WRIXptsZgTDuW0WrPpapVl3iLO4DbPK4mU8F1XAvU8FhKxIVGPNa2xGeW28P+nWZ0QBU7Do1KU5T1HVASeHh2lr7HjGWJ4m
CftO6TIbgBTrpHwK6KXnd6S4BIYl5pBZpilY9p/VY/VBi4r++IWS9xXQeTQcxzVA0s4y9282mDQlQp0lDYROM/4CTWW6FFV+dJgXQa/0IuxLyKejsu2tmN2y4v7Xj6RWWlKqM/mCdUjMq0RxJ5Td67kJO6FaHMY8RzsUvRrL5ChN75EXxUveQ9p+N
inS09MVTRm1thoHti/frFpnGrqi0ODAQrRS9zJisyjr2Smvae0d3WybhygLX5lTO6ZaE2AGHOPgkAiiTZjml0eOG9ibWldn1ZqYnbo9CAa7LFp6xKyeeYaQ2ZNsNckcr/ouEQTHqk95CL/piQ0CzQ8pdRuL7wFnKASvM+HZ8Eay4hvRkn0xhH5SvP
I11k8hr7ZJXYvrcT9HD96xcz0Ig1jsAWvwdDCdRihdPpTf1zVVA+wIbschS9SVHm9BRrY8Fl5jyy9S/rwdeTscl0y4EsgcUolRXMtyMirmNEuwzte4M20SoY3vsuDFDSXJr7NKMc7dTq9WSrRnmvGLYtbC+PhiGB19bEB9s6IbXwrwC4tVB8IMTqh
gTJ+wiHuvEPyw1Ajus5SSZqDE4l9ZnFIA5EQ55Yfo7L9lVGWwLdXClOUMdLAbNrVUWOLZhr5h6XXG6k18oOgGQD+u3RterjAmb3T3HfymPsWqHb6TR5EmCQYkIFI7PYAY/o4IVusZXrloiDsBo9X3FbB36DnifURwUDbDNC6ZqdIo5sGwvxrHC98g
REvp69K/lBUpdR6IZATi4sX1zcr4GIymq/Sxr8kHq69kui3BL4LrUSmh1b/VS8UuzqMdvA+SWy5557DUBsfwonZkCWYjkaEx1EKDBxtWfP+SkdwVuu0rUkTaD9KLOczALF4fAdTTPbq48GHVjWE5l9mh3VJMlkzyLvoyn3sURAA2dvYQJXQUC1p7l
vrQ1J57XdGNP+3jcYrc79u93iBugmQ2SjBANDQLX26xS68d6zStomrLdc+8pDpccBq4HKNiUYC/SRuuAyYDervwe2UCY5zx72iy9xwkyly1I6jvTyVr9SbRxx3QWsbdSTN8r14GCbt1YnZC7ZnP4PnP+2nj2rmdzgZtxZmuM+yd9vYX8/cG7KxubU
oAQANaRQndp61o9SvDECpcQ1G9NuCzfg64ZiNbvHHULDPqmC5pPCQbIH8WQj6BhkFj0IaB/BHzleQv8VOQQLs54HFTchVAR2Ua+Q1IZid6lMhk400t14bC4fOh1vhLeZVJ4HeTWOigbnkQ6bnGcXeJuR2p7FScDj/ow0lHLnTfqeaW/O/ssdaxKPD
rpl0QOjaItQqlnom8zREX8znR+096QOL5R746iNMJnLYAq+J3re0JhczxpR48zIQzxUgz6P9ZzN3eNbCzNm5O3O22d1R8ljsHm1iu+0uTQhUo/Jpyr1P9flVoOyTmaP9Fvu9o1HizNLe8ch81nNtpHkpbdowg42XrKV71rmXB5ls3CllsMw1Q4cta
2gsufep0JDkJNqmDfxx2R6dCxCV4H8o94teOTdHkkeRSKtSX1NqjScbpCN11RMqBk6JhC2ekFZpb7C/yRkmuaVmr+wl0ephdK/PFJzDsURbq4JCK4vbFYsf4dZQ7+65T+Urp1rkbwNblVIb+HD0UXj4kAv4fwUAW6buAoB1eG+Hxip/ZiEwjg33eM
SUVnVigZv/jMIQJ1435KYqEScNsLpie486JlWGvIGnRB1u57Vmlh0j/K8suwcFWZYnB14tC9UhnmjYPsq2Ay2rvdnw2mELlOhuv02wH4bybPddhblgtooh4FkRiWFF+Au85TxM9hRGvMR/JHRtufzpyHTGFgQXzFNZVmvRTUGkaqk5uUrLkAOCinF
VLXe+5uzU9of/DEe3TWmL09KuVOXl7C5azldi/XoJvK9fnY8i3MFdZ+QhiSz83bEe4xIhSuNxiRvUkXGuH2321HXTRZXEuxZ1lAwYZENWZkqV7TnTAQrANFS/g7KwUslHd9bL9ba36wRKtPrvzJ021kPGBHr1y+xO1wbPBWTIEgzrTXIjSZT5vWQ4
LfuWg93SbCwdRblkyR/tn4P+QjS1MWqVCYzCCBXgGCSqGSIb3DQEHAaCCBWkEggVlMIIFYTCCBV0GCyqGSIb3DQEMCgECoIIE7jCCBOowHAYKKoZIhvcNAQwBAzAOBAhOVkOcDiJXUwICCAAEggTI/2o/WT2mtX9EVA6zCpgQSJfh5oV8FvK1Mele
/npUExcvtNBR+8YPfp3yttbvIdIenrIgCpLCK7XpMojaU8ta8OuyfUr9nb8ig86P3AAxhDG7o0reDwUn3vU9LuY1GzSueSya9J7RQ/NlabjQ7tMeGMMmt7Im1VMFhj54WXkvtFbwldxbc0tLCTzqMWnmA+r/cbNQ7ppYGMQ9hz9yHNWz7sZ1y6S18
zvet0X2oA2ahzlgHyfiUPPopc7ucJUZQytZ7aZ/7LWMaG14eyxFZOL/OoSK69z2Z2Xr8jy5j6xpEOAhuR67HSfjTrIL/Uae+3HIZW1WpJzXonppvhkiIgJMOnQWW7VtLT7AU4xSAroIEXj5Rm3+9hHy/iIrIhlQeK0cx33qafAUGqEdjPAqqj8UCC
OIGYRm/ehNFpPCTRFOk4amV59mTR6W7y8iQn1htuxoJOUPup5SYtXC2qX/WfsLtg1Ui+ppgh7viYJLFXhlpzychg3sYsuzv+ino1EARWQZQ2r/Y96SueBwRdsyjT4mQuuCfA3LIx9plNhj7U4C4+fPsi22XCYUuaMX1zugVnYw7W9/b/j5bphJgpH
d1k8JQ0ThD+hbVPIeNr5rPcz7cs2bQDAKg8Myh6BsKOBlgDhULwQ1lrRCAN0QUuK0vbyuuA8NAKfarz5HaAOw7f/pCLFkXAsD0FhzagrNifYlWAZgAeKMfp1P0CQFc0R685ywY1HB2MWtJKAfb7tfmGmxB6OdSF7OgulAIsNounArhCTyC/pAN/tx
JbxvBWAtrysM0Zv64RfTx3ND698OcVoz5djuA2o36GpZPwK+cPAesy8m0eLrPe0folQpBFinYgTHpRpEd9VV7CHlWan+h9mywB63BqP49YTZYeUNPOki1sJvJDf04/0F99hqm6cM/z/BRu5E05QwGJMtvBwM3y09L8wsihy1xFKKuJQC7z+tWrkg/
d3UFdo4cuuGfuCSe+4pImtxNJnEkfNocs0GPRqUSciuDsIvKWKeEsrlcMC8D0KzonG5QXNobg0pCy8wPR/h2vcKVgTkdg+pwnKVyOzRHBRxAKoCuGKI+MDDJjU+gmDPL6Zen85xFt/2jL6IyxiAId3a3SFoE58oyHIJWJlg05QsWbnxoypnQoxyhz
Y1Yytm0TzLdE8A6YyZqAK8f2jYv1PC1/Y5zE7UkCb1ax9uXMjkLo/h4oxh8TYFd7Jb0C5OzJ2BEetipMYyALjEOk6oKQK6Us56TaCRpUiaZurX67yI+JWnz9MQRSmlp7JkR6hQR+qyE69ylJsXcHPbS0LZR4mAJ8uUYbEAgpdCX8A2W0nY0EceElQ
khekvImmpB1Lr+0k3yNIIn/ZEXdqvyt6xlZrOMLDanMmWhphTp6TXf4jpF7c0tZeg29sXPn8s5IlIpl+/YthueFPjsZrili2KlAnkrgZUirHx8PxBjvWjf8Q4GklqwTCf1JDC3lz7Yn10K3bN7pnJkAyzd1326TkZz9ZI84vd3+CauH4R7foRumsd
z68GJYAx1CnputkAs3c4iQkpPxcMpQYCxU7Taq09P9NNNw4uvzQMNT8T3ZqbG2oOkapK9EO7aSGnO5pABTfEAdbbdTBjDgPfSTzeTzIHLdmhi5STGOQfMVwwNQYJKoZIhvcNAQkUMSgeJgBEAGkAbABzAGgAYQBuACAARQBkAGkAcgBpAHMAdQByAG
kAeQBhMCMGCSqGSIb3DQEJFTEWBBS5Xpr6GIutnJH/HFVHDv1s/gY9LjAwMCEwCQYFKw4DAhoFAAQU2GPyFnNeRn8RcRvZX6PTG23PeecECBNCpdijuOG1AgEB",
         "contentType":"text"
      },
      {  
         "name":"APNSCertName",
         "value":"APNS_Agent.pfx",
         "contentType":"text"
      },
      {  
         "name":"organizationDisplayName",
         "value":"ABC",
         "contentType":"text"
      },
      {  
         "name":"iosEula",
         "value":"<p>Licenseagreement</p>",
         "contentType":"text"
      }
   ]
}

Property	Description	Value
`type`	Define the mobile platform.	String
`configuration`	Defines the configuration properties.	String
`name`	Many properties are needed to configure the iOS platform therefore the `name` field is used to identify each property. Provide the configuration property name.	String
`contentType`	When passing the configuration details to the EMM registry the content type must be defined.	String
`value`	Provide a value for the respective configuration property. `configCountry`: The country where the tenant is based. `configState`: The state where the tenant is based. `configLocality`: The locality where the tenant is based. `configOrganization`: The name of the organization where the tenant is based. `configOrganizationUnit`: The name of the organization unit where the tenant is based. `MDMCertPassword`: The `password` that was used when converting the EMM certificate from a `.pem` file to the `.pfx` file `MDMCertTopicID`: The `USERID` mentioned in the EMM signing certificate. `APNSCertPassword`: Enter the password provided when exporting the iOS APNS certificate. `MDMCert`: The base 64 encoded iOS MDM APNS certificate. Upload your certificate and base 64 encode it using a tool, such as the base64encode.in tool. `MDMCertName`: The name of the iOS MDM APNS certificate that was previously created. `APNSCert`: The base 64 encoded APNS certificate. Upload your certificate and base 64 encode it using a tool, such as the base64encode.in tool. To generate an APNS certificate follow the steps given under the Configuring Push Notifications section. `APNSCertName`: The name of the APNS certificate that was created. `organizationDisplayName`: The name of the organization. `iosEula`: Provide the license agreement that a user must adhere to when enrolling an iOS device with EMM.