1. Packages
  2. Artifactory Provider
  3. API Docs
  4. Group
artifactory v8.8.0 published on Friday, Mar 7, 2025 by Pulumi

artifactory.Group

Explore with Pulumi AI

Import

$ pulumi import artifactory:index/group:Group terraform-group mygroup
Copy

~> users_names can’t be imported due to API limitations.

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,
          detach_all_users: Optional[bool] = None,
          external_id: Optional[str] = None,
          name: Optional[str] = None,
          policy_manager: Optional[bool] = None,
          realm: Optional[str] = None,
          realm_attributes: Optional[str] = None,
          reports_manager: Optional[bool] = None,
          users_names: Optional[Sequence[str]] = None,
          watch_manager: 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: artifactory: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 Artifactory.Group("groupResource", new()
{
    AdminPrivileges = false,
    AutoJoin = false,
    Description = "string",
    DetachAllUsers = false,
    ExternalId = "string",
    Name = "string",
    PolicyManager = false,
    Realm = "string",
    RealmAttributes = "string",
    ReportsManager = false,
    UsersNames = new[]
    {
        "string",
    },
    WatchManager = false,
});
Copy
example, err := artifactory.NewGroup(ctx, "groupResource", &artifactory.GroupArgs{
	AdminPrivileges: pulumi.Bool(false),
	AutoJoin:        pulumi.Bool(false),
	Description:     pulumi.String("string"),
	DetachAllUsers:  pulumi.Bool(false),
	ExternalId:      pulumi.String("string"),
	Name:            pulumi.String("string"),
	PolicyManager:   pulumi.Bool(false),
	Realm:           pulumi.String("string"),
	RealmAttributes: pulumi.String("string"),
	ReportsManager:  pulumi.Bool(false),
	UsersNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	WatchManager: pulumi.Bool(false),
})
Copy
var groupResource = new Group("groupResource", GroupArgs.builder()
    .adminPrivileges(false)
    .autoJoin(false)
    .description("string")
    .detachAllUsers(false)
    .externalId("string")
    .name("string")
    .policyManager(false)
    .realm("string")
    .realmAttributes("string")
    .reportsManager(false)
    .usersNames("string")
    .watchManager(false)
    .build());
Copy
group_resource = artifactory.Group("groupResource",
    admin_privileges=False,
    auto_join=False,
    description="string",
    detach_all_users=False,
    external_id="string",
    name="string",
    policy_manager=False,
    realm="string",
    realm_attributes="string",
    reports_manager=False,
    users_names=["string"],
    watch_manager=False)
Copy
const groupResource = new artifactory.Group("groupResource", {
    adminPrivileges: false,
    autoJoin: false,
    description: "string",
    detachAllUsers: false,
    externalId: "string",
    name: "string",
    policyManager: false,
    realm: "string",
    realmAttributes: "string",
    reportsManager: false,
    usersNames: ["string"],
    watchManager: false,
});
Copy
type: artifactory:Group
properties:
    adminPrivileges: false
    autoJoin: false
    description: string
    detachAllUsers: false
    externalId: string
    name: string
    policyManager: false
    realm: string
    realmAttributes: string
    reportsManager: false
    usersNames:
        - string
    watchManager: 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.
