Sponsored Access API
Last updated
Was this helpful?
Last updated
Was this helpful?
Symphony Sponsored Access allows Symphony partners to enable the users of their applications to collaborate on Symphony Messaging, by adding those companies and users to the Symphony network.
Users can leverage the Symphony Messaging Embedded Mode in order to chat from within the partner application.
Partners can use the Sponsored Access APIs to create accounts on Symphony Messaging for their application users, if they do not already belong to the Symphony network.
If a user’s company is not yet available on Symphony Messaging, a dedicated Symphony Messaging tenant can be created for that company before onboarding its users.
Before they can use Sponsored Access APIs to add client companies, as well as add or disable users, partners must register with Symphony. Following registration, partners receive credentials to authenticate to these APIs.
If they want to offer a seamless login experience to Symphony Messaging, partners need to provide Symphony with their Identity Provider details. The recommended authentication method is SAML, although other authentication methods are also available (additional charges apply).
If you would like to register as a Symphony partner, create new users and embed Symphony Messaging within your application, please .
In order to target the different APIs described below, the user should use the correct domain, depending on their environment:
PROD:
UAT:
To be able to call this API, you first need to get an access token.
To get your client_id and your client_secret, please contact Symphony.
In the response, you should get:
You can now use the access_tokento make authorized calls to the API. You should pass it as a Bearer token in the Authorization header.
A Sponsored Access partner can use this endpoint to sponsor a new company in Symphony.
As input, the partner must provide:
A name: The company name that will be visible in the user’s profile in the Directory and can be used during user search.
A vanityName: This will be used to construct the tenant publicUrl under which the user Symphony Messaging session will be launched. For example, if the vanity name is “coke”, the URL will be https://coke.on.symphony.com.
emailDomains: The list of email domains used by the users in that company. Only users with email addresses belonging to those domains can be added later on. To update the domain list, please contact your Symphony representative.
REST call to create a company:
Response you should get:
Success
If successful, a dedicated Symphony Messaging tenant will be created for that company and will become accessible under the tenant publicUrl derived from the vanityName field.
If a user leverages the Symphony Messaging channels (Web, Desktop, Mobile), they will need to log in by accessing the tenant publicURL directly in the browser, desktop or mobile application.
If a user leverages Embedded Mode, the partner needs to load Embedded Mode using that tenant publicUrl.
Failure
Company creation will fail in the following cases:
There is already a company in the Directory with users having email addresses with domains belonging to the provided list of email domains.
There is already a company in the Directory with the same company name.
There is already a company in the Directory with the same vanityName.
If the conflicting company has been onboarded by the same partner and the list of email domains is different, an error will be thrown. In that case, the partner needs to amend the list of email domains for the company before adding users.
*where {%email%} needs to be replaced by the user’s email address.
If users do not have an account, you are encouraged to reach out to onboarding@symphony.com or to your Symphony representative so they can help you onboard the users.
A Sponsored Access partner can use this endpoint to provision new users in Symphony Messaging under an existing sponsored company.
As input, the partner must provide:
A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.
An array of user information (in the body of the request). It is recommended to provide a maximum of information in order to facilitate user search in the Directory.
REST call to create users:
Response you should get:
A Sponsored Access partner can use this endpoint to disable or re-enable a user.
As input, the partner must provide:
A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.
A userId (as a query parameter of the request): The userId can be obtained by calling the Get company users API.
A user active status indicator (in the body of request).
Once disabled, the user is no longer associated with the partner, and can no longer log in to Symphony. The user’s chats, however, are kept in order to meet any compliance requirements.
REST call to disable a user:
A Sponsored Access partner can use this endpoint to retrieve the list of companies it has sponsored.
Response you should get:
A Sponsored Access partner can use this endpoint to retrieve a sponsored company’s information.
As input, the partner must provide:
A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.
Response you should get:
A Sponsored Access partner can use this endpoint to add new email domains to an existing company.
Success
In response you should get code HTTP 200.
Failure
When there already is a company in the Directory with users who have email addresses with domains belonging to the provided list of email domains.
A Sponsored Access partner can use this endpoint to retrieve the list of users of a company it has sponsored.
As input, the partner must provide:
A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.
The users are returned in paging mode. If the company has large number of users, multiple API calls need to be made to retrieve the full list of users. To retrieve the users on different pages, the partner must provide:
A currentPage (as a query parameter of the request): This is the page number. To see the total number of pages, partners can make a REST call such as the one below.
A pageSize (as a query parameter of the request): To specify how many users to be displayed on the page.
REST call to retrieve the list of users:
In response, you should get the paging information (total number of users, current page and page size), and a list of users as below:
A Sponsored Access partner can use this endpoint to retrieve the detail of a single user of a company it has sponsored.
As input, the partner must provide:
A companyId (as a query parameter of the request): The companyId can be obtained by calling the Retrieve companies API.
A userId (as a query parameter of the request): The userId can be obtained by calling the Get company users API.
In response you should get:
In case of failures, to verify whether the users of that company already have a Symphony Messaging account or not, you can call the following endpoint:
Retrieve a company or the complete list of companies.
If the 'vanityName' is passed as a query parameter the company matching this name is returned.
If no query parameter is passed, the complete list of companies is returned.
Vanity name of the company
lyondellOK
Retrieve the details of a company, including the creation status.
When the status is COMPLETED the company is ready to be used, and users can be created on it.
If the state is not STARTED or COMPLETED, please contact Symphony for support.
Id of the company
e176c55e-6e49-4819-b982-12e0535db5f0OK
Retrieves users of a given company. Results are paginated by user creation date.
An initial query should be done without specifying any paging query parameters to retrieve the total number of rows.
Page size is configurable, with a maximum size of 100 users.
Id of the company
e176c55e-6e49-4819-b982-12e0535db5f0Current page
0Example: 5Page size
100Example: 50Retrieves a user of a given company by providing the user id.
Id of the company
e176c55e-6e49-4819-b982-12e0535db5f0Id of the user
5bec2e8b-da45-46c7-9370-5669de1b1a78The creation of a company in Symphony is done in asynchronously in the background. When this call returns the state of the company will be STARTED. Please allow approximately 20 min for the company to be fully provisioned. To verify the current status of the company you can poll the 'retrieve company' endpoint using the returned id.
Unique identifier
e176c55e-6e49-4819-b982-12e0535db5f0Creation date
2023-12-22T08:53:39.269539ZLast update date
2023-12-20T10:59:54.516494ZName of the company
LyondellVanity name of the company will generate the public url of the tenant
lyondellPattern: [a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?List of email domains with which users can be registered to the tenant
["lyondell.com"]The Symphony public url of the company
https://lyondell.on.symphony.comThe state of the company to indicate if the creation is completed
STARTEDAvailable options: Message providing additional information about the company creation error
Please contact Symphony support by providing the X-Trace-Id = KUfkYmAccepted
Create users in a given company. Up to 20 users can be created in one API call.
Id of the company
e176c55e-6e49-4819-b982-12e0535db5f0Unique identifier
e176c55e-6e49-4819-b982-12e0535db5f0Creation date
2023-12-22T08:53:39.269539ZLast update date
2023-12-20T10:59:54.516494ZSymphony user id
691867691778058Individual http status code
201Detailed error information
User's email address
john.smith@symphony.comUser's first name
JohnUser's last name
SmithUser's display name, if not provided it is a concatenation of the first name and the last name
John SmithUser's phone number
falseUser's status on Symphony
trueUser's department
Order ProcessingUser's title
Mr.User's location
Sophia AntipolisEnable or disable a specific user account.
Id of the company
e176c55e-6e49-4819-b982-12e0535db5f0Id of the user
5bec2e8b-da45-46c7-9370-5669de1b1a78Active
No Content
Update company to add additional email domains.
Id of the company
e176c55e-6e49-4819-b982-12e0535db5f0List of email domains with which users can be registered to the tenant
["lyondell.com"]No Content