To create authentication:
- Sign in to the Modeling Application and open a project.
- Click the vertical ellipsis button next to Authentications and select Create.
- Enter an Authentication name for the authentication and an optional Authentication description.
-
Click Create Authentication.
The authentication is added to the Authentications drop-down menu on the left.
- The authentication is opened as a new tab.
-
Select one of the authentication types from the drop-down menu:
Authentication Type Description Basic In the header of the HTTP call, an Authorization header is included with an user and a password as a value. Bearer token In the header of the HTTP call, an Authorization header is included with a value that starts with the word Bearer and after it an encoded string that the target service can decode and understand which is the user. If you use this method, you need to include a non-expiring token. Client credentials The bearer token is created on the fly using OAuth2. You need to set the authorization server, the credentials of a user in OAuth2 (a client application) and which scopes are going to be retrieved. -
Optionally, deselect Secured so you can enter a user
name and password that is used when contacting the API.
CAUTION: It is not recommended to deselect the Secured checkbox. When doing it, you are risking the security of your application.If this option is deselected, the following properties can be filled:
Parameter Description Clientid When using Client credentials authentication, enter the client id, for example: Client-1 Client secret When using Client credentials authentication, enter the client secret for the API, for example: client.secret Endpoint When using Client credentials authentication, enter the end point of the server, for example: client.endpoint. The endpoint entered is validated before you can save the authentication.
Scope When using Client credentials authentication, enter one or more scope values that make up part of the API account you want to access, for example: api.account.one. The scope entered is validated before you can save the authentication. Token When using Bearer token authentication, enter the bearer token for the API, for example: bearer-token. The token needs to be provided in advance, using the Client Credentials set in the Indentity Provider. For more information, see the External Applications section of the Hyland Experience Administration Portal documentation.
To learn how to retrieve the token from the Identity Provider, see the Getting Started section of the Hyland Experience Content REST API.
Once the external service has the token, it can call the configured URL, adding the Authorization header to the request containing the token.
- Use the cloud button (Save authentication) to save the created authentication.