Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Platform Provider
  3. API Docs
  4. Group
platform 2.2.2 published on Thursday, Apr 3, 2025 by jfrog
jfrog/terraform-provider-platform

platform.Group

Explore with Pulumi AI

platform 2.2.2 published on Thursday, Apr 3, 2025 by jfrog
jfrog/terraform-provider-platform

Provides a group resource to create and manage groups, and manages membership. A group represents a role and is used with RBAC (Role-Based Access Control) rules. See JFrog documentation for more details.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as platform from "@pulumi/platform";

const my_group = new platform.Group("my-group", {
    adminPrivileges: false,
    autoJoin: true,
    description: "My group",
    externalId: "My Azure ID",
    members: ["admin"],
});
Copy
import pulumi
import pulumi_platform as platform

my_group = platform.Group("my-group",
    admin_privileges=False,
    auto_join=True,
    description="My group",
    external_id="My Azure ID",
    members=["admin"])
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/platform/v2/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.NewGroup(ctx, "my-group", &platform.GroupArgs{
			AdminPrivileges: pulumi.Bool(false),
			AutoJoin:        pulumi.Bool(true),
			Description:     pulumi.String("My group"),
			ExternalId:      pulumi.String("My Azure ID"),
			Members: pulumi.StringArray{
				pulumi.String("admin"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Platform = Pulumi.Platform;

return await Deployment.RunAsync(() => 
{
    var my_group = new Platform.Group("my-group", new()
    {
        AdminPrivileges = false,
        AutoJoin = true,
        Description = "My group",
        ExternalId = "My Azure ID",
        Members = new[]
        {
            "admin",
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.platform.Group;
import com.pulumi.platform.GroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var my_group = new Group("my-group", GroupArgs.builder()
            .adminPrivileges(false)
            .autoJoin(true)
            .description("My group")
            .externalId("My Azure ID")
            .members("admin")
            .build());

    }
}
Copy
resources:
  my-group:
    type: platform:Group
    properties:
      adminPrivileges: false
      autoJoin: true
      description: My group
      externalId: My Azure ID
      members:
        - admin
Copy

Create Group Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Group(name: string, args?: GroupArgs, opts?: CustomResourceOptions);
@overload
def Group(resource_name: str,
          args: Optional[GroupArgs] = None,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          admin_privileges: Optional[bool] = None,
          auto_join: Optional[bool] = None,
          description: Optional[str] = None,
          external_id: Optional[str] = None,
          members: Optional[Sequence[str]] = None,
          name: Optional[str] = None,
          use_group_members_resource: Optional[bool] = None)
func NewGroup(ctx *Context, name string, args *GroupArgs, opts ...ResourceOption) (*Group, error)
public Group(string name, GroupArgs? args = null, CustomResourceOptions? opts = null)
public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

type: platform:Group
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args GroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var groupResource = new Platform.Group("groupResource", new()
{
    AdminPrivileges = false,
    AutoJoin = false,
    Description = "string",
    ExternalId = "string",
    Name = "string",
    UseGroupMembersResource = false,
});
Copy
example, err := platform.NewGroup(ctx, "groupResource", &platform.GroupArgs{
AdminPrivileges: pulumi.Bool(false),
AutoJoin: pulumi.Bool(false),
Description: pulumi.String("string"),
ExternalId: pulumi.String("string"),
Name: pulumi.String("string"),
UseGroupMembersResource: pulumi.Bool(false),
})
Copy
var groupResource = new Group("groupResource", GroupArgs.builder()
    .adminPrivileges(false)
    .autoJoin(false)
    .description("string")
    .externalId("string")
    .name("string")
    .useGroupMembersResource(false)
    .build());
Copy
group_resource = platform.Group("groupResource",
    admin_privileges=False,
    auto_join=False,
    description="string",
    external_id="string",
    name="string",
    use_group_members_resource=False)
Copy
const groupResource = new platform.Group("groupResource", {
    adminPrivileges: false,
    autoJoin: false,
    description: "string",
    externalId: "string",
    name: "string",
    useGroupMembersResource: false,
});
Copy
type: platform:Group
properties:
    adminPrivileges: false
    autoJoin: false
    description: string
    externalId: string
    name: string
    useGroupMembersResource: false
Copy

Group Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Group resource accepts the following input properties:

AdminPrivileges bool
Any users added to this group will automatically be assigned with admin privileges in the system.
AutoJoin bool
When this parameter is set, any new users defined in the system are automatically assigned to this group.
Description string
A description for the group.
ExternalId string
New external group ID used to configure the corresponding group in Azure AD.
Members List<string>
List of users assigned to the group.

Deprecated: Deprecated

Name string
Name of the group.
UseGroupMembersResource bool
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
AdminPrivileges bool
Any users added to this group will automatically be assigned with admin privileges in the system.
AutoJoin bool
When this parameter is set, any new users defined in the system are automatically assigned to this group.
Description string
A description for the group.
ExternalId string
New external group ID used to configure the corresponding group in Azure AD.
Members []string
List of users assigned to the group.

Deprecated: Deprecated

Name string
Name of the group.
UseGroupMembersResource bool
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
adminPrivileges Boolean
Any users added to this group will automatically be assigned with admin privileges in the system.
autoJoin Boolean
When this parameter is set, any new users defined in the system are automatically assigned to this group.
description String
A description for the group.
externalId String
New external group ID used to configure the corresponding group in Azure AD.
members List<String>
List of users assigned to the group.

Deprecated: Deprecated

name String
Name of the group.
useGroupMembersResource Boolean
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
adminPrivileges boolean
Any users added to this group will automatically be assigned with admin privileges in the system.
autoJoin boolean
When this parameter is set, any new users defined in the system are automatically assigned to this group.
description string
A description for the group.
externalId string
New external group ID used to configure the corresponding group in Azure AD.
members string[]
List of users assigned to the group.

Deprecated: Deprecated

name string
Name of the group.
useGroupMembersResource boolean
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
admin_privileges bool
Any users added to this group will automatically be assigned with admin privileges in the system.
auto_join bool
When this parameter is set, any new users defined in the system are automatically assigned to this group.
description str
A description for the group.
external_id str
New external group ID used to configure the corresponding group in Azure AD.
members Sequence[str]
List of users assigned to the group.

Deprecated: Deprecated

name str
Name of the group.
use_group_members_resource bool
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
adminPrivileges Boolean
Any users added to this group will automatically be assigned with admin privileges in the system.
autoJoin Boolean
When this parameter is set, any new users defined in the system are automatically assigned to this group.
description String
A description for the group.
externalId String
New external group ID used to configure the corresponding group in Azure AD.
members List<String>
List of users assigned to the group.

Deprecated: Deprecated

name String
Name of the group.
useGroupMembersResource Boolean
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.

Outputs

All input properties are implicitly available as output properties. Additionally, the Group resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Realm string
The realm for the group.
RealmAttributes string
The realm for the group.
Id string
The provider-assigned unique ID for this managed resource.
Realm string
The realm for the group.
RealmAttributes string
The realm for the group.
id String
The provider-assigned unique ID for this managed resource.
realm String
The realm for the group.
realmAttributes String
The realm for the group.
id string
The provider-assigned unique ID for this managed resource.
realm string
The realm for the group.
realmAttributes string
The realm for the group.
id str
The provider-assigned unique ID for this managed resource.
realm str
The realm for the group.
realm_attributes str
The realm for the group.
id String
The provider-assigned unique ID for this managed resource.
realm String
The realm for the group.
realmAttributes String
The realm for the group.

Look up Existing Group Resource

Get an existing Group resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GroupState, opts?: CustomResourceOptions): Group
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin_privileges: Optional[bool] = None,
        auto_join: Optional[bool] = None,
        description: Optional[str] = None,
        external_id: Optional[str] = None,
        members: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        realm: Optional[str] = None,
        realm_attributes: Optional[str] = None,
        use_group_members_resource: Optional[bool] = None) -> Group
func GetGroup(ctx *Context, name string, id IDInput, state *GroupState, opts ...ResourceOption) (*Group, error)
public static Group Get(string name, Input<string> id, GroupState? state, CustomResourceOptions? opts = null)
public static Group get(String name, Output<String> id, GroupState state, CustomResourceOptions options)
resources:  _:    type: platform:Group    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AdminPrivileges bool
Any users added to this group will automatically be assigned with admin privileges in the system.
AutoJoin bool
When this parameter is set, any new users defined in the system are automatically assigned to this group.
Description string
A description for the group.
ExternalId string
New external group ID used to configure the corresponding group in Azure AD.
Members List<string>
List of users assigned to the group.

Deprecated: Deprecated

Name string
Name of the group.
Realm string
The realm for the group.
RealmAttributes string
The realm for the group.
UseGroupMembersResource bool
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
AdminPrivileges bool
Any users added to this group will automatically be assigned with admin privileges in the system.
AutoJoin bool
When this parameter is set, any new users defined in the system are automatically assigned to this group.
Description string
A description for the group.
ExternalId string
New external group ID used to configure the corresponding group in Azure AD.
Members []string
List of users assigned to the group.

Deprecated: Deprecated

Name string
Name of the group.
Realm string
The realm for the group.
RealmAttributes string
The realm for the group.
UseGroupMembersResource bool
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
adminPrivileges Boolean
Any users added to this group will automatically be assigned with admin privileges in the system.
autoJoin Boolean
When this parameter is set, any new users defined in the system are automatically assigned to this group.
description String
A description for the group.
externalId String
New external group ID used to configure the corresponding group in Azure AD.
members List<String>
List of users assigned to the group.

Deprecated: Deprecated

name String
Name of the group.
realm String
The realm for the group.
realmAttributes String
The realm for the group.
useGroupMembersResource Boolean
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
adminPrivileges boolean
Any users added to this group will automatically be assigned with admin privileges in the system.
autoJoin boolean
When this parameter is set, any new users defined in the system are automatically assigned to this group.
description string
A description for the group.
externalId string
New external group ID used to configure the corresponding group in Azure AD.
members string[]
List of users assigned to the group.

Deprecated: Deprecated

name string
Name of the group.
realm string
The realm for the group.
realmAttributes string
The realm for the group.
useGroupMembersResource boolean
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
admin_privileges bool
Any users added to this group will automatically be assigned with admin privileges in the system.
auto_join bool
When this parameter is set, any new users defined in the system are automatically assigned to this group.
description str
A description for the group.
external_id str
New external group ID used to configure the corresponding group in Azure AD.
members Sequence[str]
List of users assigned to the group.

Deprecated: Deprecated

name str
Name of the group.
realm str
The realm for the group.
realm_attributes str
The realm for the group.
use_group_members_resource bool
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.
adminPrivileges Boolean
Any users added to this group will automatically be assigned with admin privileges in the system.
autoJoin Boolean
When this parameter is set, any new users defined in the system are automatically assigned to this group.
description String
A description for the group.
externalId String
New external group ID used to configure the corresponding group in Azure AD.
members List<String>
List of users assigned to the group.

Deprecated: Deprecated

name String
Name of the group.
realm String
The realm for the group.
realmAttributes String
The realm for the group.
useGroupMembersResource Boolean
When set to true, this resource will ignore the members attributes and allow memberships to be managed by platform.GroupMembers resource instead. Default value is true.

Import

$ pulumi import platform:index/group:Group my-group my-group
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
platform jfrog/terraform-provider-platform
License
Notes
This Pulumi package is based on the platform Terraform Provider.
platform 2.2.2 published on Thursday, Apr 3, 2025 by jfrog
jfrog/terraform-provider-platform