Skip to content

Commit 85c95ad

Browse files
authored
Fixed grammar
1 parent c13c01a commit 85c95ad

File tree

1 file changed

+61
-57
lines changed

1 file changed

+61
-57
lines changed

umbraco-cloud/begin-your-cloud-journey/the-cloud-portal/organizations/organization-login-providers.md

Lines changed: 61 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ description: Learn how to configure and use external login providers via your Um
1010

1111
{% endhint %}
1212

13-
The External Login Providers feature in Umbraco Cloud allows you to integrate third-party authentication systems to manage Portal user logins securely and efficiently. This functionality is especially useful for teams that want to simplify login management or use their existing identity systems.
13+
The External Login Providers feature in Umbraco Cloud enables you to integrate third-party authentication systems for managing Portal user logins securely and efficiently. This functionality is built for teams that want to manage login using an existing identity setup.
1414

15-
Using OpenID Connect, Umbraco Cloud supports external login providers such as Microsoft Entra ID, Auth0, Google, and so on. This feature helps administrators manage backoffice access, assign user roles, and improve security.
15+
Using OpenID Connect, Umbraco Cloud supports external login providers like Microsoft Entra ID, Auth0, and Google. The feature helps administrators manage backoffice access, assign user roles, and improve security.
1616

1717
{% hint style="info" %}
1818

@@ -23,13 +23,13 @@ This is exclusively for Cloud Portal access and access to Project features only
2323
## External Login Providers
2424

2525
{% hint style="info" %}
26-
The Organization Areas is only available for user logged in with Umbraco Id. Additionally the Login Providers Section can only be accessed by user who has Admin rights to the Organization.
26+
The Organization Areas are only available for users logged in with Umbraco ID. Additionally, the Login Providers Section can only be accessed by a user who has Admin rights to the Organization.
2727
{% endhint %}
2828

29-
This guide shows you how to set up and configure external login providers for the Cloud Portal, and configure related Project Permissions. It includes the following steps:
29+
This guide shows you how to set up and configure external login providers for the Cloud Portal, including related Project Permissions. It includes the following steps:
3030

