1. Packages
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. Group
Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

akeyless.Group

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community
Schema (JSON)
akeyless-community/terraform-provider-akeyless

    Group resource

    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: GroupArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Group(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          group_alias: Optional[str] = None,
          user_assignment: Optional[str] = None,
          description: Optional[str] = None,
          group_id: Optional[str] = None,
          name: Optional[str] = None)
    func NewGroup(ctx *Context, name string, args GroupArgs, opts ...ResourceOption) (*Group, error)
    public Group(string name, GroupArgs args, CustomResourceOptions? opts = null)
    public Group(String name, GroupArgs args)
public Group(String name, GroupArgs args, CustomResourceOptions options)

    type: akeyless:Group
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 GroupArgs
    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 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 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 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 String
    The unique name of the resource.
    args 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 Akeyless.Group("groupResource", new()
{
    GroupAlias = "string",
    UserAssignment = "string",
    Description = "string",
    GroupId = "string",
    Name = "string",
});

    example, err := akeyless.NewGroup(ctx, "groupResource", &akeyless.GroupArgs{
	GroupAlias:     pulumi.String("string"),
	UserAssignment: pulumi.String("string"),
	Description:    pulumi.String("string"),
	GroupId:        pulumi.String("string"),
	Name:           pulumi.String("string"),
})

    var groupResource = new Group("groupResource", GroupArgs.builder()
    .groupAlias("string")
    .userAssignment("string")
    .description("string")
    .groupId("string")
    .name("string")
    .build());

    group_resource = akeyless.Group("groupResource",
    group_alias="string",
    user_assignment="string",
    description="string",
    group_id="string",
    name="string")

    const groupResource = new akeyless.Group("groupResource", {
    groupAlias: "string",
    userAssignment: "string",
    description: "string",
    groupId: "string",
    name: "string",
});

    type: akeyless:Group
properties:
    description: string
    groupAlias: string
    groupId: string
    name: string
    userAssignment: string

    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:

    GroupAlias string
    A short group alias
    UserAssignment string
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    Description string
    Description of the object
    GroupId string
    The ID of this resource.
    Name string
    Group name
    GroupAlias string
    A short group alias
    UserAssignment string
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    Description string
    Description of the object
    GroupId string
    The ID of this resource.
    Name string
    Group name
    groupAlias String
    A short group alias
    userAssignment String
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    description String
    Description of the object
    groupId String
    The ID of this resource.
    name String
    Group name
    groupAlias string
    A short group alias
    userAssignment string
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    description string
    Description of the object
    groupId string
    The ID of this resource.
    name string
    Group name
    group_alias str
    A short group alias
    user_assignment str
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    description str
    Description of the object
    group_id str
    The ID of this resource.
    name str
    Group name
    groupAlias String
    A short group alias
    userAssignment String
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    description String
    Description of the object
    groupId String
    The ID of this resource.
    name String
    Group name

    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,
        description: Optional[str] = None,
        group_alias: Optional[str] = None,
        group_id: Optional[str] = None,
        name: Optional[str] = None,
        user_assignment: Optional[str] = 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: akeyless:Group    get:      id: ${id}
    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:
    Description string
    Description of the object
    GroupAlias string
    A short group alias
    GroupId string
    The ID of this resource.
    Name string
    Group name
    UserAssignment string
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    Description string
    Description of the object
    GroupAlias string
    A short group alias
    GroupId string
    The ID of this resource.
    Name string
    Group name
    UserAssignment string
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    description String
    Description of the object
    groupAlias String
    A short group alias
    groupId String
    The ID of this resource.
    name String
    Group name
    userAssignment String
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    description string
    Description of the object
    groupAlias string
    A short group alias
    groupId string
    The ID of this resource.
    name string
    Group name
    userAssignment string
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    description str
    Description of the object
    group_alias str
    A short group alias
    group_id str
    The ID of this resource.
    name str
    Group name
    user_assignment str
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.
    description String
    Description of the object
    groupAlias String
    A short group alias
    groupId String
    The ID of this resource.
    name String
    Group name
    userAssignment String
    A json array string defining the access permission assignment for this group. Format: [{"accessid":"p-abc123","subclaims":{"email":["user@example.com"]}}]. The accessid is the auth method access ID, and subclaims is a map of claim names to arrays of allowed values.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    Viewing docs for akeyless 2.0.1
    published on Monday, Apr 27, 2026 by akeyless-community
    Schema (JSON)
    akeyless-community/terraform-provider-akeyless
      Try Pulumi Cloud free. Your team will thank you.