1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. Group
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community

    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,
              retry: Optional[GroupRetryArgs] = 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.
    
    
    resource "akeyless_group" "name" {
        # resource properties
    }

    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",
        Retry = new Akeyless.Inputs.GroupRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
    });
    
    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"),
    	Retry: &akeyless.GroupRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    })
    
    resource "akeyless_group" "groupResource" {
      lifecycle {
        create_before_destroy = true
      }
      group_alias     = "string"
      user_assignment = "string"
      description     = "string"
      group_id        = "string"
      name            = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
    }
    
    var groupResource = new Group("groupResource", GroupArgs.builder()
        .groupAlias("string")
        .userAssignment("string")
        .description("string")
        .groupId("string")
        .name("string")
        .retry(GroupRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .build());
    
    group_resource = akeyless.Group("groupResource",
        group_alias="string",
        user_assignment="string",
        description="string",
        group_id="string",
        name="string",
        retry={
            "error_message_regexes": ["string"],
            "interval_seconds": float(0),
            "max_interval_seconds": float(0),
            "max_retries": float(0),
            "retry_on_status_codes": [float(0)],
        })
    
    const groupResource = new akeyless.Group("groupResource", {
        groupAlias: "string",
        userAssignment: "string",
        description: "string",
        groupId: "string",
        name: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
    });
    
    type: akeyless:Group
    properties:
        description: string
        groupAlias: string
        groupId: string
        name: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        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
    Retry GroupRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    Retry GroupRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    group_alias string
    A short group alias
    user_assignment 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
    group_id string
    The ID of this resource.
    name string
    Group name
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    retry GroupRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    retry GroupRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    retry GroupRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.

    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 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,
            retry: Optional[GroupRetryArgs] = 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:  existingGroup:    type: akeyless:Group    get:      id: ${id}
    import {
      to = akeyless_group.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state GroupState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state GroupState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state GroupState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state GroupState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control 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
    Retry GroupRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    Retry GroupRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    group_alias string
    A short group alias
    group_id string
    The ID of this resource.
    name string
    Group name
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    user_assignment 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
    retry GroupRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    retry GroupRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    retry GroupRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    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.

    Supporting Types

    GroupRetry, GroupRetryArgs

    ErrorMessageRegexes List<string>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds double
    Maximum wait between retries, in seconds.
    MaxRetries double
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes List<double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    ErrorMessageRegexes []string
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds float64
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds float64
    Maximum wait between retries, in seconds.
    MaxRetries float64
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes []float64
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes list(string)
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds number
    Maximum wait between retries, in seconds.
    max_retries number
    Maximum number of retries after the first attempt.
    retry_on_status_codes list(number)
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Double
    Maximum wait between retries, in seconds.
    maxRetries Double
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes string[]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds number
    Maximum wait between retries, in seconds.
    maxRetries number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes number[]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes Sequence[str]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds float
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds float
    Maximum wait between retries, in seconds.
    max_retries float
    Maximum number of retries after the first attempt.
    retry_on_status_codes Sequence[float]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Number
    Maximum wait between retries, in seconds.
    maxRetries Number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Number>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial