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

    Association between role and auth method

    Create AssociateRoleAuthMethod Resource

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

    Constructor syntax

    new AssociateRoleAuthMethod(name: string, args: AssociateRoleAuthMethodArgs, opts?: CustomResourceOptions);
    @overload
    def AssociateRoleAuthMethod(resource_name: str,
                                args: AssociateRoleAuthMethodArgs,
                                opts: Optional[ResourceOptions] = None)
    
    @overload
    def AssociateRoleAuthMethod(resource_name: str,
                                opts: Optional[ResourceOptions] = None,
                                am_name: Optional[str] = None,
                                role_name: Optional[str] = None,
                                associate_role_auth_method_id: Optional[str] = None,
                                case_sensitive: Optional[str] = None,
                                retry: Optional[AssociateRoleAuthMethodRetryArgs] = None,
                                sub_claims: Optional[Mapping[str, str]] = None)
    func NewAssociateRoleAuthMethod(ctx *Context, name string, args AssociateRoleAuthMethodArgs, opts ...ResourceOption) (*AssociateRoleAuthMethod, error)
    public AssociateRoleAuthMethod(string name, AssociateRoleAuthMethodArgs args, CustomResourceOptions? opts = null)
    public AssociateRoleAuthMethod(String name, AssociateRoleAuthMethodArgs args)
    public AssociateRoleAuthMethod(String name, AssociateRoleAuthMethodArgs args, CustomResourceOptions options)
    
    type: akeyless:AssociateRoleAuthMethod
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_associate_role_auth_method" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AssociateRoleAuthMethodArgs
    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 AssociateRoleAuthMethodArgs
    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 AssociateRoleAuthMethodArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AssociateRoleAuthMethodArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AssociateRoleAuthMethodArgs
    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 associateRoleAuthMethodResource = new Akeyless.AssociateRoleAuthMethod("associateRoleAuthMethodResource", new()
    {
        AmName = "string",
        RoleName = "string",
        AssociateRoleAuthMethodId = "string",
        CaseSensitive = "string",
        Retry = new Akeyless.Inputs.AssociateRoleAuthMethodRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
        SubClaims = 
        {
            { "string", "string" },
        },
    });
    
    example, err := akeyless.NewAssociateRoleAuthMethod(ctx, "associateRoleAuthMethodResource", &akeyless.AssociateRoleAuthMethodArgs{
    	AmName:                    pulumi.String("string"),
    	RoleName:                  pulumi.String("string"),
    	AssociateRoleAuthMethodId: pulumi.String("string"),
    	CaseSensitive:             pulumi.String("string"),
    	Retry: &akeyless.AssociateRoleAuthMethodRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    	SubClaims: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    resource "akeyless_associate_role_auth_method" "associateRoleAuthMethodResource" {
      lifecycle {
        create_before_destroy = true
      }
      am_name                       = "string"
      role_name                     = "string"
      associate_role_auth_method_id = "string"
      case_sensitive                = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
      sub_claims = {
        "string" = "string"
      }
    }
    
    var associateRoleAuthMethodResource = new AssociateRoleAuthMethod("associateRoleAuthMethodResource", AssociateRoleAuthMethodArgs.builder()
        .amName("string")
        .roleName("string")
        .associateRoleAuthMethodId("string")
        .caseSensitive("string")
        .retry(AssociateRoleAuthMethodRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .subClaims(Map.of("string", "string"))
        .build());
    
    associate_role_auth_method_resource = akeyless.AssociateRoleAuthMethod("associateRoleAuthMethodResource",
        am_name="string",
        role_name="string",
        associate_role_auth_method_id="string",
        case_sensitive="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)],
        },
        sub_claims={
            "string": "string",
        })
    
    const associateRoleAuthMethodResource = new akeyless.AssociateRoleAuthMethod("associateRoleAuthMethodResource", {
        amName: "string",
        roleName: "string",
        associateRoleAuthMethodId: "string",
        caseSensitive: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
        subClaims: {
            string: "string",
        },
    });
    
    type: akeyless:AssociateRoleAuthMethod
    properties:
        amName: string
        associateRoleAuthMethodId: string
        caseSensitive: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        roleName: string
        subClaims:
            string: string
    

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

    AmName string
    The auth method to associate
    RoleName string
    The role to associate
    AssociateRoleAuthMethodId string
    The ID of this resource.
    CaseSensitive string
    Treat sub claims as case-sensitive
    Retry AssociateRoleAuthMethodRetry
    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.
    SubClaims Dictionary<string, string>
    key/val of sub claims, e.g group=admins,developers
    AmName string
    The auth method to associate
    RoleName string
    The role to associate
    AssociateRoleAuthMethodId string
    The ID of this resource.
    CaseSensitive string
    Treat sub claims as case-sensitive
    Retry AssociateRoleAuthMethodRetryArgs
    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.
    SubClaims map[string]string
    key/val of sub claims, e.g group=admins,developers
    am_name string
    The auth method to associate
    role_name string
    The role to associate
    associate_role_auth_method_id string
    The ID of this resource.
    case_sensitive string
    Treat sub claims as case-sensitive
    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.
    sub_claims map(string)
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    roleName String
    The role to associate
    associateRoleAuthMethodId String
    The ID of this resource.
    caseSensitive String
    Treat sub claims as case-sensitive
    retry AssociateRoleAuthMethodRetry
    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.
    subClaims Map<String,String>
    key/val of sub claims, e.g group=admins,developers
    amName string
    The auth method to associate
    roleName string
    The role to associate
    associateRoleAuthMethodId string
    The ID of this resource.
    caseSensitive string
    Treat sub claims as case-sensitive
    retry AssociateRoleAuthMethodRetry
    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.
    subClaims {[key: string]: string}
    key/val of sub claims, e.g group=admins,developers
    am_name str
    The auth method to associate
    role_name str
    The role to associate
    associate_role_auth_method_id str
    The ID of this resource.
    case_sensitive str
    Treat sub claims as case-sensitive
    retry AssociateRoleAuthMethodRetryArgs
    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.
    sub_claims Mapping[str, str]
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    roleName String
    The role to associate
    associateRoleAuthMethodId String
    The ID of this resource.
    caseSensitive String
    Treat sub claims as case-sensitive
    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.
    subClaims Map<String>
    key/val of sub claims, e.g group=admins,developers

    Outputs

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

    Get an existing AssociateRoleAuthMethod 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?: AssociateRoleAuthMethodState, opts?: CustomResourceOptions): AssociateRoleAuthMethod
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            am_name: Optional[str] = None,
            associate_role_auth_method_id: Optional[str] = None,
            case_sensitive: Optional[str] = None,
            retry: Optional[AssociateRoleAuthMethodRetryArgs] = None,
            role_name: Optional[str] = None,
            sub_claims: Optional[Mapping[str, str]] = None) -> AssociateRoleAuthMethod
    func GetAssociateRoleAuthMethod(ctx *Context, name string, id IDInput, state *AssociateRoleAuthMethodState, opts ...ResourceOption) (*AssociateRoleAuthMethod, error)
    public static AssociateRoleAuthMethod Get(string name, Input<string> id, AssociateRoleAuthMethodState? state, CustomResourceOptions? opts = null)
    public static AssociateRoleAuthMethod get(String name, Output<String> id, AssociateRoleAuthMethodState state, CustomResourceOptions options)
    resources:  existingAssociateRoleAuthMethod:    type: akeyless:AssociateRoleAuthMethod    get:      id: ${id}
    import {
      to = akeyless_associate_role_auth_method.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 AssociateRoleAuthMethodState
    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 AssociateRoleAuthMethodState
    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 AssociateRoleAuthMethodState
    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 AssociateRoleAuthMethodState
    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:
    AmName string
    The auth method to associate
    AssociateRoleAuthMethodId string
    The ID of this resource.
    CaseSensitive string
    Treat sub claims as case-sensitive
    Retry AssociateRoleAuthMethodRetry
    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.
    RoleName string
    The role to associate
    SubClaims Dictionary<string, string>
    key/val of sub claims, e.g group=admins,developers
    AmName string
    The auth method to associate
    AssociateRoleAuthMethodId string
    The ID of this resource.
    CaseSensitive string
    Treat sub claims as case-sensitive
    Retry AssociateRoleAuthMethodRetryArgs
    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.
    RoleName string
    The role to associate
    SubClaims map[string]string
    key/val of sub claims, e.g group=admins,developers
    am_name string
    The auth method to associate
    associate_role_auth_method_id string
    The ID of this resource.
    case_sensitive string
    Treat sub claims as case-sensitive
    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.
    role_name string
    The role to associate
    sub_claims map(string)
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    associateRoleAuthMethodId String
    The ID of this resource.
    caseSensitive String
    Treat sub claims as case-sensitive
    retry AssociateRoleAuthMethodRetry
    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.
    roleName String
    The role to associate
    subClaims Map<String,String>
    key/val of sub claims, e.g group=admins,developers
    amName string
    The auth method to associate
    associateRoleAuthMethodId string
    The ID of this resource.
    caseSensitive string
    Treat sub claims as case-sensitive
    retry AssociateRoleAuthMethodRetry
    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.
    roleName string
    The role to associate
    subClaims {[key: string]: string}
    key/val of sub claims, e.g group=admins,developers
    am_name str
    The auth method to associate
    associate_role_auth_method_id str
    The ID of this resource.
    case_sensitive str
    Treat sub claims as case-sensitive
    retry AssociateRoleAuthMethodRetryArgs
    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.
    role_name str
    The role to associate
    sub_claims Mapping[str, str]
    key/val of sub claims, e.g group=admins,developers
    amName String
    The auth method to associate
    associateRoleAuthMethodId String
    The ID of this resource.
    caseSensitive String
    Treat sub claims as case-sensitive
    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.
    roleName String
    The role to associate
    subClaims Map<String>
    key/val of sub claims, e.g group=admins,developers

    Supporting Types

    AssociateRoleAuthMethodRetry, AssociateRoleAuthMethodRetryArgs

    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