These docs are for Cribl Stream 4.12 and are no longer actively maintained.
See the latest version (4.13).
Configuring SSO Groups
When creating an SSO integration with a Cribl.Cloud Organization, configure user groups in your identity provider (IDP) to manage Teams and Members. This enables you to map IDP groups to specific Permissions on all levels.
Link IDP Groups with Teams
You can use Teams to automatically connect groups of Members with IDP users. This enables you to grant IDP users Workspace- and Product-level Permissions.
For each Team, you can list one or more IDP group names in the Mapping IDs field. This will automatically grant IDP users in those groups access to that Team’s Permissions.
To create a Team with an external ID, refer to Create a Team. To add an external ID to an existing Team:
- On the top bar, select Products, and then select Cribl.
- In the sidebar, select Organization, then Members & Teams, and then Teams.
- Select the Team you want to configure.
- In Mapping IDs, provide a list of IDP group names for the Team.
- Confirm with Save.
Users added to a Team through Mapping IDs will not be listed in the Team Members table. Use your IDP to view the list of Users and manage them.
IDP Group Names and Automatic Permission Mapping
If you are not using Teams, IDP group names must include one of the following core patterns:
Cribl
+ a Role nameCribl
+Organization
or a product name + a Role name
The core pattern must be a contiguous string, with or without spaces. Cribl’s Permission mapping logic ignores prefixes and suffixes before or after the core pattern in IDP group names.
For example, these are valid IDP group names for Cribl’s mapping logic:
CriblOwner
Cribl Owner
CriblOrganizationUser
Cribl Search Admin
dev-CriblOwner
Cribl Stream User_Test
These are examples of invalid IDP group names for Cribl’s mapping logic:
- ❌
Cribl-Owner
- ❌
Cribl - Admin
- ❌
Cribl_Organization_User
- ❌
dev-Cribl-Owner
- ❌
Cribl Lake_Editor_Test
Permission Mapping Logic
If you are not using Teams, Cribl’s Permission mapping logic uses the core patterns to automatically map IDP groups to Cribl Permissions as follows:
- IDP group names that include
Organization
map to Organization-level Permissions. - IDP group names that do not include
Organization
or a product name map to Organization-level Permissions. - IDP group names that include a product name map to the corresponding Product-level Permissions.
Even though Cribl maps IDP group names that do not include
Organization
or a product name to Organization-level permissions, we recommend addingOrganization
to such names for clarity.
The following table demonstrates which Permissions Cribl maps to example IDP group names.
Cribl.Cloud Permission | Example IDP Group Names |
---|---|
Owner | Cribl Organization Owner or CriblOrganizationOwner or Cribl Owner |
Admin | Cribl Organization Admin or CriblOrganizationAdmin or Cribl Admin |
User | Cribl Organization User or CriblOrganizationUser or Cribl User |
Editor | (Deprecated; mapped to Admin) Cribl Organization Editor or CriblOrganizationEditor |
Read Only | (Deprecated; mapped to User) Cribl Organization Read Only or CriblOrganizationReadOnly |
For a more complete list of IDP group names that map to specific Organization- and Product-level Permissions, navigate to Organization > SSO Management in Cribl.Cloud.
Default Product Permissions and Inheritance
When you map external users to your Cribl Organization, their initial product-level Permissions follow a different inheritance pattern than Members configured within Cribl. This is to avoid downgrading product-level Permissions that Organization-level User
s might already have.
The defaults for mapped users are:
- Organization
Owner
orAdmin
inheritsAdmin
Permission on all products. - Organization
User
inheritsUser
Permission on all products (except Cribl Lake, which inheritsNo Access
). - Organization
Editor
(deprecated) inheritededitor
legacy Roles on all products. - Organization
Read Only
(deprecated) inheritedRead Only
Permission on Cribl Stream and Cribl Edge, andUser
Permission on Cribl Search.
Better Practices for Group Naming and Configuration
Follow these guidelines for IDP group naming and configuration:
- Use unique names for each group to prevent unintended Permission overlaps. Do not reuse or alias group names.
- Carefully audit and validate group names and mappings. To prevent misconfiguration, make sure to provide the group names verbatim in Mappings IDs.
- Verify your group mappings in a staging environment to prevent pushing misconfigurations to production.
- Set up fallback access before you configure SSO. Define default mappings for IDP users who may not match any Teams you define. This minimizes the risk of orphaned users.
- A Cribl.Cloud Organization’s Owner Role can be shared and transferred among multiple users. This facilitates gradual ownership transfers, corporate reorganizations, and other scenarios. These multiple users should be in both the Owner and Admin groups in your IDP so that they can acquire all needed permissions across Cribl’s two corresponding Roles.
- Aside from dual-assigning the Owners, you should assign every other user only one group in your IDP. Cribl’s Admin and Editor Roles include all the permissions of the Roles below them.
Here’s an example of how groups configuration (at an early stage) might look in Okta’s UI:
