artifactory logo
artifactory v2.11.0, Jan 24 23

artifactory.getGroup

# Artifactory Group Data Source

Provides an Artifactory group datasource. This can be used to read the configuration of groups in artifactory.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Artifactory = Pulumi.Artifactory;

return await Deployment.RunAsync(() => 
{
    var myGroup = Artifactory.GetGroup.Invoke(new()
    {
        IncludeUsers = "true",
        Name = "my_group",
    });

});
package main

import (
	"github.com/pulumi/pulumi-artifactory/sdk/v2/go/artifactory"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := artifactory.LookupGroup(ctx, &artifactory.LookupGroupArgs{
			IncludeUsers: pulumi.StringRef("true"),
			Name:         "my_group",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.artifactory.ArtifactoryFunctions;
import com.pulumi.artifactory.inputs.GetGroupArgs;
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) {
        final var myGroup = ArtifactoryFunctions.getGroup(GetGroupArgs.builder()
            .includeUsers(true)
            .name("my_group")
            .build());

    }
}
import pulumi
import pulumi_artifactory as artifactory

my_group = artifactory.get_group(include_users="true",
    name="my_group")
import * as pulumi from "@pulumi/pulumi";
import * as artifactory from "@pulumi/artifactory";

const myGroup = artifactory.getGroup({
    includeUsers: "true",
    name: "my_group",
});
variables:
  myGroup:
    fn::invoke:
      Function: artifactory:getGroup
      Arguments:
        includeUsers: true
        name: my_group

Using getGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGroup(args: GetGroupArgs, opts?: InvokeOptions): Promise<GetGroupResult>
function getGroupOutput(args: GetGroupOutputArgs, opts?: InvokeOptions): Output<GetGroupResult>
def get_group(admin_privileges: Optional[bool] = None,
              auto_join: Optional[bool] = None,
              description: Optional[str] = None,
              external_id: Optional[str] = None,
              include_users: 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,
              opts: Optional[InvokeOptions] = None) -> GetGroupResult
def get_group_output(admin_privileges: Optional[pulumi.Input[bool]] = None,
              auto_join: Optional[pulumi.Input[bool]] = None,
              description: Optional[pulumi.Input[str]] = None,
              external_id: Optional[pulumi.Input[str]] = None,
              include_users: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              policy_manager: Optional[pulumi.Input[bool]] = None,
              realm: Optional[pulumi.Input[str]] = None,
              realm_attributes: Optional[pulumi.Input[str]] = None,
              reports_manager: Optional[pulumi.Input[bool]] = None,
              users_names: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
              watch_manager: Optional[pulumi.Input[bool]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetGroupResult]
func LookupGroup(ctx *Context, args *LookupGroupArgs, opts ...InvokeOption) (*LookupGroupResult, error)
func LookupGroupOutput(ctx *Context, args *LookupGroupOutputArgs, opts ...InvokeOption) LookupGroupResultOutput

> Note: This function is named LookupGroup in the Go SDK.

public static class GetGroup 
{
    public static Task<GetGroupResult> InvokeAsync(GetGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetGroupResult> Invoke(GetGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetGroupResult> getGroup(GetGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: artifactory:index/getGroup:getGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

Name of the group.

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.

IncludeUsers string

Determines if the group's associated user list will return as an attribute. Default is false.

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>

List of users assigned to the group. Set include_users to true to retrieve this list.

WatchManager bool

When this override is set, User in the group can manage Xray Watches on any resource type. Default value is 'false'.

Name string

Name of the group.

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.

IncludeUsers string

Determines if the group's associated user list will return as an attribute. Default is false.

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

List of users assigned to the group. Set include_users to true to retrieve this list.

WatchManager bool

When this override is set, User in the group can manage Xray Watches on any resource type. Default value is 'false'.

name String

Name of the group.

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.

includeUsers String

Determines if the group's associated user list will return as an attribute. Default is false.

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>

List of users assigned to the group. Set include_users to true to retrieve this list.

watchManager Boolean

When this override is set, User in the group can manage Xray Watches on any resource type. Default value is 'false'.

name string

Name of the group.

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.

includeUsers string

Determines if the group's associated user list will return as an attribute. Default is false.

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[]

List of users assigned to the group. Set include_users to true to retrieve this list.

watchManager boolean

When this override is set, User in the group can manage Xray Watches on any resource type. Default value is 'false'.

name str

Name of the group.

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.

include_users str

Determines if the group's associated user list will return as an attribute. Default is false.

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]

List of users assigned to the group. Set include_users to true to retrieve this list.

watch_manager bool

When this override is set, User in the group can manage Xray Watches on any resource type. Default value is 'false'.

name String

Name of the group.

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.

includeUsers String

Determines if the group's associated user list will return as an attribute. Default is false.

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>

List of users assigned to the group. Set include_users to true to retrieve this list.

watchManager Boolean

When this override is set, User in the group can manage Xray Watches on any resource type. Default value is 'false'.

getGroup Result

The following output properties are available:

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.

Id string

The provider-assigned unique ID for this managed resource.

Name string
Realm string

The realm for the group.

Description string

A description for the group

ExternalId string

New external group ID used to configure the corresponding group in Azure AD.

IncludeUsers string
PolicyManager bool

When this override is set, User in the group can set Xray security and compliance policies. Default value is 'false'.

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>

List of users assigned to the group. Set include_users to true to retrieve this list.

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.

Id string

The provider-assigned unique ID for this managed resource.

Name string
Realm string

The realm for the group.

Description string

A description for the group

ExternalId string

New external group ID used to configure the corresponding group in Azure AD.

IncludeUsers string
PolicyManager bool

When this override is set, User in the group can set Xray security and compliance policies. Default value is 'false'.

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

List of users assigned to the group. Set include_users to true to retrieve this list.

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.

id String

The provider-assigned unique ID for this managed resource.

name String
realm String

The realm for the group.

description String

A description for the group

externalId String

New external group ID used to configure the corresponding group in Azure AD.

includeUsers String
policyManager Boolean

When this override is set, User in the group can set Xray security and compliance policies. Default value is 'false'.

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>

List of users assigned to the group. Set include_users to true to retrieve this list.

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.

id string

The provider-assigned unique ID for this managed resource.

name string
realm string

The realm for the group.

description string

A description for the group

externalId string

New external group ID used to configure the corresponding group in Azure AD.

includeUsers string
policyManager boolean

When this override is set, User in the group can set Xray security and compliance policies. Default value is 'false'.

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[]

List of users assigned to the group. Set include_users to true to retrieve this list.

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.

id str

The provider-assigned unique ID for this managed resource.

name str
realm str

The realm for the group.

description str

A description for the group

external_id str

New external group ID used to configure the corresponding group in Azure AD.

include_users str
policy_manager bool

When this override is set, User in the group can set Xray security and compliance policies. Default value is 'false'.

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]

List of users assigned to the group. Set include_users to true to retrieve this list.

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.

id String

The provider-assigned unique ID for this managed resource.

name String
realm String

The realm for the group.

description String

A description for the group

externalId String

New external group ID used to configure the corresponding group in Azure AD.

includeUsers String
policyManager Boolean

When this override is set, User in the group can set Xray security and compliance policies. Default value is 'false'.

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>

List of users assigned to the group. Set include_users to true to retrieve this list.

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.