Skip to content

Commit 5721167

Browse files
committed
fix(user-account-connect-saml-sso): rename connect-saml-sso doc title and slug
This title is misleading and may let people think that this documentation is about SSO in a generic way, but it's about AD FS SSO. Rename ADFS to AD FS as well (official Microsoft naming) Signed-off-by: sebferrer <[email protected]>
1 parent d0d9f7c commit 5721167

File tree

1 file changed

+20
-20
lines changed
  • pages/account/customer/ovhcloud-account-connect-saml-adfs

1 file changed

+20
-20
lines changed

pages/account/customer/ovhcloud-account-connect-saml-adfs/guide.en-gb.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,36 @@
11
---
2-
title: Enabling SSO connections with your OVHcloud account
3-
slug: connect-saml-sso
4-
excerpt: "Find out how to link your ADFS to your OVHcloud account using SAML 2.0"
2+
title: Enabling Active Directory Federation Services (AD FS) SSO connections with your OVHcloud account
3+
slug: connect-saml-sso-adfs
4+
excerpt: "Find out how to link your Active Directory Federation Services (AD FS) to your OVHcloud account using SAML 2.0"
55
section: 'Advanced use'
66
order: 02
7-
updated: 2022-10-13
7+
updated: 2023-04-06
88
---
99

1010
**Last updated 13th October 2022**
1111

1212
## Objective
1313

14-
You can use **single sign-on** (SSO) to connect to your OVHcloud account. To enable these connections, your account and your Active Directory Federation Services (ADFS) have to be configured using Security Assertion Markup Language (SAML) authentications.
14+
You can use **single sign-on** (SSO) to connect to your OVHcloud account. To enable these connections, your account and your Active Directory Federation Services (AD FS) have to be configured using Security Assertion Markup Language (SAML) authentications.
1515

1616
**This guide explains how to link your OVHcloud account to an external Active Directory.**
1717

1818
## Requirements
1919

