Applications in GrantID (HML) are meant to correspond to any computer software system that already exist or that will be created. Our job is to make the task of adding authentication/authorization to that system as easy as possible.
Before going any further, is important to state the difference between authorization and authentication:
They consist on procedures that produce Identity and/or Access Tokens. Bellow you can find an example of each of this tokens payloads as defined in the JWT format:
These procedures also determine a way to safely transmit the tokens from the Authentication Provider (GrantID (HML)) to your application. Please refer to the Tokens and Scopes page for a more detailed explanation on tokens.
To integrate an application you need to modify it so it performs the following actions:
The types of applications are directly related to the flows they will use to obtain tokens. The supported types are:
In this type of application, when a user tries to log in, the application will redirect him to GrantID (HML). The user will provide his email and password if he's already registered or select the "Sign up" option.
After the login, the user is redirected back to your application with the Access and Identity Tokens.
This type of application is very similar to the Implicit option, but, in this case, when the user is redirected back, he receives only a code. This code and a pre-generated Application Secret must be sent to GrantID (HML) in order to get the Access and Identity Tokens.
The Application Server must guarantee that the Application Secret is never disclosed. If this condition is met, than this type of application is considered to be significantly more secure than the Implicit variation.
If an application cannot reliably store the Application Secret securely (e.g. Single Page Applications or Mobile Apps) it should use the Implicit type instead.
This type is a combination of the Implicit and Code types. In this mode, the code and the Identity Token are returned to the application upon redirection, so it needs only to validate the Identity Token and exchange the code with the Access Token.
As well as the Code type, this requires that an Application Secret is securely stored by the application.
In this type of application, the user will provide his email and password in the application itself. The application will then call the Resource Password Owner Endpoint on GrantID (HML) to validate the credentials and obtain a token.
This type should only be used if the application was built by the same company that owns the GrantID (HML) subscription. That is because the user email and password will be entered in the application and so it may be stored or transmitted elsewhere.
This type of application is intended for Application authentication only. It consists on obtaining an Access Token by providing an Application Id and Secret.
All of the previous types may be combined with the Client Credentials option. This should be used with caution though, as the allowed scopes will be granted to tokens issued by both flows in this scenario.
If you need a different set of scopes to be granted only when the authentication happens via Client Credentials, create a separate GrantID (HML) application with the this type only.
The GrantID (HML)'s own external REST API expects a token obtained by using the client credentials flow, as explained in the documentation.
In order to help you choose the correct type of application for you needs, we have built a simple form that filters you the available options.