Skip to content

Update documentation for Azure AD B2C #145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nijel merged 3 commits into from
Mar 30, 2023
Merged

Update documentation for Azure AD B2C #145

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
72e03c3
Updates to match proposed changes to social-core
zchoate Mar 21, 2023
41a4847
Fix spacing
zchoate Mar 21, 2023
d8d52df
Merge branch 'python-social-auth:master' into update-azuread-b2c
zchoate Mar 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions docs/backends/azuread.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,12 @@ To enable OAuth2 B2C Tenant support:
- Fill in ``Client ID`` and ``Client Secret`` settings. These values can be
obtained easily as described in `Azure AD Application Registration`_ doc::

SOCIAL_AUTH_AZUREAD_B2C_TENANT_OAUTH2_KEY = ''
SOCIAL_AUTH_AZUREAD_B2C_TENANT_OAUTH2_SECRET = ''
SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_KEY = ''
SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_SECRET = ''

- Fill in the tenant id::

SOCIAL_AUTH_AZUREAD_B2C_TENANT_OAUTH2_TENANT_ID = ''
SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_TENANT_NAME = ''

- Fill in the B2C policy::

Expand All @@ -106,29 +106,28 @@ The policy should start with `b2c_`. For more information see `Azure AD B2C User

- Also it's possible to define extra permissions with::

SOCIAL_AUTH_AZUREAD_B2C_TENANT_OAUTH2_RESOURCE = ''
SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_RESOURCE = ''

This is the resource you would like to access after authentication succeeds.
Some of the possible values are: ``https://graph.windows.net`` or
``https://<your Sharepoint site name>-my.sharepoint.com``.

When using Microsoft Graph, the resource needed is::

SOCIAL_AUTH_AZUREAD_B2C_TENANT_OAUTH2_RESOURCE = 'https://graph.microsoft.com/'
SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_RESOURCE = 'https://graph.microsoft.com/'

- Add the backend to the authentication backends setting::

AUTHENTICATION_BACKENDS = (
...
'social_core.backends.azuread_tenant.AzureADB2COAuth2',
'social_core.backends.azuread_b2c.AzureADB2COAuth2',
...
)

- If you are using an authority host other than the default ``AZURE_PUBLIC_CLOUD`` ('login.microsoftonline.com')
then you can override the default with the ``AUTHORITY_HOST`` setting. The Azure authority hosts are listed
in the `Azure Authority Hosts`_ doc::
- If you are using an authority host other than the default ``AZURE_PUBLIC_CLOUD`` ('b2clogin.com')
then you can override the default with the ``AUTHORITY_HOST`` setting.

SOCIAL_AUTH_AZUREAD_B2C_TENANT_OAUTH2_AUTHORITY_HOST = ''
SOCIAL_AUTH_AZUREAD_B2C_OAUTH2_AUTHORITY_HOST = ''

.. _Azure AD Application Registration: https://docs.microsoft.com/en-us/azure/active-directory/develop/quickstart-register-app
.. _Azure AD B2C User flows and custom policies overview: https://docs.microsoft.com/en-us/azure/active-directory-b2c/user-flow-overview
Expand Down