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

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

Last synced: about 1 month ago
JSON representation

Gravitee.io - Resource - LDAP Authentication Provider

• Host: GitHub
• URL: https://github.com/gravitee-io/gravitee-resource-auth-provider-ldap
• Owner: gravitee-io
• License: apache-2.0
• Created: 2020-09-04T12:32:15.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T08:12:15.000Z (7 months ago)
• Last Synced: 2024-05-23T08:25:40.981Z (7 months ago)
• Language: Java
• Size: 64.5 KB
• Stars: 0
• Watchers: 28
• Forks: 2
• Open Issues: 5
• 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 LDAP 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-ldap/"]

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

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

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

== Configuration

You can configure the resource with the following options :

|===

|Property |Required |Description |Type |Default

.^|contextSourceUrl

^.^|X

|URL to the LDAP server instance

^.^|string

^.^|ldap://myserver.example.com:389

.^|contextSourceBase

^.^|X

|The source base used to authenticate to the LDAP server and query for users when validating user's credentials

^.^|string

^.^|-

.^|contextSourceUsername

^.^|X

|Username credential used to connect to the LDAP server

^.^|string

^.^|-

.^|contextSourcePassword

^.^|X

|Password credential used to connect to the LDAP server

^.^|string

^.^|-

.^|useStartTLS

^.^|X

|Should the API gateway use SSL to connect to the LDAP server

^.^|boolean

^.^|false

.^|userSearchFilter

^.^|X

|LDAP Filter to select the relevant attribute to check the username

^.^|string

^.^|uid={0}

.^|userSearchBase

^.^|X

|Search base used to search into the correct OU when validating user's credentials

^.^|string

^.^|ou=users

|===

[source, json]

.Configuration example

----

{

    "configuration": {

        "contextSourceUrl": "ldap://localhost:1389",

        "contextSourceBase": "dc=example,dc=com",

        "contextSourceUsername": "cn=Directory Manager",

        "contextSourcePassword":"password",

        "useStartTLS": false,

        "userSearchFilter": "uid={0}",

        "userSearchBase": "ou=Special Users",

        "connectTimeout": 5000,

        "responseTimeout": 5000,

        "minPoolSize": 5,

        "maxPoolSize": 15

    }

}

----