https://github.com/gravitee-io/gravitee-resource-auth-provider-http

Gravitee.io - Resource - HTTP Authentication Provider
https://github.com/gravitee-io/gravitee-resource-auth-provider-http

product-apim security-scan

Last synced: 2 months ago
JSON representation

Gravitee.io - Resource - HTTP Authentication Provider

• Host: GitHub
• URL: https://github.com/gravitee-io/gravitee-resource-auth-provider-http
• Owner: gravitee-io
• License: apache-2.0
• Created: 2021-06-17T06:59:10.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-07-11T07:19:17.000Z (10 months ago)
• Last Synced: 2025-01-07T09:43:37.619Z (4 months ago)
• Topics: product-apim, security-scan
• Language: Java
• Size: 50.8 KB
• Stars: 0
• Watchers: 28
• Forks: 2
• Open Issues: 4
• 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 HTTP Authentication Provider

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-auth-provider-http/"]

image:https://img.shields.io/badge/License-Apache%202.0-blue.svg["License", link="https://github.com/gravitee-io/gravitee-resource-auth-provider-http/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-auth-provider-http/releases"]

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

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 HTTP Authentication Provider resource is used to validate user's credentials against an HTTP server.

== Configuration

You can configure the resource with the following options :

|===

|Property |Required |Description |Type |Default

.^|method

^.^|X

|HTTP method to invoke the endpoint.

^.^|string

^.^|POST

.^|useSystemProxy

^.^|-

|Use the system proxy configured by your administrator

^.^|boolean

^.^|false

.^|url

^.^|X

|The server url

^.^|string

^.^|-

.^|headers

^.^|-

|Request HTTP headers

^.^| -

^.^| -

.^|body

^.^|-

|Request body

^.^|string

^.^|-

.^|condition

^.^|X

|The condition which will be verified to validate that the authentication is successful (support EL).

^.^|string

^.^|{#authResponse.status == 200}

|===

[source, json]

.Configuration example

----

{

    "configuration": {

        "method": "POST",

        "useSystemProxy": false,

        "url": "https://auth-server",

        "headers": [],

        "body": "",

        "condition": "{#authResponse.status == 200}"

    }

}

----