You are here

Home » API reference » OpenID Connect / OAuth client 2.x

README.txt in OpenID Connect / OAuth client 2.x

Same filename and directory in other branches
  1. 8 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Usage
 * Requirements
 * Features
 * Installation
 * Configuration
 * Troubleshooting
 * Maintainers
 * Known Issues


INTRODUCTION
------------

The OpenID Connect module provides a pluggable client implementation for the
OpenID Connect protocol. The server implementation of the protocol is provided
by OAuth2 Server.

OpenID Connect 1.0 is a simple identity layer on top of the OAuth 2.0 protocol.
It allows Clients to verify the identity of the End-User based on the
authentication performed by an Authorization Server, as well as to obtain basic
profile information about the End-User in an interoperable and REST-like manner.


USAGE
-----

The module allows you to use an external OpenID Connect login provider to
authenticate and log in users on your site. If a user signs in with a login
provider for the first time on the website, a new Drupal user will be created.
Google for instance uses OpenID Connect to authenticate users across all of
their services.


REQUIREMENTS
------------

No special requirements.


FEATURES
--------

 * Supported login providers
 * Login with Google
 * Client configuration
 * Fetching user profile information
 * Sign in block

For a more detailed description and instructions please refer to the
documentation (https://www.drupal.org/node/2274339).

PERMISSIONS:

The module adds a new permission section entitled OpenID Connect API with
three new user rights:

 * Administer OpenID Connect clients
 * Manage own connected accounts
 * Set a password for local authentication.


INSTALLATION
------------

Install as you would normally install a contributed Drupal module.
Visit: https://www.drupal.org/project/openid_connect for further information.


CONFIGURATION
-------------

Configuration options are available at
Administration >> Configuration >> Services >> OpenID Connect.
You can enable clients for login providers and configure their client ID and
client secret which are necessary credentials for authenticating with an OAuth2
server.


TROUBLESHOOTING
---------------

A standard Drupal block is available to sign in with the login providers for
which clients are enabled.
A single button is shown for each login provider.
In case if the login block does not display on the user's login page, check it
in the blocks list Administration >> Structure >> Block layout


MAINTAINERS
-----------

Current maintainers:

 * Stefan Auditor (sanduhrs)
 * Patrick Dawkins (pjcdawkins)
 * Bojan Živanović (bojanz)
 * Bálint Kléri (balintk)

Development is sponsored by:
 * Commerce Guys and thanks to Bojan Živanović (bojanz) for helping to architect
   the module.


KNOWN ISSUES
------------

Issues: https://www.drupal.org/project/issues/openid_connect?categories=All

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Usage

  6.  * Requirements

  7.  * Features

  8.  * Installation

  9.  * Configuration

  10.  * Troubleshooting

  11.  * Maintainers

  12.  * Known Issues

  13. 

  14. 

  15. INTRODUCTION

  16. ------------

  17. 

  18. The OpenID Connect module provides a pluggable client implementation for the

  19. OpenID Connect protocol. The server implementation of the protocol is provided

  20. by OAuth2 Server.

  21. 

  22. OpenID Connect 1.0 is a simple identity layer on top of the OAuth 2.0 protocol.

  23. It allows Clients to verify the identity of the End-User based on the

  24. authentication performed by an Authorization Server, as well as to obtain basic

  25. profile information about the End-User in an interoperable and REST-like manner.

  26. 

  27. 

  28. USAGE

  29. -----

  30. 

  31. The module allows you to use an external OpenID Connect login provider to

  32. authenticate and log in users on your site. If a user signs in with a login

  33. provider for the first time on the website, a new Drupal user will be created.

  34. Google for instance uses OpenID Connect to authenticate users across all of

  35. their services.

  36. 

  37. 

  38. REQUIREMENTS

  39. ------------

  40. 

  41. No special requirements.

  42. 

  43. 

  44. FEATURES

  45. --------

  46. 

  47.  * Supported login providers

  48.  * Login with Google

  49.  * Client configuration

  50.  * Fetching user profile information

  51.  * Sign in block

  52. 

  53. For a more detailed description and instructions please refer to the

  54. documentation (https://www.drupal.org/node/2274339).

  55. 

  56. PERMISSIONS:

  57. 

  58. The module adds a new permission section entitled OpenID Connect API with

  59. three new user rights:

  60. 

  61.  * Administer OpenID Connect clients

  62.  * Manage own connected accounts

  63.  * Set a password for local authentication.

  64. 

  65. 

  66. INSTALLATION

  67. ------------

  68. 

  69. Install as you would normally install a contributed Drupal module.

  70. Visit: https://www.drupal.org/project/openid_connect for further information.

  71. 

  72. 

  73. CONFIGURATION

  74. -------------

  75. 

  76. Configuration options are available at

  77. Administration >> Configuration >> Services >> OpenID Connect.

  78. You can enable clients for login providers and configure their client ID and

  79. client secret which are necessary credentials for authenticating with an OAuth2

  80. server.

  81. 

  82. 

  83. TROUBLESHOOTING

  84. ---------------

  85. 

  86. A standard Drupal block is available to sign in with the login providers for

  87. which clients are enabled.

  88. A single button is shown for each login provider.

  89. In case if the login block does not display on the user's login page, check it

  90. in the blocks list Administration >> Structure >> Block layout

  91. 

  92. 

  93. MAINTAINERS

  94. -----------

  95. 

  96. Current maintainers:

  97. 

  98.  * Stefan Auditor (sanduhrs)

  99.  * Patrick Dawkins (pjcdawkins)

  100.  * Bojan Živanović (bojanz)

  101.  * Bálint Kléri (balintk)

  102. 

  103. Development is sponsored by:

  104.  * Commerce Guys and thanks to Bojan Živanović (bojanz) for helping to architect

  105.    the module.

  106. 

  107. 

  108. KNOWN ISSUES

  109. ------------

  110. 

  111. Issues: https://www.drupal.org/project/issues/openid_connect?categories=All