Deem offers the User Profile web service, designed for partners and third-party application providers to manage user profiles efficiently. This service allows you to create, update, disable, or retrieve user profiles, which are collections of personal data linked to individual users. The User Profile web service delivers the essential user data needed for various transactions and interactions within services.
Proper management and security of profile data are crucial for maintaining data integrity and privacy. This document provides a comprehensive technical specification to guide partners in accessing and utilizing the User Profile web service from their web service clients.
Need to Know
The User Profile web service utilizes Extensible Markup Language (XML) messages and adheres to the Simple Object Access Protocol (SOAP) standard, which facilitates the exchange of structured information.
Partners and application providers can develop web service clients to interact with the User Profile web service using the Web Service Definition Language (WSDL) file and schema provided in this document. WSDL is an XML format that describes network services by defining endpoints, expected parameters, and data structures in a machine-readable format.
With the User Profile web service, web service clients can retrieve and update user profile information. Clients must specify the desired profile details in each request to minimize latency and avoid the performance overhead of multiple API calls. User identification is managed through an ID (externalID) provided during single sign-on (SSO) via Security Assertion Markup Language (SAML) identity assertion.
or technical specifications related to session management and SSO integration, refer to Implementing Single Sign-On (SSO) for Desktop.
To configure this subscription at the super-domain level for multiple sites, submit a Deem Support case to receive the instructions for configuring the web service at the super-domain.
The following instructions pertain to site-level configuration. Settings configured in your template site will automatically apply to any new sites created from that template.
Configuring Web Service Subscription (WSS) at the Site Level
To configure Web Services for a single site, you must add the subscription to a subscription set and associate this set with a user group using a web service rule. Follow these steps:
Create/Update Web Services Subscription (WSS):
Navigate to the partner dashboard home page and select Settings link corresponding to the site you want to modify.
Go to the Settings tab and select Web Services.
Select Profile Pull Web Service.
Select Profile Pull Web Service Subscriptions.
If an existing subscription is available, select it, otherwise click Add A New Subscription to create a new subscription.
Update General Settings:
Subscription Name: Enter the name for the subscription.
Contact Name: Enter the TMC contact name.
Contact Email: Enter the TMC contact email.
Contact Phone: Enter the TMC contact phone number.
Web Service Type: Select User Profile.
Update Inbound Messages:
Mode: Select Live.
Inbound Message Unique Key: Select User Name / Login.
Username: Enter 8-12 character alphanumeric username.
Password: Enter an 8-12 character password, excluding ambiguous characters (e.g., &, <).
Note: Use a secure password generator to create these credentials. Example services include:
Update Permissions: Depending on whether Deem is your master profile system, customers will have the option to update their profile either within Deem or through a third-party system.
If Deem is the Master Profile: The profile management tool will pull any profile updates/changes and additions from Deem to their system and push to the GDS. Configure two WSSs:
One for PUSH/ADD/UPDATE (refer to the 2nd screenshot).
One for PULL/CHANGES/DEACTIVATED (refer to the 3rd screenshot).
If Deem is NOT the Master Profile System: The external profile system will push data into Deem and the GDS. All updates are managed by the external profile tool, which will synchronize data with both Deem and the GDS.
Click Save to finalize the changes.
Update/Confirm Web Service Subscription Set
Click the Back to Profile Pull Web Services link at the top of the page.
Select Profile Pull Web Service Subscription Sets link.
Select existing subscription set or Click Add A New Subscription Set to create a new set.
If creating a new set, enter Set Name.
Select Add Subscr.
Click the radio button next to the name of the subscription you want to add, then click OK to add multiple subscriptions, select Ok & Add Another.
Click Save to finalize the changes.
Update Confirm Web Services Rules
Navigate to the Rules tab.
Select Web Services Rules link.
Choose Edit or Add to either verify that the correct Web Service Subscription is applied and activated for the group or to add and activate a new Web Service Subscription.
The Add link indicates that no web services are currently established for the group.
The Edit link in green indicates that web services are established for the group and are active.
The Edit link in yellow indicates that web services are established for the group but are inactive.
Optionally, enter a Description for the rule that is easily recognizable.
Check box next to Activate Rule.
Check box next to Enable Web Services using the following configuration sets.
Select the desired Web Service Subscription from the list.
Click Save.
Click Save Priority Changes.
Click the changes not applied link in the top right corner of the page, to finalize all changes.
Test the configuration to ensure it operates as expected.
Add Comment