1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. Role
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

    Role Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as akeyless from "@pulumi/akeyless";
    
    export = async () => {
        const apiKey = new akeyless.index.AuthMethod("api_key", {
            apiKey: [{}],
            path: "auth-method-api-key-demo",
        });
        const role = new akeyless.Role("role", {
            name: "demo-role",
            assocAuthMethods: [{
                amName: "auth-method-api-key-demo",
                subClaims: {
                    groups: "developers,readers",
                    users: "bob",
                },
            }],
            rules: [{
                capabilities: ["read"],
                path: "/*",
                ruleType: "auth-method-rule",
            }],
        }, {
            dependsOn: [apiKey],
        });
        const demo_role = akeyless.getRoleOutput({
            name: role.roleId,
        });
        return {
            "demo-role": demo_role,
        };
    }
    
    import pulumi
    import pulumi_akeyless as akeyless
    
    api_key = akeyless.index.AuthMethod("api_key",
        api_key=[{}],
        path=auth-method-api-key-demo)
    role = akeyless.Role("role",
        name="demo-role",
        assoc_auth_methods=[{
            "am_name": "auth-method-api-key-demo",
            "sub_claims": {
                "groups": "developers,readers",
                "users": "bob",
            },
        }],
        rules=[{
            "capabilities": ["read"],
            "path": "/*",
            "rule_type": "auth-method-rule",
        }],
        opts = pulumi.ResourceOptions(depends_on=[api_key]))
    demo_role = akeyless.get_role_output(name=role.role_id)
    pulumi.export("demo-role", demo_role)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/akeyless/v2/akeyless"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		apiKey, err := akeyless.NewAuthMethod(ctx, "api_key", &akeyless.AuthMethodArgs{
    			ApiKey: []map[string]interface{}{
    				map[string]interface{}{},
    			},
    			Path: "auth-method-api-key-demo",
    		})
    		if err != nil {
    			return err
    		}
    		role, err := akeyless.NewRole(ctx, "role", &akeyless.RoleArgs{
    			Name: pulumi.String("demo-role"),
    			AssocAuthMethods: akeyless.RoleAssocAuthMethodArray{
    				&akeyless.RoleAssocAuthMethodArgs{
    					AmName: pulumi.String("auth-method-api-key-demo"),
    					SubClaims: pulumi.StringMap{
    						"groups": pulumi.String("developers,readers"),
    						"users":  pulumi.String("bob"),
    					},
    				},
    			},
    			Rules: akeyless.RoleRuleArray{
    				&akeyless.RoleRuleArgs{
    					Capabilities: pulumi.StringArray{
    						pulumi.String("read"),
    					},
    					Path:     pulumi.String("/*"),
    					RuleType: pulumi.String("auth-method-rule"),
    				},
    			},
    		}, pulumi.DependsOn([]pulumi.Resource{
    			apiKey,
    		}))
    		if err != nil {
    			return err
    		}
    		demo_role := akeyless.LookupRoleOutput(ctx, akeyless.GetRoleOutputArgs{
    			Name: role.RoleId,
    		}, nil)
    		ctx.Export("demo-role", demo_role)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Akeyless = Pulumi.Akeyless;
    
    return await Deployment.RunAsync(() => 
    {
        var apiKey = new Akeyless.Index.AuthMethod("api_key", new()
        {
            ApiKey = new[]
            {
                null,
            },
            Path = "auth-method-api-key-demo",
        });
    
        var role = new Akeyless.Role("role", new()
        {
            Name = "demo-role",
            AssocAuthMethods = new[]
            {
                new Akeyless.Inputs.RoleAssocAuthMethodArgs
                {
                    AmName = "auth-method-api-key-demo",
                    SubClaims = 
                    {
                        { "groups", "developers,readers" },
                        { "users", "bob" },
                    },
                },
            },
            Rules = new[]
            {
                new Akeyless.Inputs.RoleRuleArgs
                {
                    Capabilities = new[]
                    {
                        "read",
                    },
                    Path = "/*",
                    RuleType = "auth-method-rule",
                },
            },
        }, new CustomResourceOptions
        {
            DependsOn =
            {
                apiKey,
            },
        });
    
        var demo_role = Akeyless.GetRole.Invoke(new()
        {
            Name = role.RoleId,
        });
    
        return new Dictionary<string, object?>
        {
            ["demo-role"] = demo_role,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.akeyless.AuthMethod;
    import com.pulumi.akeyless.AuthMethodArgs;
    import com.pulumi.akeyless.Role;
    import com.pulumi.akeyless.RoleArgs;
    import com.pulumi.akeyless.inputs.RoleAssocAuthMethodArgs;
    import com.pulumi.akeyless.inputs.RoleRuleArgs;
    import com.pulumi.akeyless.AkeylessFunctions;
    import com.pulumi.akeyless.inputs.GetRoleArgs;
    import com.pulumi.resources.CustomResourceOptions;
    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 apiKey = new AuthMethod("apiKey", AuthMethodArgs.builder()
                .apiKey(List.of(Map.ofEntries(
                )))
                .path("auth-method-api-key-demo")
                .build());
    
            var role = new Role("role", RoleArgs.builder()
                .name("demo-role")
                .assocAuthMethods(RoleAssocAuthMethodArgs.builder()
                    .amName("auth-method-api-key-demo")
                    .subClaims(Map.ofEntries(
                        Map.entry("groups", "developers,readers"),
                        Map.entry("users", "bob")
                    ))
                    .build())
                .rules(RoleRuleArgs.builder()
                    .capabilities("read")
                    .path("/*")
                    .ruleType("auth-method-rule")
                    .build())
                .build(), CustomResourceOptions.builder()
                    .dependsOn(apiKey)
                    .build());
    
            final var demo-role = AkeylessFunctions.getRole(GetRoleArgs.builder()
                .name(role.roleId())
                .build());
    
            ctx.export("demo-role", demo_role);
        }
    }
    
    resources:
      apiKey:
        type: akeyless:AuthMethod
        name: api_key
        properties:
          apiKey:
            - {}
          path: auth-method-api-key-demo
      role:
        type: akeyless:Role
        properties:
          name: demo-role
          assocAuthMethods:
            - amName: auth-method-api-key-demo
              subClaims:
                groups: developers,readers
                users: bob
          rules:
            - capabilities:
                - read
              path: /*
              ruleType: auth-method-rule
        options:
          dependsOn:
            - ${apiKey}
    variables:
      demo-role:
        fn::invoke:
          function: akeyless:getRole
          arguments:
            name: ${role.roleId}
    outputs:
      demo-role: ${["demo-role"]}
    
    Example coming soon!
    

    Create Role Resource

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

    Constructor syntax

    new Role(name: string, args?: RoleArgs, opts?: CustomResourceOptions);
    @overload
    def Role(resource_name: str,
             args: Optional[RoleArgs] = None,
             opts: Optional[ResourceOptions] = None)
    
    @overload
    def Role(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             analytics_access: Optional[str] = None,
             approve_access_request: Optional[str] = None,
             assoc_auth_methods: Optional[Sequence[RoleAssocAuthMethodArgs]] = None,
             audit_access: Optional[str] = None,
             delete_protection: Optional[str] = None,
             description: Optional[str] = None,
             event_center_access: Optional[str] = None,
             event_forwarders_access: Optional[str] = None,
             event_forwarders_names: Optional[Sequence[str]] = None,
             gw_analytics_access: Optional[str] = None,
             isi_access: Optional[str] = None,
             name: Optional[str] = None,
             retry: Optional[RoleRetryArgs] = None,
             reverse_rbac_access: Optional[str] = None,
             role_id: Optional[str] = None,
             rules: Optional[Sequence[RoleRuleArgs]] = None,
             sra_reports_access: Optional[str] = None,
             unlock_secrets: Optional[str] = None,
             usage_reports_access: Optional[str] = None)
    func NewRole(ctx *Context, name string, args *RoleArgs, opts ...ResourceOption) (*Role, error)
    public Role(string name, RoleArgs? args = null, CustomResourceOptions? opts = null)
    public Role(String name, RoleArgs args)
    public Role(String name, RoleArgs args, CustomResourceOptions options)
    
    type: akeyless:Role
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_role" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args RoleArgs
    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 RoleArgs
    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 RoleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args RoleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args RoleArgs
    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 roleResource = new Akeyless.Role("roleResource", new()
    {
        AnalyticsAccess = "string",
        ApproveAccessRequest = "string",
        AuditAccess = "string",
        DeleteProtection = "string",
        Description = "string",
        EventCenterAccess = "string",
        EventForwardersAccess = "string",
        EventForwardersNames = new[]
        {
            "string",
        },
        GwAnalyticsAccess = "string",
        IsiAccess = "string",
        Name = "string",
        Retry = new Akeyless.Inputs.RoleRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
        ReverseRbacAccess = "string",
        RoleId = "string",
        Rules = new[]
        {
            new Akeyless.Inputs.RoleRuleArgs
            {
                Capabilities = new[]
                {
                    "string",
                },
                Path = "string",
                RuleType = "string",
            },
        },
        SraReportsAccess = "string",
        UnlockSecrets = "string",
        UsageReportsAccess = "string",
    });
    
    example, err := akeyless.NewRole(ctx, "roleResource", &akeyless.RoleArgs{
    	AnalyticsAccess:       pulumi.String("string"),
    	ApproveAccessRequest:  pulumi.String("string"),
    	AuditAccess:           pulumi.String("string"),
    	DeleteProtection:      pulumi.String("string"),
    	Description:           pulumi.String("string"),
    	EventCenterAccess:     pulumi.String("string"),
    	EventForwardersAccess: pulumi.String("string"),
    	EventForwardersNames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	GwAnalyticsAccess: pulumi.String("string"),
    	IsiAccess:         pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Retry: &akeyless.RoleRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    	ReverseRbacAccess: pulumi.String("string"),
    	RoleId:            pulumi.String("string"),
    	Rules: akeyless.RoleRuleArray{
    		&akeyless.RoleRuleArgs{
    			Capabilities: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			Path:     pulumi.String("string"),
    			RuleType: pulumi.String("string"),
    		},
    	},
    	SraReportsAccess:   pulumi.String("string"),
    	UnlockSecrets:      pulumi.String("string"),
    	UsageReportsAccess: pulumi.String("string"),
    })
    
    resource "akeyless_role" "roleResource" {
      lifecycle {
        create_before_destroy = true
      }
      analytics_access        = "string"
      approve_access_request  = "string"
      audit_access            = "string"
      delete_protection       = "string"
      description             = "string"
      event_center_access     = "string"
      event_forwarders_access = "string"
      event_forwarders_names  = ["string"]
      gw_analytics_access     = "string"
      isi_access              = "string"
      name                    = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
      reverse_rbac_access = "string"
      role_id             = "string"
      rules {
        capabilities = ["string"]
        path         = "string"
        rule_type    = "string"
      }
      sra_reports_access   = "string"
      unlock_secrets       = "string"
      usage_reports_access = "string"
    }
    
    var roleResource = new Role("roleResource", RoleArgs.builder()
        .analyticsAccess("string")
        .approveAccessRequest("string")
        .auditAccess("string")
        .deleteProtection("string")
        .description("string")
        .eventCenterAccess("string")
        .eventForwardersAccess("string")
        .eventForwardersNames("string")
        .gwAnalyticsAccess("string")
        .isiAccess("string")
        .name("string")
        .retry(RoleRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .reverseRbacAccess("string")
        .roleId("string")
        .rules(RoleRuleArgs.builder()
            .capabilities("string")
            .path("string")
            .ruleType("string")
            .build())
        .sraReportsAccess("string")
        .unlockSecrets("string")
        .usageReportsAccess("string")
        .build());
    
    role_resource = akeyless.Role("roleResource",
        analytics_access="string",
        approve_access_request="string",
        audit_access="string",
        delete_protection="string",
        description="string",
        event_center_access="string",
        event_forwarders_access="string",
        event_forwarders_names=["string"],
        gw_analytics_access="string",
        isi_access="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)],
        },
        reverse_rbac_access="string",
        role_id="string",
        rules=[{
            "capabilities": ["string"],
            "path": "string",
            "rule_type": "string",
        }],
        sra_reports_access="string",
        unlock_secrets="string",
        usage_reports_access="string")
    
    const roleResource = new akeyless.Role("roleResource", {
        analyticsAccess: "string",
        approveAccessRequest: "string",
        auditAccess: "string",
        deleteProtection: "string",
        description: "string",
        eventCenterAccess: "string",
        eventForwardersAccess: "string",
        eventForwardersNames: ["string"],
        gwAnalyticsAccess: "string",
        isiAccess: "string",
        name: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
        reverseRbacAccess: "string",
        roleId: "string",
        rules: [{
            capabilities: ["string"],
            path: "string",
            ruleType: "string",
        }],
        sraReportsAccess: "string",
        unlockSecrets: "string",
        usageReportsAccess: "string",
    });
    
    type: akeyless:Role
    properties:
        analyticsAccess: string
        approveAccessRequest: string
        auditAccess: string
        deleteProtection: string
        description: string
        eventCenterAccess: string
        eventForwardersAccess: string
        eventForwardersNames:
            - string
        gwAnalyticsAccess: string
        isiAccess: string
        name: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        reverseRbacAccess: string
        roleId: string
        rules:
            - capabilities:
                - string
              path: string
              ruleType: string
        sraReportsAccess: string
        unlockSecrets: string
        usageReportsAccess: string
    

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

    AnalyticsAccess string
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    ApproveAccessRequest string
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    AssocAuthMethods List<RoleAssocAuthMethod>
    Create an association between role and auth method

    Deprecated: Deprecated

    AuditAccess string
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    EventCenterAccess string
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    EventForwardersAccess string
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    EventForwardersNames List<string>
    Allow this role to manage the following Event Forwarders.
    GwAnalyticsAccess string
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    IsiAccess string
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    Name string
    Role name
    Retry RoleRetry
    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.
    ReverseRbacAccess string
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    RoleId string
    The ID of this resource.
    Rules List<RoleRule>
    Set a rule to a role
    SraReportsAccess string
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    UnlockSecrets string
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    UsageReportsAccess string
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    AnalyticsAccess string
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    ApproveAccessRequest string
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    AssocAuthMethods []RoleAssocAuthMethodArgs
    Create an association between role and auth method

    Deprecated: Deprecated

    AuditAccess string
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    EventCenterAccess string
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    EventForwardersAccess string
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    EventForwardersNames []string
    Allow this role to manage the following Event Forwarders.
    GwAnalyticsAccess string
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    IsiAccess string
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    Name string
    Role name
    Retry RoleRetryArgs
    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.
    ReverseRbacAccess string
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    RoleId string
    The ID of this resource.
    Rules []RoleRuleArgs
    Set a rule to a role
    SraReportsAccess string
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    UnlockSecrets string
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    UsageReportsAccess string
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analytics_access string
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approve_access_request string
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assoc_auth_methods list(object)
    Create an association between role and auth method

    Deprecated: Deprecated

    audit_access string
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    event_center_access string
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    event_forwarders_access string
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    event_forwarders_names list(string)
    Allow this role to manage the following Event Forwarders.
    gw_analytics_access string
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isi_access string
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name string
    Role 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.
    reverse_rbac_access string
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    role_id string
    The ID of this resource.
    rules list(object)
    Set a rule to a role
    sra_reports_access string
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlock_secrets string
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usage_reports_access string
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analyticsAccess String
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approveAccessRequest String
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assocAuthMethods List<RoleAssocAuthMethod>
    Create an association between role and auth method

    Deprecated: Deprecated

    auditAccess String
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    eventCenterAccess String
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    eventForwardersAccess String
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    eventForwardersNames List<String>
    Allow this role to manage the following Event Forwarders.
    gwAnalyticsAccess String
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isiAccess String
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name String
    Role name
    retry RoleRetry
    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.
    reverseRbacAccess String
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    roleId String
    The ID of this resource.
    rules List<RoleRule>
    Set a rule to a role
    sraReportsAccess String
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlockSecrets String
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usageReportsAccess String
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analyticsAccess string
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approveAccessRequest string
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assocAuthMethods RoleAssocAuthMethod[]
    Create an association between role and auth method

    Deprecated: Deprecated

    auditAccess string
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    eventCenterAccess string
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    eventForwardersAccess string
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    eventForwardersNames string[]
    Allow this role to manage the following Event Forwarders.
    gwAnalyticsAccess string
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isiAccess string
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name string
    Role name
    retry RoleRetry
    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.
    reverseRbacAccess string
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    roleId string
    The ID of this resource.
    rules RoleRule[]
    Set a rule to a role
    sraReportsAccess string
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlockSecrets string
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usageReportsAccess string
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analytics_access str
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approve_access_request str
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assoc_auth_methods Sequence[RoleAssocAuthMethodArgs]
    Create an association between role and auth method

    Deprecated: Deprecated

    audit_access str
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    event_center_access str
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    event_forwarders_access str
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    event_forwarders_names Sequence[str]
    Allow this role to manage the following Event Forwarders.
    gw_analytics_access str
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isi_access str
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name str
    Role name
    retry RoleRetryArgs
    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.
    reverse_rbac_access str
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    role_id str
    The ID of this resource.
    rules Sequence[RoleRuleArgs]
    Set a rule to a role
    sra_reports_access str
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlock_secrets str
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usage_reports_access str
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analyticsAccess String
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approveAccessRequest String
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assocAuthMethods List<Property Map>
    Create an association between role and auth method

    Deprecated: Deprecated

    auditAccess String
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    eventCenterAccess String
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    eventForwardersAccess String
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    eventForwardersNames List<String>
    Allow this role to manage the following Event Forwarders.
    gwAnalyticsAccess String
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isiAccess String
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name String
    Role 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.
    reverseRbacAccess String
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    roleId String
    The ID of this resource.
    rules List<Property Map>
    Set a rule to a role
    sraReportsAccess String
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlockSecrets String
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usageReportsAccess String
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Role resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    RestrictedRules List<RoleRestrictedRule>
    Id string
    The provider-assigned unique ID for this managed resource.
    RestrictedRules []RoleRestrictedRule
    id string
    The provider-assigned unique ID for this managed resource.
    restricted_rules list(object)
    id String
    The provider-assigned unique ID for this managed resource.
    restrictedRules List<RoleRestrictedRule>
    id string
    The provider-assigned unique ID for this managed resource.
    restrictedRules RoleRestrictedRule[]
    id str
    The provider-assigned unique ID for this managed resource.
    restricted_rules Sequence[RoleRestrictedRule]
    id String
    The provider-assigned unique ID for this managed resource.
    restrictedRules List<Property Map>

    Look up Existing Role Resource

    Get an existing Role 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?: RoleState, opts?: CustomResourceOptions): Role
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            analytics_access: Optional[str] = None,
            approve_access_request: Optional[str] = None,
            assoc_auth_methods: Optional[Sequence[RoleAssocAuthMethodArgs]] = None,
            audit_access: Optional[str] = None,
            delete_protection: Optional[str] = None,
            description: Optional[str] = None,
            event_center_access: Optional[str] = None,
            event_forwarders_access: Optional[str] = None,
            event_forwarders_names: Optional[Sequence[str]] = None,
            gw_analytics_access: Optional[str] = None,
            isi_access: Optional[str] = None,
            name: Optional[str] = None,
            restricted_rules: Optional[Sequence[RoleRestrictedRuleArgs]] = None,
            retry: Optional[RoleRetryArgs] = None,
            reverse_rbac_access: Optional[str] = None,
            role_id: Optional[str] = None,
            rules: Optional[Sequence[RoleRuleArgs]] = None,
            sra_reports_access: Optional[str] = None,
            unlock_secrets: Optional[str] = None,
            usage_reports_access: Optional[str] = None) -> Role
    func GetRole(ctx *Context, name string, id IDInput, state *RoleState, opts ...ResourceOption) (*Role, error)
    public static Role Get(string name, Input<string> id, RoleState? state, CustomResourceOptions? opts = null)
    public static Role get(String name, Output<String> id, RoleState state, CustomResourceOptions options)
    resources:  existingRole:    type: akeyless:Role    get:      id: ${id}
    import {
      to = akeyless_role.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 RoleState
    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 RoleState
    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 RoleState
    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 RoleState
    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:
    AnalyticsAccess string
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    ApproveAccessRequest string
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    AssocAuthMethods List<RoleAssocAuthMethod>
    Create an association between role and auth method

    Deprecated: Deprecated

    AuditAccess string
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    EventCenterAccess string
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    EventForwardersAccess string
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    EventForwardersNames List<string>
    Allow this role to manage the following Event Forwarders.
    GwAnalyticsAccess string
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    IsiAccess string
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    Name string
    Role name
    RestrictedRules List<RoleRestrictedRule>
    Retry RoleRetry
    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.
    ReverseRbacAccess string
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    RoleId string
    The ID of this resource.
    Rules List<RoleRule>
    Set a rule to a role
    SraReportsAccess string
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    UnlockSecrets string
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    UsageReportsAccess string
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    AnalyticsAccess string
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    ApproveAccessRequest string
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    AssocAuthMethods []RoleAssocAuthMethodArgs
    Create an association between role and auth method

    Deprecated: Deprecated

    AuditAccess string
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    EventCenterAccess string
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    EventForwardersAccess string
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    EventForwardersNames []string
    Allow this role to manage the following Event Forwarders.
    GwAnalyticsAccess string
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    IsiAccess string
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    Name string
    Role name
    RestrictedRules []RoleRestrictedRuleArgs
    Retry RoleRetryArgs
    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.
    ReverseRbacAccess string
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    RoleId string
    The ID of this resource.
    Rules []RoleRuleArgs
    Set a rule to a role
    SraReportsAccess string
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    UnlockSecrets string
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    UsageReportsAccess string
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analytics_access string
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approve_access_request string
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assoc_auth_methods list(object)
    Create an association between role and auth method

    Deprecated: Deprecated

    audit_access string
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    event_center_access string
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    event_forwarders_access string
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    event_forwarders_names list(string)
    Allow this role to manage the following Event Forwarders.
    gw_analytics_access string
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isi_access string
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name string
    Role name
    restricted_rules list(object)
    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.
    reverse_rbac_access string
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    role_id string
    The ID of this resource.
    rules list(object)
    Set a rule to a role
    sra_reports_access string
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlock_secrets string
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usage_reports_access string
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analyticsAccess String
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approveAccessRequest String
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assocAuthMethods List<RoleAssocAuthMethod>
    Create an association between role and auth method

    Deprecated: Deprecated

    auditAccess String
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    eventCenterAccess String
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    eventForwardersAccess String
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    eventForwardersNames List<String>
    Allow this role to manage the following Event Forwarders.
    gwAnalyticsAccess String
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isiAccess String
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name String
    Role name
    restrictedRules List<RoleRestrictedRule>
    retry RoleRetry
    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.
    reverseRbacAccess String
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    roleId String
    The ID of this resource.
    rules List<RoleRule>
    Set a rule to a role
    sraReportsAccess String
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlockSecrets String
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usageReportsAccess String
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analyticsAccess string
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approveAccessRequest string
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assocAuthMethods RoleAssocAuthMethod[]
    Create an association between role and auth method

    Deprecated: Deprecated

    auditAccess string
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    eventCenterAccess string
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    eventForwardersAccess string
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    eventForwardersNames string[]
    Allow this role to manage the following Event Forwarders.
    gwAnalyticsAccess string
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isiAccess string
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name string
    Role name
    restrictedRules RoleRestrictedRule[]
    retry RoleRetry
    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.
    reverseRbacAccess string
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    roleId string
    The ID of this resource.
    rules RoleRule[]
    Set a rule to a role
    sraReportsAccess string
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlockSecrets string
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usageReportsAccess string
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analytics_access str
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approve_access_request str
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assoc_auth_methods Sequence[RoleAssocAuthMethodArgs]
    Create an association between role and auth method

    Deprecated: Deprecated

    audit_access str
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    event_center_access str
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    event_forwarders_access str
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    event_forwarders_names Sequence[str]
    Allow this role to manage the following Event Forwarders.
    gw_analytics_access str
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isi_access str
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name str
    Role name
    restricted_rules Sequence[RoleRestrictedRuleArgs]
    retry RoleRetryArgs
    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.
    reverse_rbac_access str
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    role_id str
    The ID of this resource.
    rules Sequence[RoleRuleArgs]
    Set a rule to a role
    sra_reports_access str
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlock_secrets str
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usage_reports_access str
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.
    analyticsAccess String
    Allow this role to view analytics. Currently only 'none', 'own' and 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    approveAccessRequest String
    Allow this role to approve Access Requests for items. Currently only 'none', 'scoped' and 'all' values are supported.
    assocAuthMethods List<Property Map>
    Create an association between role and auth method

    Deprecated: Deprecated

    auditAccess String
    Allow this role to view audit logs. Currently only 'none', 'own', 'scoped' and 'all' values are supported, allowing associated auth methods to view audit logs produced by the same auth methods.
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    eventCenterAccess String
    Allow this role to view Event Center. Currently only 'none', 'scoped' and 'all' values are supported.
    eventForwardersAccess String
    Allow this role to manage Event Forwarders. Currently only 'none' and 'all' values are supported.
    eventForwardersNames List<String>
    Allow this role to manage the following Event Forwarders.
    gwAnalyticsAccess String
    Allow this role to view gw analytics. Currently only 'none', 'scoped', 'all' values are supported, allowing associated auth methods to view reports produced by the same auth methods.
    isiAccess String
    Allow this role to access Identity & Secrets Intelligence. Currently only 'none', 'scoped' and 'all' values are supported.
    name String
    Role name
    restrictedRules List<Property Map>
    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.
    reverseRbacAccess String
    Allow this role to view Reverse RBAC. Supported values: 'scoped', 'all'.
    roleId String
    The ID of this resource.
    rules List<Property Map>
    Set a rule to a role
    sraReportsAccess String
    Allow this role to view SRA Clusters. Currently only 'none', 'scoped', 'all' values are supported.
    unlockSecrets String
    Allow this role to force-unlock locked secrets. Currently only 'none', 'scoped' and 'all' values are supported.
    usageReportsAccess String
    Allow this role to view Usage Report. Currently only 'none' and 'all' values are supported.

    Supporting Types

    RoleAssocAuthMethod, RoleAssocAuthMethodArgs

    AmName string
    The auth method to associate
    AccessId string
    The access ID of the auth method
    AssocId string
    The association ID
    CaseSensitive string
    Treat sub claims as case-sensitive
    SubClaims Dictionary<string, string>
    key/val of sub claims, e.g group=admins,developers
    AmName string
    The auth method to associate
    AccessId string
    The access ID of the auth method
    AssocId string
    The association ID
    CaseSensitive string
    Treat sub claims as case-sensitive
    SubClaims map[string]string
    key/val of sub claims, e.g group=admins,developers
    am_name string
    The auth method to associate
    access_id string
    The access ID of the auth method
    assoc_id string
    The association ID
    case_sensitive string
    Treat sub claims as case-sensitive
    sub_claims map(string)
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    accessId String
    The access ID of the auth method
    assocId String
    The association ID
    caseSensitive String
    Treat sub claims as case-sensitive
    subClaims Map<String,String>
    key/val of sub claims, e.g group=admins,developers
    amName string
    The auth method to associate
    accessId string
    The access ID of the auth method
    assocId string
    The association ID
    caseSensitive string
    Treat sub claims as case-sensitive
    subClaims {[key: string]: string}
    key/val of sub claims, e.g group=admins,developers
    am_name str
    The auth method to associate
    access_id str
    The access ID of the auth method
    assoc_id str
    The association ID
    case_sensitive str
    Treat sub claims as case-sensitive
    sub_claims Mapping[str, str]
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    accessId String
    The access ID of the auth method
    assocId String
    The association ID
    caseSensitive String
    Treat sub claims as case-sensitive
    subClaims Map<String>
    key/val of sub claims, e.g group=admins,developers

    RoleRestrictedRule, RoleRestrictedRuleArgs

    Capabilities List<string>
    Path string
    RuleType string
    Capabilities []string
    Path string
    RuleType string
    capabilities list(string)
    path string
    rule_type string
    capabilities List<String>
    path String
    ruleType String
    capabilities string[]
    path string
    ruleType string
    capabilities Sequence[str]
    path str
    rule_type str
    capabilities List<String>
    path String
    ruleType String

    RoleRetry, RoleRetryArgs

    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.

    RoleRule, RoleRuleArgs

    Capabilities List<string>
    List of the approved/denied capabilities in the path options: [read, create, update, delete, list, deny] for sra-rule type: [allowaccess, requestaccess, justifyaccessonly, approvalauthority, uploadfiles, download_files]
    Path string
    The path the rule refers to
    RuleType string
    item-rule, target-rule, role-rule, auth-method-rule, sra-rule
    Capabilities []string
    List of the approved/denied capabilities in the path options: [read, create, update, delete, list, deny] for sra-rule type: [allowaccess, requestaccess, justifyaccessonly, approvalauthority, uploadfiles, download_files]
    Path string
    The path the rule refers to
    RuleType string
    item-rule, target-rule, role-rule, auth-method-rule, sra-rule
    capabilities list(string)
    List of the approved/denied capabilities in the path options: [read, create, update, delete, list, deny] for sra-rule type: [allowaccess, requestaccess, justifyaccessonly, approvalauthority, uploadfiles, download_files]
    path string
    The path the rule refers to
    rule_type string
    item-rule, target-rule, role-rule, auth-method-rule, sra-rule
    capabilities List<String>
    List of the approved/denied capabilities in the path options: [read, create, update, delete, list, deny] for sra-rule type: [allowaccess, requestaccess, justifyaccessonly, approvalauthority, uploadfiles, download_files]
    path String
    The path the rule refers to
    ruleType String
    item-rule, target-rule, role-rule, auth-method-rule, sra-rule
    capabilities string[]
    List of the approved/denied capabilities in the path options: [read, create, update, delete, list, deny] for sra-rule type: [allowaccess, requestaccess, justifyaccessonly, approvalauthority, uploadfiles, download_files]
    path string
    The path the rule refers to
    ruleType string
    item-rule, target-rule, role-rule, auth-method-rule, sra-rule
    capabilities Sequence[str]
    List of the approved/denied capabilities in the path options: [read, create, update, delete, list, deny] for sra-rule type: [allowaccess, requestaccess, justifyaccessonly, approvalauthority, uploadfiles, download_files]
    path str
    The path the rule refers to
    rule_type str
    item-rule, target-rule, role-rule, auth-method-rule, sra-rule
    capabilities List<String>
    List of the approved/denied capabilities in the path options: [read, create, update, delete, list, deny] for sra-rule type: [allowaccess, requestaccess, justifyaccessonly, approvalauthority, uploadfiles, download_files]
    path String
    The path the rule refers to
    ruleType String
    item-rule, target-rule, role-rule, auth-method-rule, sra-rule

    Import

    $ pulumi import akeyless:index/role:Role example /full-role-path/and-name-in-akeyless
    

    To learn more about importing existing cloud resources, see Importing resources.

    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