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

akeyless.getRole

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

    Role data source

    Example Usage

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

const demo_role = akeyless.getRole({
    name: "terraform/demo-role",
});

    import pulumi
import pulumi_akeyless as akeyless

demo_role = akeyless.get_role(name="terraform/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 {
		_, err := akeyless.LookupRole(ctx, &akeyless.LookupRoleArgs{
			Name: "terraform/demo-role",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Akeyless = Pulumi.Akeyless;

return await Deployment.RunAsync(() => 
{
    var demo_role = Akeyless.GetRole.Invoke(new()
    {
        Name = "terraform/demo-role",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.akeyless.AkeylessFunctions;
import com.pulumi.akeyless.inputs.GetRoleArgs;
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) {
        final var demo-role = AkeylessFunctions.getRole(GetRoleArgs.builder()
            .name("terraform/demo-role")
            .build());

    }
}

    variables:
  demo-role:
    fn::invoke:
      function: akeyless:getRole
      arguments:
        name: terraform/demo-role

    Using getRole

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getRole(args: GetRoleArgs, opts?: InvokeOptions): Promise<GetRoleResult>
function getRoleOutput(args: GetRoleOutputArgs, opts?: InvokeOptions): Output<GetRoleResult>
    def get_role(id: Optional[str] = None,
             name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetRoleResult
def get_role_output(id: pulumi.Input[Optional[str]] = None,
             name: pulumi.Input[Optional[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetRoleResult]
    func LookupRole(ctx *Context, args *LookupRoleArgs, opts ...InvokeOption) (*LookupRoleResult, error)
func LookupRoleOutput(ctx *Context, args *LookupRoleOutputArgs, opts ...InvokeOption) LookupRoleResultOutput

    > Note: This function is named LookupRole in the Go SDK.

    public static class GetRole 
{
    public static Task<GetRoleResult> InvokeAsync(GetRoleArgs args, InvokeOptions? opts = null)
    public static Output<GetRoleResult> Invoke(GetRoleInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)
public static Output<GetRoleResult> getRole(GetRoleArgs args, InvokeOptions options)

    fn::invoke:
  function: akeyless:index/getRole:getRole
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    The Role name
    Id string
    The ID of this resource.
    Name string
    The Role name
    Id string
    The ID of this resource.
    name String
    The Role name
    id String
    The ID of this resource.
    name string
    The Role name
    id string
    The ID of this resource.
    name str
    The Role name
    id str
    The ID of this resource.
    name String
    The Role name
    id String
    The ID of this resource.

    getRole Result

    The following output properties are available:

    AccessDate string
    Access date of the role
    AccessDateDisplay string
    Access date display format
    AssocAuthMethodWithRules string
    Association between auth method and role with rules (JSON format)
    ClientPermissions List<string>
    Client permissions associated with the role
    CreationDate string
    Creation date of the role
    DeleteProtection bool
    Protection from accidental deletion
    Description string
    Description of the role
    Id string
    The ID of this resource.
    ModificationDate string
    Last modification date of the role
    Name string
    The Role name
    RoleAuthMethodsAssoc string
    Role auth methods association (JSON format)
    RoleId double
    Role ID
    RoleName string
    Role name
    Rules string
    Role rules (JSON format)
    AccessDate string
    Access date of the role
    AccessDateDisplay string
    Access date display format
    AssocAuthMethodWithRules string
    Association between auth method and role with rules (JSON format)
    ClientPermissions []string
    Client permissions associated with the role
    CreationDate string
    Creation date of the role
    DeleteProtection bool
    Protection from accidental deletion
    Description string
    Description of the role
    Id string
    The ID of this resource.
    ModificationDate string
    Last modification date of the role
    Name string
    The Role name
    RoleAuthMethodsAssoc string
    Role auth methods association (JSON format)
    RoleId float64
    Role ID
    RoleName string
    Role name
    Rules string
    Role rules (JSON format)
    accessDate String
    Access date of the role
    accessDateDisplay String
    Access date display format
    assocAuthMethodWithRules String
    Association between auth method and role with rules (JSON format)
    clientPermissions List<String>
    Client permissions associated with the role
    creationDate String
    Creation date of the role
    deleteProtection Boolean
    Protection from accidental deletion
    description String
    Description of the role
    id String
    The ID of this resource.
    modificationDate String
    Last modification date of the role
    name String
    The Role name
    roleAuthMethodsAssoc String
    Role auth methods association (JSON format)
    roleId Double
    Role ID
    roleName String
    Role name
    rules String
    Role rules (JSON format)
    accessDate string
    Access date of the role
    accessDateDisplay string
    Access date display format
    assocAuthMethodWithRules string
    Association between auth method and role with rules (JSON format)
    clientPermissions string[]
    Client permissions associated with the role
    creationDate string
    Creation date of the role
    deleteProtection boolean
    Protection from accidental deletion
    description string
    Description of the role
    id string
    The ID of this resource.
    modificationDate string
    Last modification date of the role
    name string
    The Role name
    roleAuthMethodsAssoc string
    Role auth methods association (JSON format)
    roleId number
    Role ID
    roleName string
    Role name
    rules string
    Role rules (JSON format)
    access_date str
    Access date of the role
    access_date_display str
    Access date display format
    assoc_auth_method_with_rules str
    Association between auth method and role with rules (JSON format)
    client_permissions Sequence[str]
    Client permissions associated with the role
    creation_date str
    Creation date of the role
    delete_protection bool
    Protection from accidental deletion
    description str
    Description of the role
    id str
    The ID of this resource.
    modification_date str
    Last modification date of the role
    name str
    The Role name
    role_auth_methods_assoc str
    Role auth methods association (JSON format)
    role_id float
    Role ID
    role_name str
    Role name
    rules str
    Role rules (JSON format)
    accessDate String
    Access date of the role
    accessDateDisplay String
    Access date display format
    assocAuthMethodWithRules String
    Association between auth method and role with rules (JSON format)
    clientPermissions List<String>
    Client permissions associated with the role
    creationDate String
    Creation date of the role
    deleteProtection Boolean
    Protection from accidental deletion
    description String
    Description of the role
    id String
    The ID of this resource.
    modificationDate String
    Last modification date of the role
    name String
    The Role name
    roleAuthMethodsAssoc String
    Role auth methods association (JSON format)
    roleId Number
    Role ID
    roleName String
    Role name
    rules String
    Role rules (JSON format)

    Package Details

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