Move SSO and environments
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: SAML 2.0 with Microsoft Entra ID
|
||||
title: Set up SSO with SAML 2.0 and Microsoft Entra ID
|
||||
description: 'Configure Microsoft Entra ID SSO with SAML 2.0 for your Unleash instance.'
|
||||
---
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: OpenID Connect
|
||||
title: Set up SSO with OpenID Connect
|
||||
description: Set up SSO for Unleash with OpenID Connect.
|
||||
---
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: SAML 2.0 with Keycloak
|
||||
title: Set up SSO with SAML 2.0 and Keycloak
|
||||
description: Set up SSO for Unleash with SAML 2.0 and Keycloak.
|
||||
---
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: SAML 2.0 with Okta
|
||||
title: Set up SSO with SAML 2.0 and Okta
|
||||
description: Set up SSO for Unleash with SAML 2.0 and Okta.
|
||||
---
|
||||
|
||||
|
@ -1,81 +0,0 @@
|
||||
---
|
||||
title: How to create and manage user groups
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
||||
**Plan**: [Enterprise](https://www.getunleash.io/pricing) | **Version**: `4.14+`
|
||||
|
||||
:::
|
||||
|
||||
This guide takes you through how to use user groups to manage permissions on your projects. User groups allow you to manage large groups of users more easily than assigning roles directly to those users. Refer to the section on [user groups](../reference/rbac.md#user-groups) in the RBAC documentation for more information.
|
||||
|
||||
## Creating user groups
|
||||
|
||||
1. Navigate to groups by using the admin menu (the gear icon) and selecting the groups option.
|
||||
|
||||

|
||||
|
||||
2. Navigate to new group.
|
||||
|
||||

|
||||
|
||||
3. Give the group a name, an optional description, an optional root role, and select the users you'd like to be in the group.
|
||||
|
||||

|
||||
|
||||
4. Review the details of the group and save them if you're happy.
|
||||
|
||||

|
||||
|
||||
## Managing users within a group
|
||||
|
||||
1. Navigate to groups by using the admin menu (the gear icon) and selecting the groups option.
|
||||
|
||||

|
||||
|
||||
2. Select the card of the group you want to edit.
|
||||
|
||||

|
||||
|
||||
3. Remove users by using the remove user button (displayed as a bin).
|
||||
|
||||

|
||||
|
||||
4. Confirm the remove.
|
||||
|
||||

|
||||
|
||||
5. Add users by selecting the add button.
|
||||
|
||||

|
||||
|
||||
6. Find the user you'd like to add to the group and select them.
|
||||
|
||||

|
||||
|
||||
7. Review the group users and save when you're happy.
|
||||
|
||||

|
||||
|
||||
## Assigning groups to projects
|
||||
|
||||
1. Navigate to projects
|
||||
|
||||

|
||||
|
||||
2. Select the project you want to manage.
|
||||
|
||||

|
||||
|
||||
3. Navigate to the access tab and then use the assign user/group button.
|
||||
|
||||

|
||||
|
||||
4. Find your group in the drop down.
|
||||
|
||||

|
||||
|
||||
5. Select the role that the group should have in this project. You can review the list of permissions that the group users will gain by having this role before confirming.
|
||||
|
||||

|
@ -136,7 +136,7 @@ If change requests are enabled, any permissions for **Create activation strategi
|
||||
|
||||
## Environment import/export vs the instance import/export API
|
||||
|
||||
Environment import/export has some similarities to the [instance import/export API](./how-to-import-export), but they serve different purposes.
|
||||
Environment import/export has some similarities to the [instance import/export API](/reference/environment-import-export), but they serve different purposes.
|
||||
|
||||
The instance import/export API was designed to export all feature flags (optionally with strategies and projects) from one Unleash instance to another. When it was developed, Unleash had much fewer features than it does now. As such, the API lacks support for some of the more recent features in Unleash.
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: How to Set Up User Group SSO Syncing
|
||||
title: Set up user group SSO syncing
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: How to Setup Entra Provisioning
|
||||
title: Set up Entra provisioning
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: How to Setup Okta Provisioning
|
||||
title: Set up Okta provisioning
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: 'How to set up Keycloak and Unleash to sync user groups'
|
||||
title: 'Set up user group syncing with Keycloack'
|
||||
---
|
||||
|
||||
:::note Availability
|
||||
|
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: 'Import & Export'
|
||||
title: 'Import and Export'
|
||||
---
|
||||
import ApiRequest from '@site/src/components/ApiRequest'
|
||||
|
@ -304,29 +304,24 @@ To view a user’s permissions, go to **Admin > Users**. Select a user and click
|
||||
|
||||
:::
|
||||
|
||||
User groups allow you to assign roles to a group of users within a project, rather than to a user directly. This allows
|
||||
you to manage your user permissions more easily when there's lots of users in the system. For a guide on how to create
|
||||
and manage user groups see [_how to create and manage user groups_](../how-to/how-to-create-and-manage-user-groups.md).
|
||||
User groups allow you to manage user permissions efficiently by assigning roles to a collection of users instead of individually. This is particularly useful for projects with many users.
|
||||
|
||||
A user group consists of the following:
|
||||
You can create and manage user groups in the Admin UI at **Admin settings > User config > Groups**.
|
||||
|
||||
- a **name** (required)
|
||||
- a **description** (optional)
|
||||
- a **list of users** (required)
|
||||
- a list of SSO groups to sync from (optional)
|
||||
- a root role associated with the group (optional; available in v5.1+)
|
||||
When creating a user group, you can define the following:
|
||||
|
||||
Groups do nothing on their own. They must either be given a root role directly or a role on a project to assign
|
||||
permissions.
|
||||
- **Name**: A unique identifier for the group.
|
||||
- **Description**: A brief explanation of the group's purpose.
|
||||
- **Users**: A list of users who are members of this group.
|
||||
- **SSO groups** to sync from: A list of single sign-on (SSO) groups to synchronize members from.
|
||||
- **Root role**: A role assigned to the group at the root level. (Available in v5.1+)
|
||||
|
||||
Groups that do not have a root role need to be assigned a role on a project to be useful. You can assign both predefined
|
||||
roles and custom project roles to groups.
|
||||
Groups themselves do not grant permissions. To be functional, a group must either:
|
||||
- Be assigned a root role. Members of this group will inherit the root role's permissions globally.
|
||||
- Be assigned a role on a specific project. This grants the group's members the specified permissions within that project. You can assign both predefined and custom project roles to groups.
|
||||
|
||||
Any user that is a member of a group with a root role will inherit that root role's permissions on the root level.
|
||||
|
||||
While a user can only have one role in a given project, a user may belong to multiple groups, and each of those groups
|
||||
may be given a role on a project. In the case where a given user is given permissions through more than one group, the
|
||||
user will inherit the most permissive permissions of all their groups in that project.
|
||||
A user can belong to multiple groups, and each group a user belongs to can have a different role assigned to it on a specific project.
|
||||
If a user gains permissions for a project through multiple groups, they will inherit the most permissive set of permissions from all their assigned group roles for that project.
|
||||
|
||||
## User group SSO integration
|
||||
|
||||
|
@ -821,13 +821,6 @@ class="header-github-link"
|
||||
from: '/how-to/how-to-troubleshoot-https',
|
||||
to: '/using-unleash/troubleshooting/https',
|
||||
},
|
||||
{
|
||||
from: [
|
||||
'/reference/deploy/import-export',
|
||||
'/deploy/import_export',
|
||||
],
|
||||
to: '/how-to/how-to-import-export',
|
||||
},
|
||||
{
|
||||
from: [
|
||||
'/reference/deploy/environment-import-export',
|
||||
|
@ -354,6 +354,7 @@ const sidebars: SidebarsConfig = {
|
||||
'reference/projects',
|
||||
'reference/project-collaboration-mode',
|
||||
'reference/environments',
|
||||
'reference/environment-import-export',
|
||||
],
|
||||
},
|
||||
{
|
||||
@ -584,6 +585,7 @@ const sidebars: SidebarsConfig = {
|
||||
'how-to/how-to-add-sso-saml-keycloak',
|
||||
'how-to/how-to-add-sso-azure-saml',
|
||||
'how-to/how-to-setup-sso-keycloak-group-sync',
|
||||
'how-to/how-to-set-up-group-sso-sync',
|
||||
],
|
||||
type: 'category',
|
||||
link: {
|
||||
@ -686,32 +688,6 @@ const sidebars: SidebarsConfig = {
|
||||
'how-to/how-to-synchronize-unleash-instances',
|
||||
],
|
||||
},
|
||||
{
|
||||
label: 'Environments',
|
||||
type: 'category',
|
||||
link: {
|
||||
type: 'generated-index',
|
||||
title: 'How-to: environments',
|
||||
description: 'Environments how-to guides.',
|
||||
slug: '/how-to/env',
|
||||
},
|
||||
items: ['how-to/how-to-environment-import-export'],
|
||||
},
|
||||
{
|
||||
label: 'Users and permissions',
|
||||
items: [
|
||||
'how-to/how-to-create-and-manage-user-groups',
|
||||
'how-to/how-to-set-up-group-sso-sync',
|
||||
],
|
||||
type: 'category',
|
||||
link: {
|
||||
type: 'generated-index',
|
||||
title: 'How-to: users and permissions',
|
||||
description:
|
||||
'Users and permission how-to guides.',
|
||||
slug: '/how-to/users-and-permissions',
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
|
Before Width: | Height: | Size: 37 KiB |
Before Width: | Height: | Size: 28 KiB |
Before Width: | Height: | Size: 41 KiB |
Before Width: | Height: | Size: 96 KiB |
Before Width: | Height: | Size: 135 KiB |
Before Width: | Height: | Size: 40 KiB |
Before Width: | Height: | Size: 102 KiB |
Before Width: | Height: | Size: 102 KiB |
Before Width: | Height: | Size: 44 KiB |
Before Width: | Height: | Size: 51 KiB |
Before Width: | Height: | Size: 106 KiB |
Before Width: | Height: | Size: 97 KiB |
Before Width: | Height: | Size: 47 KiB |
Before Width: | Height: | Size: 62 KiB |
@ -136,6 +136,26 @@
|
||||
"destination": "/reference/rbac",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-import-export",
|
||||
"destination": "/reference/environment-import-export",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/users-and-permissions",
|
||||
"destination": "/reference/rbac",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/env",
|
||||
"destination": "/reference/environments",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-create-and-manage-user-groups",
|
||||
"destination": "/reference/rbac#user-groups",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/how-to/how-to-clone-environments",
|
||||
"destination": "/reference/environments#clone-an-environment",
|
||||
@ -1018,12 +1038,12 @@
|
||||
},
|
||||
{
|
||||
"source": "/reference/deploy/import-export",
|
||||
"destination": "/how-to/how-to-import-export",
|
||||
"destination": "/reference/environment-import-export",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
"source": "/deploy/import_export",
|
||||
"destination": "/how-to/how-to-import-export",
|
||||
"destination": "/reference/environment-import-export",
|
||||
"permanent": true
|
||||
},
|
||||
{
|
||||
|