Skip to content
This repository has been archived by the owner on Jun 17, 2024. It is now read-only.

Latest commit

 

History

History
114 lines (92 loc) · 3.52 KB

README.md

File metadata and controls

114 lines (92 loc) · 3.52 KB
Raw

App ID Spring Boot Starter

This is a spring boot starter that enables Spring boot developers to get started quickly to build authentication workflow for applications that use App ID and OAuth 2.0. This starter is like an extension to the actual functionality of the spring security, that means you can do whatever you want to do with spring security, plus you get additional functionality to configure App ID.

Installation and Usage

Add the following dependency

Gradle:

dependencies {
    compile group: 'com.ibm.cloud', name: 'appid-spring-boot-starter', version: '0.0.5'
}

Maven:

<dependency>
  <groupId>com.ibm.cloud</groupId>
  <artifactId>appid-spring-boot-starter</artifactId>
  <version>0.0.5</version>
</dependency>

Getting Started

This section contains examples of how to use App ID starter in your spring boot application. There are multiple ways to auto-configure App ID in your application by providing the App ID configuration details in the following ways in your application.yml file:

spring:
  security:
   oauth2:
     client:
       registration:
         appid:
           provider: appid
           clientId: <<clientId>>
           clientSecret: <<clientSecret>>
       provider:
         appid:
           issuerUri: <<issuerUri>>

This is standard way to configure App ID.

spring:
  security:
    oauth2:
      client:
        registration:
          appid:
            clientId: <<clientId>>
            clientSecret: <<clientSecret>>
            issuerUri: <<issuerUri>>
  • issuerUri - URI that can either be an OpenID Connect discovery endpoint or an OAuth 2.0 Authorization Server Metadata endpoint defined by RFC 8414.
spring:
  security:
    oauth2:
      client:
        registration:
          appid:
            clientId: <<clientId>>
            clientSecret: <<clientSecret>>
            region: <<region>>
            tenantID: <<tenantID>>
            version: <<version>>
  • region - the region in which the App ID service is created in IBM Cloud. Ex: dallas, london etc.,
  • clientID - is the client id of the App ID service you created.
  • clientSecret - is the client secret of the App ID service you created.
  • tenantID - is the tenant id of the App ID service you created.
  • version - is the App ID endpoints version, it is defaulted to 4, but if you would like to use a different version of App ID then this parameter should be set. This is optional.

If you are not sure of the region, tenantID and version, use the above 2nd configuration by just providing issuerUri.

The starter also supports multiple oauth provider configuration, i.e., you can configure the application with more than one OAuth provider. For example, you can do something like this:

spring:
  security:
    oauth2:
      client:
        registration:
          appid:
            region: <<region>>
            clientId: <<clientId>>
            clientSecret: <<clientSecret>>
            tenantID: <<tenantID>>
          google:
            clientId: <<clientId>>
            clientSecret: <<clientSecret>>

Related Documentation