Manage groups

In the Platform Settings section of the sidebar, select Groups. Choose a group to view its details in a dashboard view.

Manage groups

You can view a variety of information about the selected group:

  • Group name: We recommend not changing group names, though users with Manage permissions are able to do so (see Renaming a group below).
  • Group description: Describes the group and is visible to all users in the Organizations that can discover the group.
  • Group ID: The permanent, unique ID of the group.
  • Group type: The type of group: external, internal, or rule based. Internal realm group membership is managed in Foundry.
  • Realm: The authentication source, external or internal. For external groups, the realm identifies the provider that manages the group.
  • Organizations: Defines the members of Organizations who can see this group and its description.
  • Members: Users who are members of this group. These can be individual users or groups.
  • Group permissions: Defines users with permissions to manage aspects of the group. There are two types of administrative permissions:
    • Manage permissions: Users who can grant permissions to manage aspects of the group, manage its members, and edit its metadata.
    • Manage membership: Users who can manage the group’s members, including membership expiration properties.
  • Attributes: Information about a group stored in a key-value format that is typically used by other Foundry services.

Discovering a group lets you open its page, but you need additional permissions to view its members. For details, refer to group visibility and permissions.

Embed group details

You can embed a group's page from Platform Settings in a Workshop module using the Iframe widget and configure its appearance through the query parameters described below.

Workshop viewers must be able to discover the group and view its membership. For details, refer to group visibility and permissions.

ParameterEffectScope
embedded=trueHides the Foundry sidebar.All Foundry applications
hideSettingsMenu=trueHides the settings navigation menu.Platform Settings
hideGroupHeader=trueHides the Manage groups header, including navigation, search, and group creation.Group page
sectionSelects which section opens when the page loads: members, attributes, contact-details, organizations, permissions, or membership-approval.Group page

For example, this URL opens the Members section with navigation controls hidden:

Copied!
1 https://<FOUNDRY_URL>/workspace/settings/groups/<group-id>?embedded=true&hideSettingsMenu=true&hideGroupHeader=true&section=members

On the group's Details tab, select Manage or View on a section to open it, then select the link icon (Copy embed link) beside the section heading to copy its embed URL.

The group's Details tab shows the Copy embed link button beside the Members section heading.

Group visibility and permissions

To open a group's page, you must be able to discover the group. You can discover a group if any of the following is true:

  • Organization visibility: Your organization is selected under Organizations > Visibility on the group's Details tab, and you have permission to discover groups in that organization. You have this permission if your organization's Discover groups setting is enabled, or if you have a Control Panel role that includes the Create and manage groups in the organization workflow, such as Organization administrator or Users and groups administrator.
  • Cross-organization collaboration: A cross-organization collaboration between your organization and one of the group's organizations allows group discovery.
  • Guest access: You have guest access to one of the group's organizations, and that organization's Discover groups setting allows you to discover the group.

To view a group's members, you also need one of the following:

  • Organization permissions: A role that includes the View membership for groups in the organization workflow on one of the group's organizations. The Organization administrator, Organization settings viewer, and Users and groups administrator roles include this workflow by default. Organization settings viewer does not grant group discovery, so users with only this role must also be able to discover the group through one of the options above. Manage these roles in Control Panel > Organization permissions.
  • Group permissions: For groups managed in Foundry, the Manage membership or Manage permissions permission on the group also allows you to view its members. For groups synced from an identity provider, you must have the organization-level permission.

The member list only includes users and groups you can discover. If members belong to another organization, you must also be able to discover those users or groups. Cross-organization collaboration or guest access can provide this visibility.

Group members receive permissions granted to the group even if they cannot discover the group. For example, members still receive project roles granted to the group.

Membership expiration

If you can Manage membership on a given group, you can mandate that new memberships to the group are temporary. Do this by configuring the following group properties:

  • Latest expiration: All new memberships must have an expiration date that is earlier than this date.
  • Maximum duration: All new memberships must expire within the specified duration.

Either or both of these properties can be simultaneously set. When both are set, the latest allowed expiration will be the most constraining property of the two.

Additionally, if you have Manage membership permissions, you can add temporary members to the group that are set with a membership expiration date property. You can add these temporary members to groups that do not have a set Latest expiration or Maximum duration property.

Any access requests resulting in membership requests for groups that have either Latest expiration or Maximum duration properties will be bounded by a maximum expiration.

Membership expiration notifications

When a temporary group membership expires, a revocation notification is sent to affected users. Additionally, users with temporary membership will receive a reminder notification seven days before their membership expires. However, if a user is added to a group with an expiration set for less than seven days, they will not receive a reminder notification.

If users do not wish to receive these notifications, they can configure platform notification settings in Account > Settings > Notifications from the platform sidebar.

Custom Approvals access request form

If you can manage permissions for a group that has a defined role on a Project, then you can configure custom access request forms for that Project by adding an attribute to the group using the following structure:

  • Attribute key: access-request:'group-category-name'
  • Attribute value: 'intended group value'

These attributes appear automatically as part of the Request access pop-up window once you add them to the group's Attributes, where a user can select them as part of their access request form.

For example, adding the following group attributes results in the below custom request flow:

  • Key: access-request: Team
  • Value: blue

Example of custom access request flow resulting from group attribute setting

Custom access request forms are particularly useful for Projects with multiple groups, as they provide a streamlined and intuitive access request process to improve the administrator and user experience.

Exclude groups from access request form

By default, all groups with a role in a Project appear in the access request form. If you want to hide certain groups, you can exclude them in the Project settings.

