1. Packages
  2. Athenz Provider
  3. API Docs
  4. GroupMeta
athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz

athenz.GroupMeta

Explore with Pulumi AI

Example Usage

IMPORTANT NOTE: please do NOT use json syntax but only hcl syntax

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

const groupMeta = new athenz.GroupMeta("groupMeta", {
    auditRef: "update group meta",
    deleteProtection: false,
    domain: "some_domain",
    maxMembers: 0,
    notifyRoles: "notify details",
    principalDomainFilter: "user,home,+sports,-sports.dev",
    reviewEnabled: false,
    selfRenew: false,
    selfRenewMins: 90,
    selfServe: true,
    serviceExpiryDays: 120,
    tags: {
        key1: "val1,val2",
        key2: "val3,val4",
    },
    userAuthorityExpiration: "ElevatedClearance",
    userAuthorityFilter: "OnShore-US",
    userExpiryDays: 90,
});
Copy
import pulumi
import pulumi_athenz as athenz

group_meta = athenz.GroupMeta("groupMeta",
    audit_ref="update group meta",
    delete_protection=False,
    domain="some_domain",
    max_members=0,
    notify_roles="notify details",
    principal_domain_filter="user,home,+sports,-sports.dev",
    review_enabled=False,
    self_renew=False,
    self_renew_mins=90,
    self_serve=True,
    service_expiry_days=120,
    tags={
        "key1": "val1,val2",
        "key2": "val3,val4",
    },
    user_authority_expiration="ElevatedClearance",
    user_authority_filter="OnShore-US",
    user_expiry_days=90)
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := athenz.NewGroupMeta(ctx, "groupMeta", &athenz.GroupMetaArgs{
			AuditRef:              pulumi.String("update group meta"),
			DeleteProtection:      pulumi.Bool(false),
			Domain:                pulumi.String("some_domain"),
			MaxMembers:            pulumi.Float64(0),
			NotifyRoles:           pulumi.String("notify details"),
			PrincipalDomainFilter: pulumi.String("user,home,+sports,-sports.dev"),
			ReviewEnabled:         pulumi.Bool(false),
			SelfRenew:             pulumi.Bool(false),
			SelfRenewMins:         pulumi.Float64(90),
			SelfServe:             pulumi.Bool(true),
			ServiceExpiryDays:     pulumi.Float64(120),
			Tags: pulumi.StringMap{
				"key1": pulumi.String("val1,val2"),
				"key2": pulumi.String("val3,val4"),
			},
			UserAuthorityExpiration: pulumi.String("ElevatedClearance"),
			UserAuthorityFilter:     pulumi.String("OnShore-US"),
			UserExpiryDays:          pulumi.Float64(90),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Athenz = Pulumi.Athenz;

return await Deployment.RunAsync(() => 
{
    var groupMeta = new Athenz.GroupMeta("groupMeta", new()
    {
        AuditRef = "update group meta",
        DeleteProtection = false,
        Domain = "some_domain",
        MaxMembers = 0,
        NotifyRoles = "notify details",
        PrincipalDomainFilter = "user,home,+sports,-sports.dev",
        ReviewEnabled = false,
        SelfRenew = false,
        SelfRenewMins = 90,
        SelfServe = true,
        ServiceExpiryDays = 120,
        Tags = 
        {
            { "key1", "val1,val2" },
            { "key2", "val3,val4" },
        },
        UserAuthorityExpiration = "ElevatedClearance",
        UserAuthorityFilter = "OnShore-US",
        UserExpiryDays = 90,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.athenz.GroupMeta;
import com.pulumi.athenz.GroupMetaArgs;
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 groupMeta = new GroupMeta("groupMeta", GroupMetaArgs.builder()
            .auditRef("update group meta")
            .deleteProtection(false)
            .domain("some_domain")
            .maxMembers(0)
            .notifyRoles("notify details")
            .principalDomainFilter("user,home,+sports,-sports.dev")
            .reviewEnabled(false)
            .selfRenew(false)
            .selfRenewMins(90)
            .selfServe(true)
            .serviceExpiryDays(120)
            .tags(Map.ofEntries(
                Map.entry("key1", "val1,val2"),
                Map.entry("key2", "val3,val4")
            ))
            .userAuthorityExpiration("ElevatedClearance")
            .userAuthorityFilter("OnShore-US")
            .userExpiryDays(90)
            .build());

    }
}
Copy
resources:
  groupMeta:
    type: athenz:GroupMeta
    properties:
      auditRef: update group meta
      deleteProtection: false
      domain: some_domain
      maxMembers: 0
      notifyRoles: notify details
      principalDomainFilter: user,home,+sports,-sports.dev
      reviewEnabled: false
      selfRenew: false
      selfRenewMins: 90
      selfServe: true
      serviceExpiryDays: 120
      tags:
        key1: val1,val2
        key2: val3,val4
      userAuthorityExpiration: ElevatedClearance
      userAuthorityFilter: OnShore-US
      userExpiryDays: 90
Copy

athenz.GroupMeta (Resource)

athenz.GroupMeta provides an Athenz group meta resource.

Create GroupMeta Resource

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

Constructor syntax

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

@overload
def GroupMeta(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              domain: Optional[str] = None,
              resource_state: Optional[float] = None,
              review_enabled: Optional[bool] = None,
              audit_ref: Optional[str] = None,
              audit_enabled: Optional[bool] = None,
              max_members: Optional[float] = None,
              name: Optional[str] = None,
              notify_details: Optional[str] = None,
              notify_roles: Optional[str] = None,
              delete_protection: Optional[bool] = None,
              principal_domain_filter: Optional[str] = None,
              group_meta_id: Optional[str] = None,
              self_renew: Optional[bool] = None,
              self_renew_mins: Optional[float] = None,
              self_serve: Optional[bool] = None,
              service_expiry_days: Optional[float] = None,
              tags: Optional[Mapping[str, str]] = None,
              user_authority_expiration: Optional[str] = None,
              user_authority_filter: Optional[str] = None,
              user_expiry_days: Optional[float] = None)
func NewGroupMeta(ctx *Context, name string, args GroupMetaArgs, opts ...ResourceOption) (*GroupMeta, error)
public GroupMeta(string name, GroupMetaArgs args, CustomResourceOptions? opts = null)
public GroupMeta(String name, GroupMetaArgs args)
public GroupMeta(String name, GroupMetaArgs args, CustomResourceOptions options)
type: athenz:GroupMeta
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 This property is required. GroupMetaArgs
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 This property is required. GroupMetaArgs
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 This property is required. GroupMetaArgs
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 This property is required. GroupMetaArgs
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. GroupMetaArgs
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 groupMetaResource = new Athenz.GroupMeta("groupMetaResource", new()
{
    Domain = "string",
    ResourceState = 0,
    ReviewEnabled = false,
    AuditRef = "string",
    AuditEnabled = false,
    MaxMembers = 0,
    Name = "string",
    NotifyDetails = "string",
    NotifyRoles = "string",
    DeleteProtection = false,
    PrincipalDomainFilter = "string",
    GroupMetaId = "string",
    SelfRenew = false,
    SelfRenewMins = 0,
    SelfServe = false,
    ServiceExpiryDays = 0,
    Tags = 
    {
        { "string", "string" },
    },
    UserAuthorityExpiration = "string",
    UserAuthorityFilter = "string",
    UserExpiryDays = 0,
});
Copy
example, err := athenz.NewGroupMeta(ctx, "groupMetaResource", &athenz.GroupMetaArgs{
	Domain:                pulumi.String("string"),
	ResourceState:         pulumi.Float64(0),
	ReviewEnabled:         pulumi.Bool(false),
	AuditRef:              pulumi.String("string"),
	AuditEnabled:          pulumi.Bool(false),
	MaxMembers:            pulumi.Float64(0),
	Name:                  pulumi.String("string"),
	NotifyDetails:         pulumi.String("string"),
	NotifyRoles:           pulumi.String("string"),
	DeleteProtection:      pulumi.Bool(false),
	PrincipalDomainFilter: pulumi.String("string"),
	GroupMetaId:           pulumi.String("string"),
	SelfRenew:             pulumi.Bool(false),
	SelfRenewMins:         pulumi.Float64(0),
	SelfServe:             pulumi.Bool(false),
	ServiceExpiryDays:     pulumi.Float64(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	UserAuthorityExpiration: pulumi.String("string"),
	UserAuthorityFilter:     pulumi.String("string"),
	UserExpiryDays:          pulumi.Float64(0),
})
Copy
var groupMetaResource = new GroupMeta("groupMetaResource", GroupMetaArgs.builder()
    .domain("string")
    .resourceState(0)
    .reviewEnabled(false)
    .auditRef("string")
    .auditEnabled(false)
    .maxMembers(0)
    .name("string")
    .notifyDetails("string")
    .notifyRoles("string")
    .deleteProtection(false)
    .principalDomainFilter("string")
    .groupMetaId("string")
    .selfRenew(false)
    .selfRenewMins(0)
    .selfServe(false)
    .serviceExpiryDays(0)
    .tags(Map.of("string", "string"))
    .userAuthorityExpiration("string")
    .userAuthorityFilter("string")
    .userExpiryDays(0)
    .build());
Copy
group_meta_resource = athenz.GroupMeta("groupMetaResource",
    domain="string",
    resource_state=0,
    review_enabled=False,
    audit_ref="string",
    audit_enabled=False,
    max_members=0,
    name="string",
    notify_details="string",
    notify_roles="string",
    delete_protection=False,
    principal_domain_filter="string",
    group_meta_id="string",
    self_renew=False,
    self_renew_mins=0,
    self_serve=False,
    service_expiry_days=0,
    tags={
        "string": "string",
    },
    user_authority_expiration="string",
    user_authority_filter="string",
    user_expiry_days=0)
Copy
const groupMetaResource = new athenz.GroupMeta("groupMetaResource", {
    domain: "string",
    resourceState: 0,
    reviewEnabled: false,
    auditRef: "string",
    auditEnabled: false,
    maxMembers: 0,
    name: "string",
    notifyDetails: "string",
    notifyRoles: "string",
    deleteProtection: false,
    principalDomainFilter: "string",
    groupMetaId: "string",
    selfRenew: false,
    selfRenewMins: 0,
    selfServe: false,
    serviceExpiryDays: 0,
    tags: {
        string: "string",
    },
    userAuthorityExpiration: "string",
    userAuthorityFilter: "string",
    userExpiryDays: 0,
});
Copy
type: athenz:GroupMeta
properties:
    auditEnabled: false
    auditRef: string
    deleteProtection: false
    domain: string
    groupMetaId: string
    maxMembers: 0
    name: string
    notifyDetails: string
    notifyRoles: string
    principalDomainFilter: string
    resourceState: 0
    reviewEnabled: false
    selfRenew: false
    selfRenewMins: 0
    selfServe: false
    serviceExpiryDays: 0
    tags:
        string: string
    userAuthorityExpiration: string
    userAuthorityFilter: string
    userExpiryDays: 0
Copy

GroupMeta 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 GroupMeta resource accepts the following input properties:

Domain This property is required. string
name of the domain
AuditEnabled bool
audit enabled flag for the group
AuditRef string
string containing audit specification or ticket number.
DeleteProtection bool
If true, ask for delete confirmation in audit and review enabled groups
GroupMetaId string
The ID of this resource.
MaxMembers double
maximum number of members allowed in the group
Name string
Name of the group
NotifyDetails string
Set of instructions included in notifications for review and audit enabled groups
NotifyRoles string
comma seperated list of roles whose members should be notified for member review/approval
PrincipalDomainFilter string
comma seperated list of domains to enforce principal membership
ResourceState double
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
ReviewEnabled bool
Flag indicates whether group updates require another review and approval
SelfRenew bool
Flag indicates whether to allow expired members to renew their membership
SelfRenewMins double
Number of minutes members can renew their membership if self review option is enabled
SelfServe bool
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
ServiceExpiryDays double
all services in the group will have specified max expiry days
Tags Dictionary<string, string>
map of group tags
UserAuthorityExpiration string
expiration enforced by a user authority configured attribute
UserAuthorityFilter string
membership filtered based on user authority configured attributes
UserExpiryDays double
all user members in the group will have specified max expiry days
Domain This property is required. string
name of the domain
AuditEnabled bool
audit enabled flag for the group
AuditRef string
string containing audit specification or ticket number.
DeleteProtection bool
If true, ask for delete confirmation in audit and review enabled groups
GroupMetaId string
The ID of this resource.
MaxMembers float64
maximum number of members allowed in the group
Name string
Name of the group
NotifyDetails string
Set of instructions included in notifications for review and audit enabled groups
NotifyRoles string
comma seperated list of roles whose members should be notified for member review/approval
PrincipalDomainFilter string
comma seperated list of domains to enforce principal membership
ResourceState float64
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
ReviewEnabled bool
Flag indicates whether group updates require another review and approval
SelfRenew bool
Flag indicates whether to allow expired members to renew their membership
SelfRenewMins float64
Number of minutes members can renew their membership if self review option is enabled
SelfServe bool
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
ServiceExpiryDays float64
all services in the group will have specified max expiry days
Tags map[string]string
map of group tags
UserAuthorityExpiration string
expiration enforced by a user authority configured attribute
UserAuthorityFilter string
membership filtered based on user authority configured attributes
UserExpiryDays float64
all user members in the group will have specified max expiry days
domain This property is required. String
name of the domain
auditEnabled Boolean
audit enabled flag for the group
auditRef String
string containing audit specification or ticket number.
deleteProtection Boolean
If true, ask for delete confirmation in audit and review enabled groups
groupMetaId String
The ID of this resource.
maxMembers Double
maximum number of members allowed in the group
name String
Name of the group
notifyDetails String
Set of instructions included in notifications for review and audit enabled groups
notifyRoles String
comma seperated list of roles whose members should be notified for member review/approval
principalDomainFilter String
comma seperated list of domains to enforce principal membership
resourceState Double
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
reviewEnabled Boolean
Flag indicates whether group updates require another review and approval
selfRenew Boolean
Flag indicates whether to allow expired members to renew their membership
selfRenewMins Double
Number of minutes members can renew their membership if self review option is enabled
selfServe Boolean
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
serviceExpiryDays Double
all services in the group will have specified max expiry days
tags Map<String,String>
map of group tags
userAuthorityExpiration String
expiration enforced by a user authority configured attribute
userAuthorityFilter String
membership filtered based on user authority configured attributes
userExpiryDays Double
all user members in the group will have specified max expiry days
domain This property is required. string
name of the domain
auditEnabled boolean
audit enabled flag for the group
auditRef string
string containing audit specification or ticket number.
deleteProtection boolean
If true, ask for delete confirmation in audit and review enabled groups
groupMetaId string
The ID of this resource.
maxMembers number
maximum number of members allowed in the group
name string
Name of the group
notifyDetails string
Set of instructions included in notifications for review and audit enabled groups
notifyRoles string
comma seperated list of roles whose members should be notified for member review/approval
principalDomainFilter string
comma seperated list of domains to enforce principal membership
resourceState number
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
reviewEnabled boolean
Flag indicates whether group updates require another review and approval
selfRenew boolean
Flag indicates whether to allow expired members to renew their membership
selfRenewMins number
Number of minutes members can renew their membership if self review option is enabled
selfServe boolean
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
serviceExpiryDays number
all services in the group will have specified max expiry days
tags {[key: string]: string}
map of group tags
userAuthorityExpiration string
expiration enforced by a user authority configured attribute
userAuthorityFilter string
membership filtered based on user authority configured attributes
userExpiryDays number
all user members in the group will have specified max expiry days
domain This property is required. str
name of the domain
audit_enabled bool
audit enabled flag for the group
audit_ref str
string containing audit specification or ticket number.
delete_protection bool
If true, ask for delete confirmation in audit and review enabled groups
group_meta_id str
The ID of this resource.
max_members float
maximum number of members allowed in the group
name str
Name of the group
notify_details str
Set of instructions included in notifications for review and audit enabled groups
notify_roles str
comma seperated list of roles whose members should be notified for member review/approval
principal_domain_filter str
comma seperated list of domains to enforce principal membership
resource_state float
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
review_enabled bool
Flag indicates whether group updates require another review and approval
self_renew bool
Flag indicates whether to allow expired members to renew their membership
self_renew_mins float
Number of minutes members can renew their membership if self review option is enabled
self_serve bool
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
service_expiry_days float
all services in the group will have specified max expiry days
tags Mapping[str, str]
map of group tags
user_authority_expiration str
expiration enforced by a user authority configured attribute
user_authority_filter str
membership filtered based on user authority configured attributes
user_expiry_days float
all user members in the group will have specified max expiry days
domain This property is required. String
name of the domain
auditEnabled Boolean
audit enabled flag for the group
auditRef String
string containing audit specification or ticket number.
deleteProtection Boolean
If true, ask for delete confirmation in audit and review enabled groups
groupMetaId String
The ID of this resource.
maxMembers Number
maximum number of members allowed in the group
name String
Name of the group
notifyDetails String
Set of instructions included in notifications for review and audit enabled groups
notifyRoles String
comma seperated list of roles whose members should be notified for member review/approval
principalDomainFilter String
comma seperated list of domains to enforce principal membership
resourceState Number
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
reviewEnabled Boolean
Flag indicates whether group updates require another review and approval
selfRenew Boolean
Flag indicates whether to allow expired members to renew their membership
selfRenewMins Number
Number of minutes members can renew their membership if self review option is enabled
selfServe Boolean
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
serviceExpiryDays Number
all services in the group will have specified max expiry days
tags Map<String>
map of group tags
userAuthorityExpiration String
expiration enforced by a user authority configured attribute
userAuthorityFilter String
membership filtered based on user authority configured attributes
userExpiryDays Number
all user members in the group will have specified max expiry days

Outputs

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

Get an existing GroupMeta 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?: GroupMetaState, opts?: CustomResourceOptions): GroupMeta
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audit_enabled: Optional[bool] = None,
        audit_ref: Optional[str] = None,
        delete_protection: Optional[bool] = None,
        domain: Optional[str] = None,
        group_meta_id: Optional[str] = None,
        max_members: Optional[float] = None,
        name: Optional[str] = None,
        notify_details: Optional[str] = None,
        notify_roles: Optional[str] = None,
        principal_domain_filter: Optional[str] = None,
        resource_state: Optional[float] = None,
        review_enabled: Optional[bool] = None,
        self_renew: Optional[bool] = None,
        self_renew_mins: Optional[float] = None,
        self_serve: Optional[bool] = None,
        service_expiry_days: Optional[float] = None,
        tags: Optional[Mapping[str, str]] = None,
        user_authority_expiration: Optional[str] = None,
        user_authority_filter: Optional[str] = None,
        user_expiry_days: Optional[float] = None) -> GroupMeta
func GetGroupMeta(ctx *Context, name string, id IDInput, state *GroupMetaState, opts ...ResourceOption) (*GroupMeta, error)
public static GroupMeta Get(string name, Input<string> id, GroupMetaState? state, CustomResourceOptions? opts = null)
public static GroupMeta get(String name, Output<String> id, GroupMetaState state, CustomResourceOptions options)
resources:  _:    type: athenz:GroupMeta    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:
AuditEnabled bool
audit enabled flag for the group
AuditRef string
string containing audit specification or ticket number.
DeleteProtection bool
If true, ask for delete confirmation in audit and review enabled groups
Domain string
name of the domain
GroupMetaId string
The ID of this resource.
MaxMembers double
maximum number of members allowed in the group
Name string
Name of the group
NotifyDetails string
Set of instructions included in notifications for review and audit enabled groups
NotifyRoles string
comma seperated list of roles whose members should be notified for member review/approval
PrincipalDomainFilter string
comma seperated list of domains to enforce principal membership
ResourceState double
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
ReviewEnabled bool
Flag indicates whether group updates require another review and approval
SelfRenew bool
Flag indicates whether to allow expired members to renew their membership
SelfRenewMins double
Number of minutes members can renew their membership if self review option is enabled
SelfServe bool
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
ServiceExpiryDays double
all services in the group will have specified max expiry days
Tags Dictionary<string, string>
map of group tags
UserAuthorityExpiration string
expiration enforced by a user authority configured attribute
UserAuthorityFilter string
membership filtered based on user authority configured attributes
UserExpiryDays double
all user members in the group will have specified max expiry days
AuditEnabled bool
audit enabled flag for the group
AuditRef string
string containing audit specification or ticket number.
DeleteProtection bool
If true, ask for delete confirmation in audit and review enabled groups
Domain string
name of the domain
GroupMetaId string
The ID of this resource.
MaxMembers float64
maximum number of members allowed in the group
Name string
Name of the group
NotifyDetails string
Set of instructions included in notifications for review and audit enabled groups
NotifyRoles string
comma seperated list of roles whose members should be notified for member review/approval
PrincipalDomainFilter string
comma seperated list of domains to enforce principal membership
ResourceState float64
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
ReviewEnabled bool
Flag indicates whether group updates require another review and approval
SelfRenew bool
Flag indicates whether to allow expired members to renew their membership
SelfRenewMins float64
Number of minutes members can renew their membership if self review option is enabled
SelfServe bool
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
ServiceExpiryDays float64
all services in the group will have specified max expiry days
Tags map[string]string
map of group tags
UserAuthorityExpiration string
expiration enforced by a user authority configured attribute
UserAuthorityFilter string
membership filtered based on user authority configured attributes
UserExpiryDays float64
all user members in the group will have specified max expiry days
auditEnabled Boolean
audit enabled flag for the group
auditRef String
string containing audit specification or ticket number.
deleteProtection Boolean
If true, ask for delete confirmation in audit and review enabled groups
domain String
name of the domain
groupMetaId String
The ID of this resource.
maxMembers Double
maximum number of members allowed in the group
name String
Name of the group
notifyDetails String
Set of instructions included in notifications for review and audit enabled groups
notifyRoles String
comma seperated list of roles whose members should be notified for member review/approval
principalDomainFilter String
comma seperated list of domains to enforce principal membership
resourceState Double
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
reviewEnabled Boolean
Flag indicates whether group updates require another review and approval
selfRenew Boolean
Flag indicates whether to allow expired members to renew their membership
selfRenewMins Double
Number of minutes members can renew their membership if self review option is enabled
selfServe Boolean
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
serviceExpiryDays Double
all services in the group will have specified max expiry days
tags Map<String,String>
map of group tags
userAuthorityExpiration String
expiration enforced by a user authority configured attribute
userAuthorityFilter String
membership filtered based on user authority configured attributes
userExpiryDays Double
all user members in the group will have specified max expiry days
auditEnabled boolean
audit enabled flag for the group
auditRef string
string containing audit specification or ticket number.
deleteProtection boolean
If true, ask for delete confirmation in audit and review enabled groups
domain string
name of the domain
groupMetaId string
The ID of this resource.
maxMembers number
maximum number of members allowed in the group
name string
Name of the group
notifyDetails string
Set of instructions included in notifications for review and audit enabled groups
notifyRoles string
comma seperated list of roles whose members should be notified for member review/approval
principalDomainFilter string
comma seperated list of domains to enforce principal membership
resourceState number
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
reviewEnabled boolean
Flag indicates whether group updates require another review and approval
selfRenew boolean
Flag indicates whether to allow expired members to renew their membership
selfRenewMins number
Number of minutes members can renew their membership if self review option is enabled
selfServe boolean
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
serviceExpiryDays number
all services in the group will have specified max expiry days
tags {[key: string]: string}
map of group tags
userAuthorityExpiration string
expiration enforced by a user authority configured attribute
userAuthorityFilter string
membership filtered based on user authority configured attributes
userExpiryDays number
all user members in the group will have specified max expiry days
audit_enabled bool
audit enabled flag for the group
audit_ref str
string containing audit specification or ticket number.
delete_protection bool
If true, ask for delete confirmation in audit and review enabled groups
domain str
name of the domain
group_meta_id str
The ID of this resource.
max_members float
maximum number of members allowed in the group
name str
Name of the group
notify_details str
Set of instructions included in notifications for review and audit enabled groups
notify_roles str
comma seperated list of roles whose members should be notified for member review/approval
principal_domain_filter str
comma seperated list of domains to enforce principal membership
resource_state float
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
review_enabled bool
Flag indicates whether group updates require another review and approval
self_renew bool
Flag indicates whether to allow expired members to renew their membership
self_renew_mins float
Number of minutes members can renew their membership if self review option is enabled
self_serve bool
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
service_expiry_days float
all services in the group will have specified max expiry days
tags Mapping[str, str]
map of group tags
user_authority_expiration str
expiration enforced by a user authority configured attribute
user_authority_filter str
membership filtered based on user authority configured attributes
user_expiry_days float
all user members in the group will have specified max expiry days
auditEnabled Boolean
audit enabled flag for the group
auditRef String
string containing audit specification or ticket number.
deleteProtection Boolean
If true, ask for delete confirmation in audit and review enabled groups
domain String
name of the domain
groupMetaId String
The ID of this resource.
maxMembers Number
maximum number of members allowed in the group
name String
Name of the group
notifyDetails String
Set of instructions included in notifications for review and audit enabled groups
notifyRoles String
comma seperated list of roles whose members should be notified for member review/approval
principalDomainFilter String
comma seperated list of domains to enforce principal membership
resourceState Number
Bitmask of resource state flags controlling group behavior when creating or destroying the resource. 0x01: create the group if not already present, 0x02: always delete the group when destroying the resource. Default value is -1 indicating to inherit the value defined at the provider configuration level.
reviewEnabled Boolean
Flag indicates whether group updates require another review and approval
selfRenew Boolean
Flag indicates whether to allow expired members to renew their membership
selfRenewMins Number
Number of minutes members can renew their membership if self review option is enabled
selfServe Boolean
Flag indicates whether group allows self-service. Users can add themselves in the group, but it has to be approved by domain admins to be effective.
serviceExpiryDays Number
all services in the group will have specified max expiry days
tags Map<String>
map of group tags
userAuthorityExpiration String
expiration enforced by a user authority configured attribute
userAuthorityFilter String
membership filtered based on user authority configured attributes
userExpiryDays Number
all user members in the group will have specified max expiry days

Package Details

Repository
athenz athenz/terraform-provider-athenz
License
Notes
This Pulumi package is based on the athenz Terraform Provider.