31-
- [Prepare your Login Provider](#prepare-your-login-provider)
32-
- [Register the Login Provider in Cloud Portal](#register-the-login-provider-in-cloud-portal)
31+
1. [Prepare your Login Provider](#prepare-your-login-provider)
32+
2. [Register the Login Provider in Cloud Portal](#register-the-login-provider-in-cloud-portal)
3333

3434
### Prepare your Login Provider
3535

@@ -50,18 +50,18 @@ This guide shows you how to set up and configure external login providers for th
5050

5151
6. Click **Register**.
5252

53-
Once the app has been registered, you must find and note down a series of keys. These keys will be used to set up the login provider on Umbraco Cloud.
54-
55-
Locate and note down the following keys:
53+
Once the app has been registered, locate and note down the following keys.
5654

5755
* **Application (client) ID** - found on the **Overview** page for the app.
5856
* **Authority URL** - available from **Endpoints** on the **Overview** page.
5957
* **Secret ID** - needs to be generated on the **Certificates & Secrets** page.
6058

59+
These keys will be used to set up the login provider on Umbraco Cloud.
60+
6161
{% hint style="info" %}
6262
**Enterprise or custom setup**
6363

64-
If you're working with an enterprise or a custom setup, ensure the email claim is included in the ID token configuration.
64+
When working with an enterprise or a custom setup, ensure that the email claim is included in the ID token configuration.
6565
{% endhint %}
6666

6767
{% endtab %}
@@ -107,7 +107,7 @@ Before you move on, take note of the following keys:
107107
{% endtab %}
108108
{% endtabs %}
109109

110-
Once you have the keys from your login provider, you need to follow the next steps in the Umbraco Cloud Portal.
110+
Once you have the keys from your login provider, follow the next steps in the Umbraco Cloud Portal.
111111

112112
Keep the configuration for your login provider open, as you will come back to it later in the guide.
113113

@@ -125,7 +125,6 @@ Keep the configuration for your login provider open, as you will come back to it
125125

126126
<figure><img src="../../../.gitbook/assets/organization-external-login-provider-configuration.png" alt=""><figcaption></figcaption></figure>
127127

128-
129128
6. Click **Create** to add the new configuration.
130129
7. Click on **Sign-in and Redirect Urls**.
131130
8. Take note of the Redirect URI.
@@ -137,8 +136,8 @@ Keep the configuration for your login provider open, as you will come back to it
137136
1. Click on **Authentication**.
138137
2. Select **Add a platform**.
139138
3. Select **Web** and add the Redirect URI.
140-
4. Add more Redirects URIs if needed.
141-
5. Under **Implicit grant and hybrid flows** check the following options:
139+
4. Add more Redirect URIs if needed.
140+
5. Check the following options under **Implicit grant and hybrid flows**:
142141
* Access Tokens (used for implicit flows)
143142
* ID tokens (used for implicit and hybrid flows)
144143
6. Click **Configure** to complete the configuration.
@@ -151,7 +150,7 @@ Keep the configuration for your login provider open, as you will come back to it
151150
1. Navigate to the **Settings** section.
152151
2. Scroll down to find the **Application URIs**.
153152
3. Add the Redirect URI to the **Allowed Callback URLs**.
154-
4. Also add the Redirect URI to the **Allowed Logout URLs**
153+
4. Add the Redirect URI to the **Allowed Logout URLs** as well.
155154

156155
![Add the Redirect URI to the Allowed Callback URLs](../../../.gitbook/assets/auth0-portal-callback.png)
157156

@@ -171,97 +170,99 @@ Keep the configuration for your login provider open, as you will come back to it
171170

172171
## How to fill in the External Login Provider Configuration
173172

174-
Learn about what type of data and information you need for each field in the configuration form.
173+
This section provides an overview of what type of data and information is needed for each field in the configuration form.
175174

176175
### Display Name
177176

178-
A Friendly name for the Login Provider
177+
A descriptive name for the Login Provider
179178

180179
### Alias (required)
181180

182-
A unique alias for the provider in the Organization.
183-
Use only lower-case.
184-
Spaces are not allowed.
181+
A unique alias for the provider in the Organization. Use only lower-case. Spaces are not allowed.
185182

186183
### Client Id (required)
187184

188-
A unique Client ID generated in the external login provider.Entra ID: Guid<br>Auth0: Random characters<br>Google: <code>{randomchars}.apps.googleusercontent.com</code>
185+
A unique Client ID is generated in the external login provider.
189186

187+
* Entra ID: Guid
188+
* Auth0: Random characters
189+
* Google: `{randomchars}.apps.googleusercontent.com`
190190

191191
### Client Secret (required)
192192

193-
A secret that is generated in the External Login Provider and is associated with the Client Id.
194-
193+
A secret that is generated in the external login provider and is associated with the Client ID.
195194

196195
### Authority (required)
197196

198-
The URL for the External Login Provider. This can be found in the External Login Provider.
197+
The URL for the external login provider. This can be found in the External Login Provider.
199198

200199
Entra ID: `https://login.microsoftonline.com/&#x3C;Directory (tenant)>`
201200
Auth0: `https://{accountId}.uk.auth0.com`
202201
Google: `https://accounts.google.com`
203202

204-
205203
### Metadata Address
206204

207-
If you need a special metadata address for your External Login Provider, you can set it here. By default, the system will resolve the metadata address from the Authority Url, which is why this property is optional.
205+
If you need a special metadata address for your External Login Provider, you can set it here. By default, the system resolves the metadata address from the Authority URL, making the property optional.
208206

209207
A common scenario for using a special metadata address is when working with Entra ID and configuring claims mapping. In this case, you must set the metadata address to the following: `https://login.microsoftonline.com/{tenant}/v2.0/.well-known/openid-configuration?appid={client-id}`.
210208

211209
### User Mapping Claim Name
212210

213-
Your provider may assign users to specific roles (For example: Admin, Editor, Viewer).<br><br>The <strong>User Mapping Claim Name</strong> is the field in the authentication token (claim) that identifies these roles. The system reads this claim to determine a user’s permissions.
211+
Your provider may assign users to specific roles. For example: Admin, Editor, Viewer.
212+
213+
The **User Mapping Claim Name** is the field in the authentication token (claim) that identifies these roles. The system reads this claim to determine a user's permissions.
214214

215-
Example: If the roles claim is called `user_roles` in your provider, you set the **User Mapping Claim Name** to `user_roles`.
215+
For example, if the roles claim is called `user_roles` in your provider, you set the **User Mapping Claim Name** to `user_roles`.
216216

217217
## Signing in using the Login Provider
218218

219-
When trying to access Umbraco Cloud Portal through `s1.umbraco.io` you will still be greeted by an Umbraco ID sign in screen.
219+
When trying to access Umbraco Cloud Portal through `s1.umbraco.io`, you are greeted by an Umbraco ID sign-in screen.
220220

221-
In order to sign in with your Login Provider you will need to use a special sign-in URL, unique to your Login Provider.
221+
To sign in with your login provider, you must use a special sign-in URL that is unique to your Login Provider.
222222

223-
You need to go back to Cloud Portal where you registered the Login Provider. On this page click on the `Sign-in and Redirect Urls` button.
223+
1. Go back to Cloud Portal, where you registered the Login Provider.
224+
2. Click on the `Sign-in and Redirect URLs` button.
224225

225226
<figure><img src="../../../.gitbook/assets/organization-elp-signin-url.gif" alt=""><figcaption>How to retrive the Sign in Url</figcaption></figure>
226227

227-
Give this Url to the Organization members you want to sign in using your Login Provider.
228+
3. Give the URL to the Organization members you want to sign in using your Login Provider.
228229

229230
## Project Permissions
230231

231-
Here you will setup access to Projects in the Portal while signed in with your Login Provider.
232+
Project Permissions lets you set up access to Projects in the Portal while signed in with your Login Provider.
232233

233-
You will need to add a Project Permission model per Project and per Login Provider. It is not required to add Project Permissions to all project. Projects without a Project Permissions tied to a Login Provider will not be shown to user logged in with that particular Login Provider.
234+
You must add one Project Permission model per Project and one per Login Provider. It is not required to add Project Permissions to all projects. Projects without a Project Permissions tied to a Login Provider will not be shown to a user logged in with that particular Login Provider.
234235

235236
<figure><img src="../../../.gitbook/assets/organization-elp-project-permission-screen.png" alt=""><figcaption>Project Permission Screen</figcaption></figure>
236237

237-
When setting up a Project Permission first select a Project in the left side of the screen. Next click on "+ Add" on the Login Provider you want to add a Project Permissions for.
238+
To set up Project Permission, follow these steps:
238239

239-
<figure><img src="../../../.gitbook/assets/organization-elp-project-permission-add.png" alt=""><figcaption>Add Project Permission</figcaption></figure>
240+
1. Select a Project on the left side of the screen.
241+
2. Click on "+ Add" on the Login Provider you want to add Project Permissions for.
240242

243+
<figure><img src="../../../.gitbook/assets/organization-elp-project-permission-add.png" alt=""><figcaption>Add Project Permission</figcaption></figure>
241244

242-
The modal has the following fields:
243-
244-
- Default Access Level (required)
245-
- No Claim Found Behavior (required)
246-
- User Mapping Claim Name
247-
- Project User Mappings
248-
- Consists of two fields: "Provider Role Value" and "Project Access Level"
245+
3. Fill in the fields in the modal:
246+
- Default Access Level (required)
247+
- No Claim Found Behavior (required)
248+
- User Mapping Claim Name
249+
- Project User Mappings
250+
- Consists of two fields: "Provider Role Value" and "Project Access Level"
249251

250252
## How to fill in the Project Permissions
251253

252254
### Default Access Level
253255

254-
Select the level of access you want users signing in with the External Login Provider to get for this Project.
256+
Select the level of access you want users to get for this project.
255257

256258
The dropdown has two possible permissions:
257259

258260
- Read Only
259261
- Read and Write
260262

261-
262263
#### Read
263264

264-
A team member with Read permissions can only view the project in the portal as well as the backoffices. They are not able to deploy or change anything on the project itself.
265+
A team member with Read permissions can only view the project in the portal and the backoffice. They are not able to deploy or change anything on the project itself.
265266

266267
#### Read And Write
267268

@@ -272,33 +273,36 @@ If there are no Mappings available for the user the "No Claim Found Behavior" se
272273

273274
### No Claim Found Behavior
274275

275-
Use this setting for more fine grained control.
276-
This will allow you to use the Role Claim in you Login Provider to assign Permissions to your users.
276+
This setting is used for adding granular control.
277+
278+
You can use the Role Claim from your Login Provider to assign Permissions to your users.
277279

278-
The setting has two Settings:
280+
The setting has two options:
281+
279282
- NoAccess
280283
- Use Default Access Level
281284

282-
When `NoAccess` is selected it will block the users access to the Project if they do not have the correct Role assigned.
283-
Using the "Use Default Access Level"-option, all users in your Login Provider will automatic get the permission you selected in "Default Access Level". Unless they have a hit on the Project User Mappings.
285+
When `NoAccess` is selected, it will block the user's access to the Project if they do not have the correct Role assigned.
286+
287+
Using the "Use Default Access Level" option, all users in your Login Provider will automatically get the permission you selected in "Default Access Level". The only exception is when they have a hit on the Project User Mappings.
284288

285289
### User Mapping Claim Name
286290

287-
Enter the name of your providers default or custom Role claim name. This is if you want to override the one already entered in the Login Provider configuration.
291+
This is used for the name of your provider's default or custom Role claim name. Use this if you want to override the one already entered in the Login Provider configuration.
288292

289293
### Project User Mappings
290294

291295
Use this to map the Provider Role Value (a role coming from your external login provider) to a Project Permission Level in the portal.
292296

293297
If your external login provider is configured to assign roles to users, those role values are included in the ID token. You can then use these values to automatically assign the appropriate access level when the user signs in to the portal.
294298

295-
For example, a role like `Happy.Write` from your identity provider could be mapped to the `Read And Write` permission level for your Cloud project.
299+
For example, a role like `Happy.Write` from your identity provider could be mapped to the `Read and Write` permission level for your Cloud project.
296300

297301
## Audit
298302

299-
Use Audit section to troubleshoot your Login Providers and keep an eye on user Sign-ins.
303+
Use the Audit section to troubleshoot your Login Providers and keep an eye on user Sign-ins.
300304

301-
There is audit log for each Login Provider. Keep in mind that if you remove the Login Provider the audit log will also disappear.
305+
There is an audit log for each Login Provider. If you remove the Login Provider, the audit log will also disappear.
302306

303307
<figure><img src="../../../.gitbook/assets/organization-elp-audit-screen.png" alt=""><figcaption>Audit page</figcaption></figure>
304308

@@ -307,6 +311,6 @@ The following audit types are listed:
307311
| Type | Sub-Type | Description |
308312
|---|---|---|
309313
| User Sign-ins | - | See information about Project Permissions evaluated at the Sign-in. |
310-
| External Login Providers | Added and Updated | Entries includes the changed properties. The Client Secret is always redacted. |
311-
| Project Permission | Added, Updated and Deleted | Shows information on the changed properties and stored Role mapping options |
314+
| External Login Providers | Added and Updated | Entries include the changed properties. The Client Secret is always redacted. |
315+
| Project Permission | Added, Updated, and Deleted | Shows information on the changed properties and stored Role mapping options |
312316

0 commit comments

Comments
 (0)