Skip to content
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

Typos, Spelling, Phrasing (in Azure guide & CONTRIBUTING.rst) #191

Merged
merged 2 commits into from
Oct 7, 2021
Merged

Typos, Spelling, Phrasing (in Azure guide & CONTRIBUTING.rst) #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a259f28
Typos, spelling, some phrasing
GeoMaciolek Oct 7, 2021
09c2e6c
Typo (you/your)
GeoMaciolek Oct 7, 2021
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Set up your environment

3. Install dependencies by running ``poetry install``

4. Create a new branch for you changes
4. Create a new branch for your changes

5. Push the topic branch to your personal fork

Expand Down
20 changes: 10 additions & 10 deletions docs/azure_ad_config_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Azure AD
========

Getting this module to work is sometimes not so straight forward. If your not familiar with JWT tokens or Azure AD
itself, it might take some tries to get all settings right.
Getting this module to work is sometimes not so straightforward. If you're not familiar with JWT tokens or Azure AD
itself, it might take some tries to get all the settings right.

This guide tries to give a basic overview of how to configure Azure AD and how to determine the settings for
django-auth-adfs. Installing and configuring the basics of Azure AD is not explained here.
Expand All @@ -19,7 +19,7 @@ After signing in to `Azure <https://portal.azure.com>`_. Open the **Azure Active
------------


Note down your **Tenant_ID** you will need it later.
Note down your **Tenant_ID** as you will need it later.


.. image:: _static/AzureAD/02-azure_dashboard.png
Expand Down Expand Up @@ -68,7 +68,7 @@ Next we need to generate a **Client_Secret**. Your application will use this to
------------


Give it a short name. It is not important what it is, only used by you, to better keep track of them incase you make more.
Give it a short (display) name. This is only used by you, to help keep track of in case you make more client secrets.


.. image:: _static/AzureAD/07-add_Secret_name.png
Expand All @@ -77,7 +77,7 @@ Give it a short name. It is not important what it is, only used by you, to bette
------------


It will be become hidden after a short time, so be sure to note this one down quick.
Copy your secret (value). It will be become hidden after a short time, so be sure to note this quickly.


.. image:: _static/AzureAD/08-copy_Secret.png
Expand All @@ -89,7 +89,7 @@ It will be become hidden after a short time, so be sure to note this one down qu

Step 2 - Configuring settings.py
--------------------------------
We need to update the ``settings.py`` to accomedate for our registered Azure AD application.
We need to update the ``settings.py`` to accommodate our registered Azure AD application.

Replace your AUTH_ADFS with this.

Expand All @@ -98,14 +98,14 @@ Replace your AUTH_ADFS with this.
# Client secret is not public information. Should store it as an environment variable.

client_id = 'Your client id here'
cient_secret = 'Your client secret here'
client_secret = 'Your client secret here'
tenant_id = 'Your tenant id here'


AUTH_ADFS = {
'AUDIENCE': client_id,
'CLIENT_ID': client_id,
'CLIENT_SECRET': cient_secret,
'CLIENT_SECRET': client_secret,
'CLAIM_MAPPING': {'first_name': 'given_name',
'last_name': 'family_name',
'email': 'upn'},
Expand All @@ -129,7 +129,7 @@ Add this to your AUTHENTICATION_BACKENDS.



Add this path to your projects ``urls.py`` file.
Add this path to your project's ``urls.py`` file.

.. code-block:: python

Expand Down Expand Up @@ -203,7 +203,7 @@ Here you need to paste in your frontend application (client) id.

------------

Now navigate back to app registrations. Click on your **frontend** application and navigate to API permissions. Press **add a permisson**.
Now navigate back to app registrations. Click on your **frontend** application and navigate to API permissions. Press **add a permission**.


.. image:: _static/AzureAD/17_navigate_to_api_permissions.PNG
Expand Down