Create App

Creates a new application.

Creates a new app

post

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

Detailed record of application.

iconUrlstringOptional

Url to a icon to use for app. Must start with "https://".

Example: https://myiconUrl.com

descriptionstringOptional

Description of the application.

Example: a test app

allowOriginsstringOptional

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.

Example: mydomain.com

permissionsstring[]Optional

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

Example: ["ACT_AS_USER","SEND_MESSAGES"]

certstringOptional

The app public certificate in pem format.

Example: -----BEGIN PUBLIC KEY-----\nMIICIANBgkqhw0BAQ...cCAwEAAQ==\n-----END PUBLIC KEY-----

Responses

200

OK

application/json

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

/v1/admin/app/create

HTTPcURLJavaScriptPython

POST /pod/v1/admin/app/create HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 866

{
  "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"
    },
    "previous": {
      "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"
    }
  ]
}

{
  "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"
    },
    "previous": {
      "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"
    }
  ]
}

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.