Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 2.4 KB

File metadata and controls

71 lines (44 loc) · 2.4 KB

Kernel Auth Code Flow Proxy API

Overview

This library provides server-side functions related to login using the Authorization Code Flow. The Authorization Code grant type is used by confidential and public clients to exchange an authorization code for an access token. For an overview on Authorization Code grant type, refer here.

Features

  • Provides REST APIs for login, logout, and online token validation functionalities.

Local Setup

Usage

  1. To use this API, add it to your project's dependency list:
<dependency>
    <groupId>io.mosip.kernel</groupId>
    <artifactId>kernel-authcodeflowproxy-api</artifactId>
    <version>${project.version}</version>
</dependency>

Configuration

Properties

Add the following properties to your configuration:

auth.server.admin.validate.url=https://<host>/v1/authmanager/authorize/admin/validateToken
mosip.iam.module.clientID=<module-client-id>
mosip.iam.module.clientsecret=<module-client-secret>
mosip.iam.module.redirecturi=https://<host>/<context-path>/login-redirect/	
mosip.iam.module.admin_realm_id=<realm-id>	
mosip.iam.base-url=<iam-bas-url>	
mosip.iam.authorization_endpoint=${mosip.iam.base-url}/auth/realms/{realmId}/protocol/openid-connect/auth
mosip.iam.token_endpoint=${mosip.iam.base-url}/auth/realms/{realmId}/protocol/openid-connect/token

Bean Scanning

Add the following package to scan for beans:

io.mosip.kernel.authcodeflowproxy.api.*

Note

When the server is up, it will expose 4 new REST APIs.

Documentation

For old commit history on this module please refer to MOSIP Commons repository under kernel folder (https://github.com/mosip/commons/tree/develop/kernel/kernel-authcodeflowproxy-api).

For technical details, refer to the MOSIP Kernel Authentication Manager Service Documentation.

Contribution & Community

• To learn how you can contribute code to this application, click here.

• If you have questions or encounter issues, visit the MOSIP Community for support.

• For any GitHub issues: Report here

License

This project is licensed under the Mozilla Public License 2.0.