DetachAllUsers bool
When this is set to true, an empty or missing usernames array will detach all users from the group.
ExternalId string
New external group ID used to configure the corresponding group in Azure AD.
Name string
Name of the group.
PolicyManager bool
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
Realm string
The realm for the group.
RealmAttributes string
The realm attributes for the group.
ReportsManager bool
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
UsersNames List<string>
WatchManager bool
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
DetachAllUsers bool
When this is set to true, an empty or missing usernames array will detach all users from the group.
ExternalId string
New external group ID used to configure the corresponding group in Azure AD.
Name string
Name of the group.
PolicyManager bool
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
Realm string
The realm for the group.
RealmAttributes string
The realm attributes for the group.
ReportsManager bool
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
UsersNames []string
WatchManager bool
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
detachAllUsers Boolean
When this is set to true, an empty or missing usernames array will detach all users from the group.
externalId String
New external group ID used to configure the corresponding group in Azure AD.
name String
Name of the group.
policyManager Boolean
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
realm String
The realm for the group.
realmAttributes String
The realm attributes for the group.
reportsManager Boolean
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
usersNames List<String>
watchManager Boolean
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
detachAllUsers boolean
When this is set to true, an empty or missing usernames array will detach all users from the group.
externalId string
New external group ID used to configure the corresponding group in Azure AD.
name string
Name of the group.
policyManager boolean
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
realm string
The realm for the group.
realmAttributes string
The realm attributes for the group.
reportsManager boolean
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
usersNames string[]
watchManager boolean
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
detach_all_users bool
When this is set to true, an empty or missing usernames array will detach all users from the group.
external_id str
New external group ID used to configure the corresponding group in Azure AD.
name str
Name of the group.
policy_manager bool
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
realm str
The realm for the group.
realm_attributes str
The realm attributes for the group.
reports_manager bool
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
users_names Sequence[str]
watch_manager bool
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
detachAllUsers Boolean
When this is set to true, an empty or missing usernames array will detach all users from the group.
externalId String
New external group ID used to configure the corresponding group in Azure AD.
name String
Name of the group.
policyManager Boolean
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
realm String
The realm for the group.
realmAttributes String
The realm attributes for the group.
reportsManager Boolean
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
usersNames List<String>
watchManager Boolean
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.

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.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

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,
        detach_all_users: Optional[bool] = None,
        external_id: Optional[str] = None,
        name: Optional[str] = None,
        policy_manager: Optional[bool] = None,
        realm: Optional[str] = None,
        realm_attributes: Optional[str] = None,
        reports_manager: Optional[bool] = None,
        users_names: Optional[Sequence[str]] = None,
        watch_manager: 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: artifactory: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.
DetachAllUsers bool
When this is set to true, an empty or missing usernames array will detach all users from the group.
ExternalId string
New external group ID used to configure the corresponding group in Azure AD.
Name string
Name of the group.
PolicyManager bool
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
Realm string
The realm for the group.
RealmAttributes string
The realm attributes for the group.
ReportsManager bool
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
UsersNames List<string>
WatchManager bool
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
DetachAllUsers bool
When this is set to true, an empty or missing usernames array will detach all users from the group.
ExternalId string
New external group ID used to configure the corresponding group in Azure AD.
Name string
Name of the group.
PolicyManager bool
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
Realm string
The realm for the group.
RealmAttributes string
The realm attributes for the group.
ReportsManager bool
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
UsersNames []string
WatchManager bool
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
detachAllUsers Boolean
When this is set to true, an empty or missing usernames array will detach all users from the group.
externalId String
New external group ID used to configure the corresponding group in Azure AD.
name String
Name of the group.
policyManager Boolean
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
realm String
The realm for the group.
realmAttributes String
The realm attributes for the group.
reportsManager Boolean
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
usersNames List<String>
watchManager Boolean
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
detachAllUsers boolean
When this is set to true, an empty or missing usernames array will detach all users from the group.
externalId string
New external group ID used to configure the corresponding group in Azure AD.
name string
Name of the group.
policyManager boolean
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
realm string
The realm for the group.
realmAttributes string
The realm attributes for the group.
reportsManager boolean
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
usersNames string[]
watchManager boolean
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
detach_all_users bool
When this is set to true, an empty or missing usernames array will detach all users from the group.
external_id str
New external group ID used to configure the corresponding group in Azure AD.
name str
Name of the group.
policy_manager bool
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
realm str
The realm for the group.
realm_attributes str
The realm attributes for the group.
reports_manager bool
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
users_names Sequence[str]
watch_manager bool
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.
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.
detachAllUsers Boolean
When this is set to true, an empty or missing usernames array will detach all users from the group.
externalId String
New external group ID used to configure the corresponding group in Azure AD.
name String
Name of the group.
policyManager Boolean
When this override is set, User in the group can set Xray security and compliance policies. Default value is false.
realm String
The realm for the group.
realmAttributes String
The realm attributes for the group.
reportsManager Boolean
When this override is set, User in the group can manage Xray Reports on any resource type. Default value is false.
usersNames List<String>
watchManager Boolean
When this override is set, User in the group can manage Xray Watches on any resource type. Default value is false.

Package Details

Repository
artifactory pulumi/pulumi-artifactory
License
Apache-2.0
Notes
This Pulumi package is based on the artifactory Terraform Provider.