To configure which groups should be excluded from the access request flow for a Project, navigate to the Access panel > Settings > Project access request.

Navigating to excluded groups

If you are an Owner on a Project, select the Manage button, then choose the groups to hide from the request flow. If you are not an Owner on the Project, you will see a View button that allows you to see which groups are excluded, but you will not be able to make any changes.

Select groups to excluded groups from access request flow

Excluding groups is a per-Project setting, offering flexibility. A group can be excluded from most Projects but included in specific ones. Users can request access to the group in those specific Projects. If approved, they will gain access to all Projects where the group has a role.

This feature helps prevent accidental membership requests to groups like admin groups while still allowing necessary access through designated Projects.

Custom Approvals access request policies [Beta]

Beta

Custom policies are in the beta phase of development and may not be available on your enrollment. Functionality may change during active development. Contact Palantir Support to request access to this feature.

Users with Manage membership or Manage Permissions permissions on the group can configure custom policies that will be applied to any access requests that result in membership requests for the select group. That can be configured through the Membership Approval section as shown below:

Manage group Approvals policy

If a group has custom policies configured, then any access request that results in a request to that group will be affected. The custom policy will apply to the Group membership subtask to add members to the specific group. For an access request to be approved, all subtasks must be approved. Approval policies are communicated both when requesting access and when reviewing existing access requests.

Custom policy Approvals access request

Project access

Select Project access next to the Details tab to view Project access details for the selected group.

Group Project access

The Project access view allows a group administrator to see all the Projects that a group has access to and the specific Project roles granted to the group. This view is especially helpful when deciding to add or remove users from a group because you can see how access will change.

The Show inherited permissions toggle is on by default and will traverse all nested groups to find what Projects the group has access to. If you turn this toggle off, then the list will only show Projects where the group was directly applied.

Project access tab

Rename a group

Users with Manage membership permissions can rename groups. When a user renames a group, some actions occur automatically:

  • The current group will be renamed, and the group ID will remain the same.
  • A new group with the original name will be created to support applications that may depend on the original group name.
  • The original group will be made a member of the new, renamed group.

Set contact details

You can specify contact details for a group to serve as the point of contact. Users in the manage permissions group can manage permissions. Users can define whether the group should be contacted through Foundry Issues or by a given email.

Set contact details for a group

Setting contact details for a group can be useful if you want to set a group as a Project point of contact in the Project resource sidebar. The Project point of contact can be set by Project owners by selecting Add under the Project point of contact section in the Project overview.

Set contact details for a Project

Apply group permissions

Access the Group Permissions view from the Group details dashboard. Users with Manage permissions can use this section to grant access permissions to groups rather than individual users to make permissions more transparent and auditable.

Granting group permissions is particularly useful when assigning permissions for Projects, since administrators can see what Projects a group has access to via the Project access tab mentioned above. We recommend a Project setup with at least three groups, one for each default role: Viewer, Editor, and Owner. You should set the Project default role to Discoverer.

Group Project roles

Restricted View group name policies

When creating a Restricted View that uses a Group name as one of the policy terms, you need to specify the realm of the group so it can match the group name accordingly. You can check the group realm in the Platform Settings > Groups interface and change the realm name at the bottom of the Restricted View rule editor.

Restricted view groups

Realms

User realms

Administrators typically set up external realm providers (such as SSO, SAML realm, or ADFS) in Control Panel. If necessary, Foundry’s Platform Settings come with an internal implementation of an identity provider. This internal identity provider can be used in a number of scenarios where an external authentication system is not suitable.

Group external realms

External realms are groups directly derived from external systems, such as an identity provider like ADFS. The Platform Settings configuration defines the realms where the identity providers are assigned.

External realms cannot be modified in Foundry and exist in a read-only state. Operations that can only be performed in the external system include renaming, adding users to groups, modifying attributes, and creating new groups. External realm groups are ideal for most authorization and authentication-related functions in Foundry, including: * Assigning discretionary and mandatory controls, and * Enabling binary access to the platform (such as allowing or denying a set of users belonging to a particular group).

Since external realm groups are in a read-only state, users will not be able to request access to join external realm groups in Foundry. However, in Control Panel, you can configure the message a user receives when trying to request access to an external realm group. Navigate to Control Panel > Authentication > Your SSO > SAML > Manage > Attribute mapping > External group management to set a custom message and URL for the external realm. Only users in the same realm as the external realm will see the custom message and URL. Below is an example where an administrator added a message and link to their internal Jira instance.

Create a custom message in Control Panel

After a custom message is configured, you will see this message in Platform Settings when viewing all groups in that external realm.

View custom message in Platform Settings

Users will see the message when they try to request access to a Project that grants a role to this group.

external group request access

Lastly, you can use external realm groups for Organization assignment at login. Often, the information obtained via customer SSO becomes the input for triaging users into different Organizations at login.

All external realm groups must be assigned an Organization. If no Organization is assigned, the group will become visible to all users regardless of their Organization.

Group internal realms

Groups created in Foundry are assigned to the internal realm.

Internal realm groups can be modified within Foundry. Operations that can be performed in the Groups interface include renaming, adding users to groups, modifying attributes, and creating new groups. The internal realm group is ideal for granting access to Foundry-level functionality, including bundling service user accounts into an internal realm group for allow-listing or deny-listing purposes (for example, to exclude service user accounts from user account expiry rules).

If external realm groups are being used, then it is important to avoid directly assigning users to internal realm groups. Instead, external realm group(s) to which users are added/removed should be nested within the internal realm group.