Docs Packages
  1. Packages
  2. Dynatrace
  3. API Docs
  4. UserGroup
Dynatrace v0.1.0 published on Wednesday, May 24, 2023 by Lbrlabs
lbrlabs/pulumi-dynatrace

dynatrace.UserGroup

Explore with Pulumi AI

dynatrace logo
Dynatrace v0.1.0 published on Wednesday, May 24, 2023 by Lbrlabs
lbrlabs/pulumi-dynatrace

    Dynatrace Documentation

    • User management and SSO - https://www.dynatrace.com/support/help/how-to-use-dynatrace/user-management-and-sso

    • User management API - https://www.dynatrace.com/support/help/dynatrace-api/account-management-api/user-management-api

    Create UserGroup Resource

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

    Constructor syntax

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

@overload
def UserGroup(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              access_account: Optional[bool] = None,
              cluster_admin: Optional[bool] = None,
              ldap_groups: Optional[Sequence[str]] = None,
              manage_account: Optional[bool] = None,
              name: Optional[str] = None,
              permissions: Optional[UserGroupPermissionsArgs] = None,
              sso_groups: Optional[Sequence[str]] = None)
    func NewUserGroup(ctx *Context, name string, args *UserGroupArgs, opts ...ResourceOption) (*UserGroup, error)
    public UserGroup(string name, UserGroupArgs? args = null, CustomResourceOptions? opts = null)
    public UserGroup(String name, UserGroupArgs args)
