Creating apps
Creating a static token app#
Open Administration > Integrations > API Hub and click Create new app.
Select the app type Static token and enter a name.
Select the scopes that the app can use.
Select the backend user the app acts on behalf of.
Select a user with only the permissions that the app needs.
Click Generate secret token next to the field Secret. A dialog shows the bearer token for the app.
Copy the token now. The backend cannot show it again.
Click Save. The token becomes valid when you save the app.
Open Administration > Integrations > API Hub and click Create new app.
Create a new app
Open Administration > Integrations > API Hub and click Create new app.
Select the app type Static token and enter a name.
Choose the type and the name
Select the app type Static token and enter a name.
Select the scopes that the app can use.
Select the scopes
Select the scopes that the app can use.
Select the backend user the app acts on behalf of.
Select a user with only the permissions that the app needs.
Select the backend user
Select the backend user the app acts on behalf of.
Select a user with only the permissions that the app needs.
Select a user with only the permissions that the app needs.
Click Generate secret token next to the field Secret. A dialog shows the bearer token for the app.
Copy the token now. The backend cannot show it again.
Generate the token
Click Generate secret token next to the field Secret. A dialog shows the bearer token for the app.
Copy the token now. The backend cannot show it again.
Copy the token now. The backend cannot show it again.
Click Save. The token becomes valid when you save the app.
Save the app
Click Save. The token becomes valid when you save the app.
The token is valid while the app is enabled and has the same secret. To stop a token, generate a new secret and save the app. Changes of the selected scopes apply to existing tokens immediately.
Creating an OAuth app#
Open Administration > Integrations > API Hub and click Create new app.
Select the app type OAuth and enter a name.
Select the scopes that the app can request.
Click Generate secret token next to the field Secret. A dialog shows the client secret.
Copy the secret now. The backend cannot show it again.
Enter the redirect URI of the app.
Click Save. The client secret becomes valid when you save the app.
Open Administration > Integrations > API Hub and click Create new app.
Create a new app
Open Administration > Integrations > API Hub and click Create new app.
Select the app type OAuth and enter a name.
Choose the type and the name
Select the app type OAuth and enter a name.
Select the scopes that the app can request.
Select the scopes
Select the scopes that the app can request.
Click Generate secret token next to the field Secret. A dialog shows the client secret.
Copy the secret now. The backend cannot show it again.
Generate the client secret
Click Generate secret token next to the field Secret. A dialog shows the client secret.
Copy the secret now. The backend cannot show it again.
Copy the secret now. The backend cannot show it again.
Enter the redirect URI of the app.
Enter the redirect URI
Enter the redirect URI of the app.
Click Save. The client secret becomes valid when you save the app.
Save the app
Click Save. The client secret becomes valid when you save the app.
Configure the application with the value of Identifier as client ID, the generated client secret and the endpoints described in OAuth 2.0.
A backend user can only approve scopes that are selected in the app record and that are available to that user. If you remove a scope from the app record, issued access tokens lose this scope on the next request.
A new client secret does not stop issued access tokens. They stay valid until they expire after one hour. To stop an OAuth app immediately, disable it.
A new client secret does not stop issued access tokens. They stay valid until they expire after one hour. To stop an OAuth app immediately, disable it.