Create App

Creates a new application.
post
https://yourpodURL.symphony.com/pod
/v1/admin/app/create
Creates a new app
Parameters
Header
sessionToken*
string
Session authentication token.
Body
applicationInfo
object
Required information for creating an application.
iconUrl
string
Url to a icon to use for app. Must start with "https://".
description
string
Description of the application.
allowOrigins
string
The permitted domains to send or receive a request from. The field is for the purpose of CORS which set the app specific "ALLOW-ORIGIN-DOMAINS" header in HTTP.
permissions
array
List of application permissions provisioned for the application. In addition to the known ones, custom permissions are accepted. A custom permission should only contain upper case alphanumeric characters and underscore. It should not be empty or only contain spaces and its length is limited to 64 characters. Known permissions: - SEND_MESSAGES - GET_USER_CONNECTIONS - REQUEST_USER_CONNECTIONS - SET_PRESENCE - GET_PRESENCE - GET_BASIC_USER_INFO - GET_EXTENDED_USER_INFO - GET_BASIC_CONTACT_INFO - GET_EXTENDED_CONTACT_INFO - ACT_AS_USER - MANAGE_SIGNALS - MANAGE_USER_FOLLOWING - TRUST_APP
cert
string
The app public certificate in pem format.
authenticationKeys
object
App RSA keys information.
notification
object
Application callback information
properties
array
Application configuration properties that are shared with the extension application, client side. Do not store sensitive information here. Since SBE 20.14.
Body
Example
Schema
{
"applicationInfo": {
"appId": "my-test-app",
"name": "my-test-app",
"appUrl": "https://joe.mydomain.com",
"domain": "mydomain.com",
"publisher": "Joe Smith"
},
"iconUrl": "https://myiconUrl.com",
"description": "a test app",
"allowOrigins": "mydomain.com",
"permissions": [
"ACT_AS_USER",
"SEND_MESSAGES"
],
"cert": "-----BEGIN PUBLIC KEY-----\\nMIICIANBgkqhw0BAQ...cCAwEAAQ==\\n-----END PUBLIC KEY-----",
"authenticationKeys": {
"current": {
"key": "-----BEGIN PUBLIC KEY-----\\nMIICIANBgkqhw0BAQ...cCAwEAAQ==\\n-----END PUBLIC KEY-----",
"expirationDate": 1700815176000,
"action": "SAVE"
}
},
"notification": {
"url": "https://some.url",
"apiKey": "test123456"
},
"properties": [
{
"key": "port",
"value": 4000
},
{
"key": "url",
"value": "https://someother.url"
}
]
}
Responses
200: OK
OK
400: Bad Request
Client error, see response body for further details.
401: Unauthorized
Unauthorized: Invalid session token.
403: Forbidden
Forbidden: Caller lacks necessary entitlement.
500: Internal Server Error
Server error, see response body for further details.
Please note to use either:
  • cert attribute when using a certificate
  • or authenticationKeys object when using RSA Public Key

🚧 Roles and Privileges

Calling this endpoint requires the Super Administrator or User Provisioning role. See Bot Permissions for a list of roles and associated privileges.

📘 RSA Application Authentication

For more information on how to authenticate an application using RSA, refer to App Authentication.
Last modified 2mo ago