Clients are used to authenticate integrations to the HCMS. Much like a user name and password authenticates a user has access to the HCMS, Clients do the same thing at an integration level to ensure the product or service integrated with the HCMS has access to perform actions within the HCMS. Please keep the Client ID and Client Secret information in a secure location and protect this information like you would your username and passwords.
Important Notes
As a best practice, you should have separate clients created for each product or third-party integration. This is recommended for the following reasons:
Auditing: If you use the same client for more than one product or integration, then there is no way to see what product or integration created, modified, or deleted content
Security: If one product or integration gets compromised, generating a new client secret, setting up a new client, and/or disabling/deleting the client will only affect a single integration, and your other integrations will continue to work.
Add a Client
Who can use this feature?
Owner
Navigate to Settings and click on the resulting Clients menu option:
Scroll to the bottom and enter the Client Name:
Note: The name can contain lowercase letters and dashes, not at the end.
Click the Add Client button:
Modify a Client
Who can use this feature?
Owner
Navigate to Settings and select Clients:
Locate the Client you wish to edit and adjust fields:
Name: Hover over the name of the Client to show the edit icon and select to change the Name
Note: Updating the Name will not update the Client ID field. If the Client Id needs to be updated, please delete this client and create a new one.
Connect: View step-by-step instructions on how to use this client information to authenticate an integration with the HCMS and generate an access token that is good for 30 days.
Client Id: The Client Id is similar to a user name for this client and cannot be edited.
Note: Click on the page icon to add the Client Id to the clipboard for pasting into another system like Integration Hub for authentication purposes.
Client Secret: The Client Secret is similar to the password for this client and cannot be edited.
Note: Click on the page icon to add the Client Secret to the clipboard for pasting into another system like Integration Hub for authentication purposes.
Role: Select a Role to define what access this Client has to the HCMS application. This is similar to Roles for Groups and applies to general access to the HCMS application and not specifically to content or assets. Permission Sets are used to define the access this Client should have to the content and assets on this HCMS application.
Changes will auto-save except for Name; click the Save button to update:
Delete a Client
Who can use this feature?
Owner
Navigate to Settings and select Clients:
Click the red trash can icon related to the client you wish to remove:
Click the Yes button in the Do you really want to revoke this client? pop-up window:
