Index
Speaking of Oauth App..
OAuth is an open standard protocol for authorization, which is commonly used to allow third parties to access a user’s data without knowing their password.
The platform has a Public API with the main services available on the platform. By using this API, it is possible to create messages on behalf of the user, add contacts as favorites, create articles and much more. For an application to act on behalf of a user or of itself, the authorization is performed via OAuth protocol, and they have to be previously registered on the platform with their public and private keys. If your application performs actions on its behalf, you can create an application user (optional).
If you want the application user to perform actions on behalf of another user registered on the platform, simply select the option Allow Impersonation. By selecting this feature, the application user can, for example, post a message on a community, post documents and move processes on behalf of another user.
OAuth App registration for servers is an authorization that the target server gives so that the current server can export pages without having to download and import files.
Register Oauth App
01. Select the Control Panel feature in the main menu.
02. Access the WCM tab.
03. Click the Oauth APP option.
04. Click Add.
05. Enter the Consumer Key.
06. Enter the description.
07. Select the Oauth Provider.
08. Define Consumer Secret.
09. Click Save.
Creating Application User (Optional)
01. Select a registered OAuth Application.
02. Click Application User.
03. Click Create Token. At this time, it creates a token and a user on the platform so that the app can act on behalf of a user or on behalf of itself.
04. To manage registration information, learn more about its concept below:
User name: User name created by the system. This field is pre-filled with the value of the registered Description on the Add Oauth Application screen. This name can be changed to one of your choosing.
Allow Impersonation: Selecting this option allows the application user to perform actions on behalf of another user.
Choose Image: This changes the default photo of the system that identifies the registered user.
05. Click Change.
Register OAuth APP for servers
01. Select Control Panel from the main menu.
02. Go to the WCM tab.
03. Click the OAuth APP option.
04. Click Add.
05. Set Consumer Key.
The administrator can choose the Consumer Key value.
06. Enter the description.
The description cannot contain accents or special characters.
07. Select the OAuth Provider registered with the specifications described in Register OAuth Provider for servers.
08. Set Consumer Secret.
The administrator can choose the Consumer Secret value.
09. Click Save.
After registering the OAuth App, it is necessary to enable the Application user options.
10. Select the created OAuth App and click Application User.
11. Click Create Token.
12. Enable the impersonation option.
13. Click Modify.
14. Click Control Panel > General tab > Users.
15. Select the created OAuth App user and click edit.
16. Grant the administrator role to the user.
That is not all!
Check out the documentation to learn more about how to register servers.
Renew Token
01. To change the Access Token and Token Secret values, execute the following:
Access Token: Access token for authenticating requests automatically generated by the application server.
Token Secret: Key for authenticating requests automatically generated by the application server.
02. Click Renew Token.
Edit Oauth APP
01. Select the Oauth APP you want to edit.
02. Click Edit.
03. Execute the desired modifications.
The platform does not allow the Oauth Provider field to be edited.
04. Click Save.
Delete Oauth APP
01. Select the Oauth APP you want to delete.
02. Click Delete.
03. Click OK.
Please note!
This documentation is valid from the 1.6.4 update - Waterdrop. If you use a previous update, it may contain information different from what you see on your platform.