https://github.com/gravitee-io/gravitee-resource-oauth2-provider-am

Gravitee.io - API Management - Resource - OAuth2 AM
https://github.com/gravitee-io/gravitee-resource-oauth2-provider-am

product-am product-apim security-scan

Last synced: 2 months ago
JSON representation

Gravitee.io - API Management - Resource - OAuth2 AM

• Host: GitHub
• URL: https://github.com/gravitee-io/gravitee-resource-oauth2-provider-am
• Owner: gravitee-io
• License: apache-2.0
• Created: 2017-04-10T13:57:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-15T01:40:18.000Z (4 months ago)
• Last Synced: 2024-09-16T05:55:01.868Z (4 months ago)
• Topics: product-am, product-apim, security-scan
• Language: Java
• Homepage:
• Size: 97.7 KB
• Stars: 1
• Watchers: 29
• Forks: 2
• Open Issues: 13
• Metadata Files:
  • Readme: README.adoc
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.adoc
  • License: LICENSE.txt
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
= Gravitee.io Access Management Resource

ifdef::env-github[]

image:https://img.shields.io/static/v1?label=Available%20at&message=Gravitee.io&color=1EC9D2["Gravitee.io", link="https://download.gravitee.io/#graviteeio-apim/plugins/resources/gravitee-resource-oauth2-provider-am/"]

image:https://img.shields.io/badge/License-Apache%202.0-blue.svg["License", link="https://github.com/gravitee-io/gravitee-resource-oauth2-provider-am/blob/master/LICENSE.txt"]

image:https://img.shields.io/badge/semantic--release-conventional%20commits-e10079?logo=semantic-release["Releases", link="https://github.com/gravitee-io/gravitee-resource-oauth2-provider-am/releases"]

image:https://circleci.com/gh/gravitee-io/gravitee-resource-oauth2-provider-am.svg?style=svg["CircleCI", link="https://circleci.com/gh/gravitee-io/gravitee-resource-oauth2-provider-am"]

image:https://f.hubspotusercontent40.net/hubfs/7600448/gravitee-github-button.jpg["Join the community forum", link="https://community.gravitee.io?utm_source=readme", height=20]

endif::[]

== Description

Gravitee.io Access Management resource is defined to introspect an access_token generated by a Gravitee.io Access

Management instance.

== Compatibility with APIM

|===

|Plugin version | APIM version

|2.x and upper                  | 3.18.x to latest

|1.14.x and upper               | 3.10.x to 3.17.x

|Up to 1.13.x                   | Up to 3.9.x

|===

== Configuration

You can configure the resource with the following options :

|===

|Property |Required |Description |Type |Default

.^|serverURL

^.^|X

|The URL of the Gravitee.io Access Management server.

^.^|string

^.^|-

.^|securityDomain

^.^|X

|The security domain (realm) from where the token has been generated and must be introspect.

^.^|string

^.^|-

.^|clientId

^.^|X

|The client identifier.

^.^|string

^.^|-

.^|clientSecret

^.^|X

|The client secret.

^.^|string

^.^|-

.^|userClaim

^.^|-

|User claim field used to store end user on log analytics.

^.^|string

^.^|sub

.^|useSystemProxy

^.^|-

|Use system proxy.

^.^|boolean

^.^|false

|===

[source, json]

.Configuration example

----

{

    "configuration": {

        "clientId": "my-client",

        "clientSecret": "f2ddb55e-30b5-4a45-9db5-5e30b52a4574",

        "securityDomain": "my-security",

        "serverURL": "https://graviteeio_access_management",

        "userClaim": "sub"

    }

}

----