public UserGroup(String name, UserGroupArgs args, CustomResourceOptions options)

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

    Parameters

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

    Example

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

    var userGroupResource = new Dynatrace.UserGroup("userGroupResource", new()
{
    AccessAccount = false,
    ClusterAdmin = false,
    LdapGroups = new[]
    {
        "string",
    },
    ManageAccount = false,
    Name = "string",
    Permissions = new Dynatrace.Inputs.UserGroupPermissionsArgs
    {
        Grants = new[]
        {
            new Dynatrace.Inputs.UserGroupPermissionsGrantArgs
            {
                Permission = "string",
                Environments = new[]
                {
                    "string",
                },
            },
        },
    },
    SsoGroups = new[]
    {
        "string",
    },
});

    example, err := dynatrace.NewUserGroup(ctx, "userGroupResource", &dynatrace.UserGroupArgs{
	AccessAccount: pulumi.Bool(false),
	ClusterAdmin:  pulumi.Bool(false),
	LdapGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
	ManageAccount: pulumi.Bool(false),
	Name:          pulumi.String("string"),
	Permissions: &dynatrace.UserGroupPermissionsArgs{
		Grants: dynatrace.UserGroupPermissionsGrantArray{
			&dynatrace.UserGroupPermissionsGrantArgs{
				Permission: pulumi.String("string"),
				Environments: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
	SsoGroups: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var userGroupResource = new UserGroup("userGroupResource", UserGroupArgs.builder()        
    .accessAccount(false)
    .clusterAdmin(false)
    .ldapGroups("string")
    .manageAccount(false)
    .name("string")
    .permissions(UserGroupPermissionsArgs.builder()
        .grants(UserGroupPermissionsGrantArgs.builder()
            .permission("string")
            .environments("string")
            .build())
        .build())
    .ssoGroups("string")
    .build());

    user_group_resource = dynatrace.UserGroup("userGroupResource",
    access_account=False,
    cluster_admin=False,
    ldap_groups=["string"],
    manage_account=False,
    name="string",
    permissions=dynatrace.UserGroupPermissionsArgs(
        grants=[dynatrace.UserGroupPermissionsGrantArgs(
            permission="string",
            environments=["string"],
        )],
    ),
    sso_groups=["string"])

    const userGroupResource = new dynatrace.UserGroup("userGroupResource", {
    accessAccount: false,
    clusterAdmin: false,
    ldapGroups: ["string"],
    manageAccount: false,
    name: "string",
    permissions: {
        grants: [{
            permission: "string",
            environments: ["string"],
        }],
    },
    ssoGroups: ["string"],
});

    type: dynatrace:UserGroup
properties:
    accessAccount: false
    clusterAdmin: false
    ldapGroups:
        - string
    manageAccount: false
    name: string
    permissions:
        grants:
            - environments:
                - string
              permission: string
    ssoGroups:
        - string

    UserGroup Resource Properties

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

    Inputs

    The UserGroup resource accepts the following input properties:

    AccessAccount bool
    If true, then the group has the access account rights
    ClusterAdmin bool
    If true, then the group has the cluster administrator rights
    LdapGroups List<string>
    LDAP group names
    ManageAccount bool
    If true, then the group has the manage account rights
    Name string
    The name of the user group
    Permissions Lbrlabs.PulumiPackage.Dynatrace.Inputs.UserGroupPermissions
    Permissions for environments
    SsoGroups List<string>
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    AccessAccount bool
    If true, then the group has the access account rights
    ClusterAdmin bool
    If true, then the group has the cluster administrator rights
    LdapGroups []string
    LDAP group names
    ManageAccount bool
    If true, then the group has the manage account rights
    Name string
    The name of the user group
    Permissions UserGroupPermissionsArgs
    Permissions for environments
    SsoGroups []string
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    accessAccount Boolean
    If true, then the group has the access account rights
    clusterAdmin Boolean
    If true, then the group has the cluster administrator rights
    ldapGroups List<String>
    LDAP group names
    manageAccount Boolean
    If true, then the group has the manage account rights
    name String
    The name of the user group
    permissions UserGroupPermissions
    Permissions for environments
    ssoGroups List<String>
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    accessAccount boolean
    If true, then the group has the access account rights
    clusterAdmin boolean
    If true, then the group has the cluster administrator rights
    ldapGroups string[]
    LDAP group names
    manageAccount boolean
    If true, then the group has the manage account rights
    name string
    The name of the user group
    permissions UserGroupPermissions
    Permissions for environments
    ssoGroups string[]
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    access_account bool
    If true, then the group has the access account rights
    cluster_admin bool
    If true, then the group has the cluster administrator rights
    ldap_groups Sequence[str]
    LDAP group names
    manage_account bool
    If true, then the group has the manage account rights
    name str
    The name of the user group
    permissions UserGroupPermissionsArgs
    Permissions for environments
    sso_groups Sequence[str]
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    accessAccount Boolean
    If true, then the group has the access account rights
    clusterAdmin Boolean
    If true, then the group has the cluster administrator rights
    ldapGroups List<String>
    LDAP group names
    manageAccount Boolean
    If true, then the group has the manage account rights
    name String
    The name of the user group
    permissions Property Map
    Permissions for environments
    ssoGroups List<String>
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserGroup 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 UserGroup Resource

    Get an existing UserGroup 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?: UserGroupState, opts?: CustomResourceOptions): UserGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_account: Optional[bool] = None,
        cluster_admin: Optional[bool] = None,
        ldap_groups: Optional[Sequence[str]] = None,
        manage_account: Optional[bool] = None,
        name: Optional[str] = None,
        permissions: Optional[UserGroupPermissionsArgs] = None,
        sso_groups: Optional[Sequence[str]] = None) -> UserGroup
    func GetUserGroup(ctx *Context, name string, id IDInput, state *UserGroupState, opts ...ResourceOption) (*UserGroup, error)
    public static UserGroup Get(string name, Input<string> id, UserGroupState? state, CustomResourceOptions? opts = null)
    public static UserGroup get(String name, Output<String> id, UserGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    AccessAccount bool
    If true, then the group has the access account rights
    ClusterAdmin bool
    If true, then the group has the cluster administrator rights
    LdapGroups List<string>
    LDAP group names
    ManageAccount bool
    If true, then the group has the manage account rights
    Name string
    The name of the user group
    Permissions Lbrlabs.PulumiPackage.Dynatrace.Inputs.UserGroupPermissions
    Permissions for environments
    SsoGroups List<string>
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    AccessAccount bool
    If true, then the group has the access account rights
    ClusterAdmin bool
    If true, then the group has the cluster administrator rights
    LdapGroups []string
    LDAP group names
    ManageAccount bool
    If true, then the group has the manage account rights
    Name string
    The name of the user group
    Permissions UserGroupPermissionsArgs
    Permissions for environments
    SsoGroups []string
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    accessAccount Boolean
    If true, then the group has the access account rights
    clusterAdmin Boolean
    If true, then the group has the cluster administrator rights
    ldapGroups List<String>
    LDAP group names
    manageAccount Boolean
    If true, then the group has the manage account rights
    name String
    The name of the user group
    permissions UserGroupPermissions
    Permissions for environments
    ssoGroups List<String>
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    accessAccount boolean
    If true, then the group has the access account rights
    clusterAdmin boolean
    If true, then the group has the cluster administrator rights
    ldapGroups string[]
    LDAP group names
    manageAccount boolean
    If true, then the group has the manage account rights
    name string
    The name of the user group
    permissions UserGroupPermissions
    Permissions for environments
    ssoGroups string[]
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    access_account bool
    If true, then the group has the access account rights
    cluster_admin bool
    If true, then the group has the cluster administrator rights
    ldap_groups Sequence[str]
    LDAP group names
    manage_account bool
    If true, then the group has the manage account rights
    name str
    The name of the user group
    permissions UserGroupPermissionsArgs
    Permissions for environments
    sso_groups Sequence[str]
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name
    accessAccount Boolean
    If true, then the group has the access account rights
    clusterAdmin Boolean
    If true, then the group has the cluster administrator rights
    ldapGroups List<String>
    LDAP group names
    manageAccount Boolean
    If true, then the group has the manage account rights
    name String
    The name of the user group
    permissions Property Map
    Permissions for environments
    ssoGroups List<String>
    SSO group names. If defined it's used to map SSO group name to Dynatrace group name, otherwise mapping is done by group name

    Supporting Types

    UserGroupPermissions, UserGroupPermissionsArgs

    Grants List<Lbrlabs.PulumiPackage.Dynatrace.Inputs.UserGroupPermissionsGrant>
    A permission granted to one or multiple environments
    Grants []UserGroupPermissionsGrant
    A permission granted to one or multiple environments
    grants List<UserGroupPermissionsGrant>
    A permission granted to one or multiple environments
    grants UserGroupPermissionsGrant[]
    A permission granted to one or multiple environments
    grants Sequence[UserGroupPermissionsGrant]
    A permission granted to one or multiple environments
    grants List<Property Map>
    A permission granted to one or multiple environments

    UserGroupPermissionsGrant, UserGroupPermissionsGrantArgs

    Permission string
    Environments List<string>
    Permission string
    Environments []string
    permission String
    environments List<String>
    permission string
    environments string[]
    permission str
    environments Sequence[str]
    permission String
    environments List<String>

    Package Details

    Repository
    dynatrace lbrlabs/pulumi-dynatrace
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the dynatrace Terraform Provider.
    dynatrace logo
    Dynatrace v0.1.0 published on Wednesday, May 24, 2023 by Lbrlabs
    lbrlabs/pulumi-dynatrace