20-
- Active Directory Federation Services (ADFS) running on your server
20+
- Active Directory Federation Services (AD FS) running on your server
2121
- An [OVHcloud account](https://docs.ovh.com/gb/en/customer/create-ovhcloud-account/)
2222
- Access to the [OVHcloud Control Panel](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.co.uk/&ovhSubsidiary=GB)
2323

2424
## Instructions
2525

2626
> [!primary]
2727
>
28-
> In order for a service provider (i.e. your OVHcloud account) to perform an SSO connection with an identity provider (i.e. your ADFS), the essential part is to establish a mutual trust relationship.
28+
> In order for a service provider (i.e. your OVHcloud account) to perform an SSO connection with an identity provider (i.e. your AD FS), the essential part is to establish a mutual trust relationship.
2929
>
3030
31-
### Establishing ADFS trust
31+
### Establishing AD FS trust
3232

33-
Your ADFS acts as your identity provider. Authentication requests by your OVHcloud account will only be accepted if it is declared as a trusted party first.
33+
Your AD FS acts as your identity provider. Authentication requests by your OVHcloud account will only be accepted if it is declared as a trusted party first.
3434

3535
In the Active Directory context, this means adding it as `Relying Party Trust`.
3636

@@ -77,7 +77,7 @@ Click `Next`{.action} again to proceed.
7777

7878
![ADFS add relying party trust step 5](images/adfs_add_relying_party_trust_5.png){.thumbnail}
7979

80-
Click the `Close`{.action} button in the last window. The OVHcloud relying party trust is now added to your ADFS.
80+
Click the `Close`{.action} button in the last window. The OVHcloud relying party trust is now added to your AD FS.
8181

8282
![ADFS relying party trusts](images/adfs_relying_party_trusts.png){.thumbnail}
8383

@@ -121,11 +121,11 @@ Click the `Apply`{.action} button and confirm with `OK`{.action}.
121121

122122
![ADFS relying party trust mapping step 6](images/adfs_relying_party_trusts_mapping_6.png){.thumbnail}
123123

124-
With the mapping completed, your ADFS now trusts OVHcloud as a service provider. The next step is to ensure that the OVHcloud account trusts your ADFS as identity provider.
124+
With the mapping completed, your AD FS now trusts OVHcloud as a service provider. The next step is to ensure that the OVHcloud account trusts your AD FS as identity provider.
125125

126126
### Establishing OVHcloud account trust and configuring the connection
127127

128-
Adding your ADFS as a trusted identity provider is done in the [OVHcloud Control Panel](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.co.uk/&ovhSubsidiary=GB) where you can provide the identity provider metadata.
128+
Adding your AD FS as a trusted identity provider is done in the [OVHcloud Control Panel](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.co.uk/&ovhSubsidiary=GB) where you can provide the identity provider metadata.
129129

130130
[Log in](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.co.uk/&ovhSubsidiary=GB) and click on your profile in the top-right corner.
131131

@@ -143,11 +143,11 @@ Click on the `SSO Login`{.action} button.
143143

144144
![OVHcloud connect SSO step 1](images/ovhcloud_user_management_connect_sso_1.png){.thumbnail}
145145

146-
Fill in the XML metadata of your ADFS. The "Group Attribute Name" is optional in this case. Click on `Confirm`{.action}.
146+
Fill in the XML metadata of your AD FS. The "Group Attribute Name" is optional in this case. Click on `Confirm`{.action}.
147147

148148
![OVHcloud connect SSO step 2](images/ovhcloud_user_management_connect_sso_2.png){.thumbnail}
149149

150-
You should now see your ADFS as identity provider, as well as the default groups.
150+
You should now see your AD FS as identity provider, as well as the default groups.
151151

152152
![OVHcloud connect SSO step 3](images/ovhcloud_user_management_connect_sso_3.png){.thumbnail}
153153

@@ -161,21 +161,21 @@ The `...`{.action} button enables you to update or delete the SSO, and to see de
161161

162162
![OVHcloud connect SSO step 6](images/ovhcloud_user_management_connect_sso_6.png){.thumbnail}
163163

164-
The trust of your ADFS as identity provider is thus established but you still have to add groups to your OVHcloud account.
164+
The trust of your AD FS as identity provider is thus established but you still have to add groups to your OVHcloud account.
165165

166166
> [!warning]
167167
> If you try to connect at this stage via SSO, you will probably receive a `Not in valid groups` error message.
168168
>
169169
> That is because your OVHcloud account checks if the authenticating user belongs to a group that actually exists on the account.
170170
>
171171
172-
To resolve this, verify which information is mapped to the "Group" attribute that your ADFS returns.
172+
To resolve this, verify which information is mapped to the "Group" attribute that your AD FS returns.
173173

174174
Consider the following example of the user "John Doe" from your Active Directory as shown in the image below.
175175

176176
![ADFS user](images/adfs_user.png){.thumbnail}
177177

178-
Next, check the mapping in ADFS:
178+
Next, check the mapping in AD FS:
179179

180180
![ADFS relying party trust mapping](images/adfs_relying_party_trusts_mapping_4.png){.thumbnail}
181181

@@ -206,19 +206,19 @@ You can then check that the group is added to your OVHcloud account in the `Grou
206206

207207
When you connect with the Active Directory user "johndoe" now, your OVHcloud account will recognize that the user has the "REGULAR" role, specified by its group.
208208

209-
You can then disconnect from your account and log in again with your ADFS as identity provider.
209+
You can then disconnect from your account and log in again with your AD FS as identity provider.
210210

211211
### Connect via SSO
212212

213213
On the [OVHcloud login page](https://www.ovh.com/auth/?action=gotomanager&from=https://www.ovh.co.uk/&ovhSubsidiary=GB), enter your [NIC handle](https://docs.ovh.com/gb/en/customer/create-ovhcloud-account/#what-is-my-nic-handle) followed by **/idp** without entering a password, and click the `Login`{.action} button.
214214

215215
![OVHcloud federation login](images/ovhcloud_federation_login_1.png){.thumbnail}
216216

217-
You are then redirected to your ADFS login page. Enter a login/password of a user of your LDAP Active Directory, then click the `Sign in`{.action} button.
217+
You are then redirected to your AD FS login page. Enter a login/password of a user of your LDAP Active Directory, then click the `Sign in`{.action} button.
218218

219219
![OVHcloud federation login ADFS redirection](images/ovhcloud_federation_login_2.png){.thumbnail}
220220

221-
You are now logged in with the same NIC handle, but via your Active Directory user and using your ADFS SSO.
221+
You are now logged in with the same NIC handle, but via your Active Directory user and using your AD FS SSO.
222222

223223
![OVHcloud user infos federation](images/ovhcloud_user_infos_federation.png){.thumbnail}
224224

0 commit comments

Comments
 (0)