You are here

Home » API reference » Social Auth LinkedIn 8

README.txt in Social Auth LinkedIn 8

Same filename and directory in other branches
  1. 8.2 README.txt
SOCIAL AUTH LINKEDIN MODULE

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

Social Auth LinkedIn Module is a LinkedIn Authentication integration for Drupal.
It is based on the Social Auth Google and Social API projects, as well as in the
LinkedIn PHP Library developed by ashwinks

https://github.com/ashwinks/PHP-LinkedIn-SDK

It adds to the site:
* A new url: /user/login/linkedin
* A settings form on /admin/config/social-api/social-auth/linkedin page
* A LinkedIn Logo in the Social Auth Login block.

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

This module requires the following modules:

 * Social Auth (https://drupal.org/project/social_auth)
 * Social API (https://drupal.org/project/social_api)

HOW IT WORKS
------------

User can click on the LinkedIn logo on the Social Auth Login block
You can also add a button or link anywhere on the site that points
to /user/login/linkedin, so theming and customizing the button or link
is very flexible.

When the user opens the /user/login/linkedin link, it automatically takes
user to LinkedIn for authentication. LinkedIn then returns the user to
Drupal site. If we have an existing Drupal user with the same email address
provided by LinkedIn, that user is logged in. Otherwise a new Drupal user is
created.

CREATE LINKEDIN APPLICATION
---------------

Go to https://www.linkedin.com/developer/apps and create a new application.
After creating it, make sure both r_basicprofile and r_emailaddress permissions
are checked.

The Client ID and Client Secret values will be required when configuring the
module

Your Oauth 2.0 authorized redirect url will be
[your_base_url]/user/login/linkedin/callback


INSTALL SOCIAL AUTH LINKEDIN
-----------------------------

Install module using composer to take care of dependencies

composer require "drupal/social_auth_linkedin:~1.0"

Activate the Social Auth LinkedIn module and configure the Client ID and Client
Secret acquired using the values acquired from LinkedIn.

The LinkedIn Auth button should now be appearing in the Social Auth Block


SUPPORT REQUESTS
----------------

Before posting a support request, carefully read the installation
instructions provided in module documentation page.

Before posting a support request, check Recent log entries at
admin/reports/dblog

When posting a support request, please inform if you were able to see any errors
in Recent log entries.

RUNNING TESTS
-----------------

Running PHPUnit tests

cd core
 ../vendor/bin/phpunit ../modules/contrib/social_auth_linkedin/tests/src/Unit/LinkedinAuthManagerTest.php

Running Functional Tests

php core/scripts/run-tests.sh --browser --verbose --class "Drupal\Tests\social_auth_linkedin\Functional\LinkedinAuthTest"

File

README.txt
View source 
  1. SOCIAL AUTH LINKEDIN MODULE

  2. 

  3. INTRODUCTION

  4. ------------

  5. 

  6. Social Auth LinkedIn Module is a LinkedIn Authentication integration for Drupal.

  7. It is based on the Social Auth Google and Social API projects, as well as in the

  8. LinkedIn PHP Library developed by ashwinks

  9. 

  10. https://github.com/ashwinks/PHP-LinkedIn-SDK

  11. 

  12. It adds to the site:

  13. * A new url: /user/login/linkedin

  14. * A settings form on /admin/config/social-api/social-auth/linkedin page

  15. * A LinkedIn Logo in the Social Auth Login block.

  16. 

  17. REQUIREMENTS

  18. ------------

  19. 

  20. This module requires the following modules:

  21. 

  22.  * Social Auth (https://drupal.org/project/social_auth)

  23.  * Social API (https://drupal.org/project/social_api)

  24. 

  25. HOW IT WORKS

  26. ------------

  27. 

  28. User can click on the LinkedIn logo on the Social Auth Login block

  29. You can also add a button or link anywhere on the site that points

  30. to /user/login/linkedin, so theming and customizing the button or link

  31. is very flexible.

  32. 

  33. When the user opens the /user/login/linkedin link, it automatically takes

  34. user to LinkedIn for authentication. LinkedIn then returns the user to

  35. Drupal site. If we have an existing Drupal user with the same email address

  36. provided by LinkedIn, that user is logged in. Otherwise a new Drupal user is

  37. created.

  38. 

  39. CREATE LINKEDIN APPLICATION

  40. ---------------

  41. 

  42. Go to https://www.linkedin.com/developer/apps and create a new application.

  43. After creating it, make sure both r_basicprofile and r_emailaddress permissions

  44. are checked.

  45. 

  46. The Client ID and Client Secret values will be required when configuring the

  47. module

  48. 

  49. Your Oauth 2.0 authorized redirect url will be

  50. [your_base_url]/user/login/linkedin/callback

  51. 

  52. 

  53. INSTALL SOCIAL AUTH LINKEDIN

  54. -----------------------------

  55. 

  56. Install module using composer to take care of dependencies

  57. 

  58. composer require "drupal/social_auth_linkedin:~1.0"

  59. 

  60. Activate the Social Auth LinkedIn module and configure the Client ID and Client

  61. Secret acquired using the values acquired from LinkedIn.

  62. 

  63. The LinkedIn Auth button should now be appearing in the Social Auth Block

  64. 

  65. 

  66. SUPPORT REQUESTS

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

  68. 

  69. Before posting a support request, carefully read the installation

  70. instructions provided in module documentation page.

  71. 

  72. Before posting a support request, check Recent log entries at

  73. admin/reports/dblog

  74. 

  75. When posting a support request, please inform if you were able to see any errors

  76. in Recent log entries.

  77. 

  78. RUNNING TESTS

  79. -----------------

  80. 

  81. Running PHPUnit tests

  82. 

  83. cd core

  84.  ../vendor/bin/phpunit ../modules/contrib/social_auth_linkedin/tests/src/Unit/LinkedinAuthManagerTest.php

  85. 

  86. Running Functional Tests

  87. 

  88. php core/scripts/run-tests.sh --browser --verbose --class "Drupal\Tests\social_auth_linkedin\Functional\LinkedinAuthTest"