Requesting Authenticated Authorization

Requests authorization to access the API features using a Modulo Risk Manager username and password. This procedure follows the OAuth 2.0 authorization standard for accessing API features.

 

URL

{RMUrl}/APIIntegration/authorizefeatures

 

REQUEST METHOD

GET

 

FORM CONTENT

client_id (Required): Identifier of the client application. This identifier is generated automatically when the application is registered in the Administration module of Modulo Risk Manager.

response_type (Required): For authenticated authorization requests, this field must contain the following value: "code".

redirect_uri (Required): URL used to return the requested authorization code.

scope: Not used by Modulo Risk Manager. Maintained for compatibility with the OAuth 2.0 standard.

state: Not used by Modulo Risk Manager. Maintained for compatibility with the OAuth 2.0 standard.

 

CONTENT SAMPLE

{RMUrl}/APIIntegration/authorizefeatures?response_type=code&client_id=37d96bb17f5143169e543cf1579586e3&redirect_uri=http%3A%2F%2Fclient_host%2Fclient_app

 

RESPONSE FORMAT

Redirection to the URL entered in the "redirect_uri" parameter. This feature is an exception to the error handling rule, as it returns information on errors in the return URL parameters. The parameters returned are:

code: Authorization code. If an error occurs, this parameter will not be returned.

error: If an error occurs, its identification will be returned in this parameter. If no errors occur, this parameter will not be returned.

error_description: If an error occurs, additional information on it can be returned in this parameter. If no errors occur, this parameter will not be returned.

error_uri: If an error occurs and there is a URL with additional information on it, it will be returned in this parameter. If no errors occur, this parameter will not be returned.

 

SUCCESS RESPONSE EXAMPLE

http://client_host/client_app?code=456c63e8511c42aeb497f0d76adbb8d0

 

ERROR RESPONSE EXAMPLE

http://client_host/client_app?error=access_denied&error_description=The+user+did+not+authorize+access+to+the+features+selected.