-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[docs][ybm] Federated authentication (#19973)
* YBM federated authentication * review comments * review comments * Apply suggestions from code review Co-authored-by: Aishwarya Chakravarthy <[email protected]> * review comment * AAD -> Entra --------- Co-authored-by: Aishwarya Chakravarthy <[email protected]>
- Loading branch information
1 parent
f5228ec
commit c74f258
Showing
5 changed files
with
92 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
78 changes: 78 additions & 0 deletions
78
docs/content/preview/yugabyte-cloud/managed-security/managed-authentication.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,78 @@ | ||
--- | ||
title: Manage account authentication | ||
headertitle: Manage account authentication | ||
linkTitle: Authentication | ||
description: Use social logins and identity providers to manage authentication. | ||
headcontent: Use social logins and identity providers to manage authentication | ||
menu: | ||
preview_yugabyte-cloud: | ||
identifier: managed-authentication | ||
parent: managed-security | ||
weight: 300 | ||
type: docs | ||
rightNav: | ||
hideH4: true | ||
--- | ||
|
||
In addition to email-based accounts, you can use social logins or federated authentication via an external identity provider (IdP) to provide access to your YugabyteDB Managed account. | ||
|
||
The **Authentication** tab displays options for configuring social logins and federated authentication. | ||
|
||
![Authentication page](/images/yb-cloud/managed-authentication.png) | ||
|
||
## Social logins | ||
|
||
The available social logins include Google, GitHub, and LinkedIn. All three are enabled by default. | ||
|
||
To manage the social logins available to your account users, do the following: | ||
|
||
1. Navigate to **Security > Access Control > Authentication**, then click **Edit Configuration** to display the **Login Methods** dialog. | ||
1. Enable the social logins you want to use. | ||
1. Click **Save Changes**. | ||
|
||
If you revoke a social login that is already in use, users using that social login can either [reset their password](../manage-access/#reset-your-password) to configure email-based login, or sign in using a different social login. The social account must be associated with the same email address. | ||
|
||
## Federated authentication | ||
|
||
Using federated authentication, you can use an IdP to manage access to your YugabyteDB Managed account. | ||
|
||
Note that after federated authentication is enabled, only Admin users can sign in using email-based login. | ||
|
||
Currently only the Microsoft Entra ID IdP and the OIDC protocol are supported. | ||
|
||
### Prerequisites | ||
|
||
Before configuring federated authentication, keep in mind the following: | ||
|
||
- Be sure to allow pop-ups from your IdP. While configuring federated authentication, the provider needs to confirm your identity in a new window. | ||
- Use your own Entra account to test the connection. | ||
|
||
#### Register an application | ||
|
||
To use Entra for your IdP, you need to register an application with Microsoft Entra so the Microsoft identity platform can provide authentication and authorization services for your application. Configure the application as follows: | ||
|
||
- Provide a name for the application. | ||
- Set the sign-in audience for the application to **Accounts in any organizational directory** (Multitenant). | ||
|
||
![Azure account types](/images/yb-cloud/managed-authentication-azure-account-types.png) | ||
|
||
- Set the Redirect URI platform to Web, and the URI to `https://yugabyte-cloud.okta.com/oauth2/v1/authorize/callback`. | ||
|
||
For more information, refer to [Register an application with the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app) in the Microsoft documentation. | ||
|
||
In addition, to configure Entra federated authentication in YugabyteDB Managed, you need the following: | ||
|
||
- Client ID of the application you registered. | ||
- Client secret of the application. | ||
|
||
Refer to [Create a new client secret](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#option-3-create-a-new-client-secret) in the Microsoft documentation. | ||
|
||
### Configure | ||
|
||
To configure federated authentication, do the following: | ||
|
||
1. Navigate to **Security > Access Control > Authentication**, then click **Enable Federated Authentication** to display the **Enable Federated Authentication** dialog. | ||
1. Enter your Entra application client ID and secret. | ||
1. Click **Enable**. | ||
|
||
You are redirected to sign in to your IdP to test the connection. Once test connection is successful, federated authentication is enabled. |
Binary file added
BIN
+95.4 KB
docs/static/images/yb-cloud/managed-authentication-azure-account-types.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.