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

    API Key Auth Method Resource

    Create AuthMethodApiKey Resource

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

    Constructor syntax

    new AuthMethodApiKey(name: string, args?: AuthMethodApiKeyArgs, opts?: CustomResourceOptions);
    @overload
    def AuthMethodApiKey(resource_name: str,
                         args: Optional[AuthMethodApiKeyArgs] = None,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def AuthMethodApiKey(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         access_expires: Optional[float] = None,
                         allowed_client_types: Optional[Sequence[str]] = None,
                         audit_logs_claims: Optional[Sequence[str]] = None,
                         auth_method_api_key_id: Optional[str] = None,
                         bound_ips: Optional[Sequence[str]] = None,
                         delete_protection: Optional[str] = None,
                         description: Optional[str] = None,
                         expiration_event_ins: Optional[Sequence[str]] = None,
                         force_sub_claims: Optional[bool] = None,
                         gw_bound_ips: Optional[Sequence[str]] = None,
                         jwt_ttl: Optional[float] = None,
                         name: Optional[str] = None,
                         product_types: Optional[Sequence[str]] = None,
                         retry: Optional[AuthMethodApiKeyRetryArgs] = None)
    func NewAuthMethodApiKey(ctx *Context, name string, args *AuthMethodApiKeyArgs, opts ...ResourceOption) (*AuthMethodApiKey, error)
    public AuthMethodApiKey(string name, AuthMethodApiKeyArgs? args = null, CustomResourceOptions? opts = null)
    public AuthMethodApiKey(String name, AuthMethodApiKeyArgs args)
    public AuthMethodApiKey(String name, AuthMethodApiKeyArgs args, CustomResourceOptions options)
    
    type: akeyless:AuthMethodApiKey
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_auth_method_api_key" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args AuthMethodApiKeyArgs
    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 AuthMethodApiKeyArgs
    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 AuthMethodApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthMethodApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthMethodApiKeyArgs
    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 authMethodApiKeyResource = new Akeyless.AuthMethodApiKey("authMethodApiKeyResource", new()
    {
        AccessExpires = 0.0,
        AllowedClientTypes = new[]
        {
            "string",
        },
        AuditLogsClaims = new[]
        {
            "string",
        },
        AuthMethodApiKeyId = "string",
        BoundIps = new[]
        {
            "string",
        },
        DeleteProtection = "string",
        Description = "string",
        ExpirationEventIns = new[]
        {
            "string",
        },
        ForceSubClaims = false,
        GwBoundIps = new[]
        {
            "string",
        },
        JwtTtl = 0.0,
        Name = "string",
        ProductTypes = new[]
        {
            "string",
        },
        Retry = new Akeyless.Inputs.AuthMethodApiKeyRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
    });
    
    example, err := akeyless.NewAuthMethodApiKey(ctx, "authMethodApiKeyResource", &akeyless.AuthMethodApiKeyArgs{
    	AccessExpires: pulumi.Float64(0),
    	AllowedClientTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AuditLogsClaims: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	AuthMethodApiKeyId: pulumi.String("string"),
    	BoundIps: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	DeleteProtection: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	ExpirationEventIns: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ForceSubClaims: pulumi.Bool(false),
    	GwBoundIps: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	JwtTtl: pulumi.Float64(0),
    	Name:   pulumi.String("string"),
    	ProductTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Retry: &akeyless.AuthMethodApiKeyRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    })
    
    resource "akeyless_auth_method_api_key" "authMethodApiKeyResource" {
      lifecycle {
        create_before_destroy = true
      }
      access_expires         = 0
      allowed_client_types   = ["string"]
      audit_logs_claims      = ["string"]
      auth_method_api_key_id = "string"
      bound_ips              = ["string"]
      delete_protection      = "string"
      description            = "string"
      expiration_event_ins   = ["string"]
      force_sub_claims       = false
      gw_bound_ips           = ["string"]
      jwt_ttl                = 0
      name                   = "string"
      product_types          = ["string"]
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
    }
    
    var authMethodApiKeyResource = new AuthMethodApiKey("authMethodApiKeyResource", AuthMethodApiKeyArgs.builder()
        .accessExpires(0.0)
        .allowedClientTypes("string")
        .auditLogsClaims("string")
        .authMethodApiKeyId("string")
        .boundIps("string")
        .deleteProtection("string")
        .description("string")
        .expirationEventIns("string")
        .forceSubClaims(false)
        .gwBoundIps("string")
        .jwtTtl(0.0)
        .name("string")
        .productTypes("string")
        .retry(AuthMethodApiKeyRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .build());
    
    auth_method_api_key_resource = akeyless.AuthMethodApiKey("authMethodApiKeyResource",
        access_expires=float(0),
        allowed_client_types=["string"],
        audit_logs_claims=["string"],
        auth_method_api_key_id="string",
        bound_ips=["string"],
        delete_protection="string",
        description="string",
        expiration_event_ins=["string"],
        force_sub_claims=False,
        gw_bound_ips=["string"],
        jwt_ttl=float(0),
        name="string",
        product_types=["string"],
        retry={
            "error_message_regexes": ["string"],
            "interval_seconds": float(0),
            "max_interval_seconds": float(0),
            "max_retries": float(0),
            "retry_on_status_codes": [float(0)],
        })
    
    const authMethodApiKeyResource = new akeyless.AuthMethodApiKey("authMethodApiKeyResource", {
        accessExpires: 0,
        allowedClientTypes: ["string"],
        auditLogsClaims: ["string"],
        authMethodApiKeyId: "string",
        boundIps: ["string"],
        deleteProtection: "string",
        description: "string",
        expirationEventIns: ["string"],
        forceSubClaims: false,
        gwBoundIps: ["string"],
        jwtTtl: 0,
        name: "string",
        productTypes: ["string"],
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
    });
    
    type: akeyless:AuthMethodApiKey
    properties:
        accessExpires: 0
        allowedClientTypes:
            - string
        auditLogsClaims:
            - string
        authMethodApiKeyId: string
        boundIps:
            - string
        deleteProtection: string
        description: string
        expirationEventIns:
            - string
        forceSubClaims: false
        gwBoundIps:
            - string
        jwtTtl: 0
        name: string
        productTypes:
            - string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
    

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

    AccessExpires double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AllowedClientTypes List<string>
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    AuditLogsClaims List<string>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodApiKeyId string
    The ID of this resource.
    BoundIps List<string>
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Auth Method description
    ExpirationEventIns List<string>
    How many days before the expiration of the auth method would you like to be notified.
    ForceSubClaims bool
    if true: enforce role-association must include sub claims
    GwBoundIps List<string>
    A CIDR whitelist with the GW IPs that the access is restricted to
    JwtTtl double
    Jwt TTL
    Name string
    Auth Method name
    ProductTypes List<string>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    Retry AuthMethodApiKeyRetry
    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.
    AccessExpires float64
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AllowedClientTypes []string
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    AuditLogsClaims []string
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodApiKeyId string
    The ID of this resource.
    BoundIps []string
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Auth Method description
    ExpirationEventIns []string
    How many days before the expiration of the auth method would you like to be notified.
    ForceSubClaims bool
    if true: enforce role-association must include sub claims
    GwBoundIps []string
    A CIDR whitelist with the GW IPs that the access is restricted to
    JwtTtl float64
    Jwt TTL
    Name string
    Auth Method name
    ProductTypes []string
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    Retry AuthMethodApiKeyRetryArgs
    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.
    access_expires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowed_client_types list(string)
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    audit_logs_claims list(string)
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_api_key_id string
    The ID of this resource.
    bound_ips list(string)
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Auth Method description
    expiration_event_ins list(string)
    How many days before the expiration of the auth method would you like to be notified.
    force_sub_claims bool
    if true: enforce role-association must include sub claims
    gw_bound_ips list(string)
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwt_ttl number
    Jwt TTL
    name string
    Auth Method name
    product_types list(string)
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    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.
    accessExpires Double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowedClientTypes List<String>
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodApiKeyId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Auth Method description
    expirationEventIns List<String>
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims Boolean
    if true: enforce role-association must include sub claims
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwtTtl Double
    Jwt TTL
    name String
    Auth Method name
    productTypes List<String>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    retry AuthMethodApiKeyRetry
    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.
    accessExpires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowedClientTypes string[]
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    auditLogsClaims string[]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodApiKeyId string
    The ID of this resource.
    boundIps string[]
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Auth Method description
    expirationEventIns string[]
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims boolean
    if true: enforce role-association must include sub claims
    gwBoundIps string[]
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwtTtl number
    Jwt TTL
    name string
    Auth Method name
    productTypes string[]
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    retry AuthMethodApiKeyRetry
    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.
    access_expires float
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowed_client_types Sequence[str]
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_api_key_id str
    The ID of this resource.
    bound_ips Sequence[str]
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Auth Method description
    expiration_event_ins Sequence[str]
    How many days before the expiration of the auth method would you like to be notified.
    force_sub_claims bool
    if true: enforce role-association must include sub claims
    gw_bound_ips Sequence[str]
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwt_ttl float
    Jwt TTL
    name str
    Auth Method name
    product_types Sequence[str]
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    retry AuthMethodApiKeyRetryArgs
    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.
    accessExpires Number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    allowedClientTypes List<String>
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodApiKeyId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Auth Method description
    expirationEventIns List<String>
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims Boolean
    if true: enforce role-association must include sub claims
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwtTtl Number
    Jwt TTL
    name String
    Auth Method name
    productTypes List<String>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.

    Outputs

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

    AccessId string
    Auth Method access ID
    AccessKey string
    Auth Method access key
    Id string
    The provider-assigned unique ID for this managed resource.
    AccessId string
    Auth Method access ID
    AccessKey string
    Auth Method access key
    Id string
    The provider-assigned unique ID for this managed resource.
    access_id string
    Auth Method access ID
    access_key string
    Auth Method access key
    id string
    The provider-assigned unique ID for this managed resource.
    accessId String
    Auth Method access ID
    accessKey String
    Auth Method access key
    id String
    The provider-assigned unique ID for this managed resource.
    accessId string
    Auth Method access ID
    accessKey string
    Auth Method access key
    id string
    The provider-assigned unique ID for this managed resource.
    access_id str
    Auth Method access ID
    access_key str
    Auth Method access key
    id str
    The provider-assigned unique ID for this managed resource.
    accessId String
    Auth Method access ID
    accessKey String
    Auth Method access key
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AuthMethodApiKey Resource

    Get an existing AuthMethodApiKey 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?: AuthMethodApiKeyState, opts?: CustomResourceOptions): AuthMethodApiKey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_expires: Optional[float] = None,
            access_id: Optional[str] = None,
            access_key: Optional[str] = None,
            allowed_client_types: Optional[Sequence[str]] = None,
            audit_logs_claims: Optional[Sequence[str]] = None,
            auth_method_api_key_id: Optional[str] = None,
            bound_ips: Optional[Sequence[str]] = None,
            delete_protection: Optional[str] = None,
            description: Optional[str] = None,
            expiration_event_ins: Optional[Sequence[str]] = None,
            force_sub_claims: Optional[bool] = None,
            gw_bound_ips: Optional[Sequence[str]] = None,
            jwt_ttl: Optional[float] = None,
            name: Optional[str] = None,
            product_types: Optional[Sequence[str]] = None,
            retry: Optional[AuthMethodApiKeyRetryArgs] = None) -> AuthMethodApiKey
    func GetAuthMethodApiKey(ctx *Context, name string, id IDInput, state *AuthMethodApiKeyState, opts ...ResourceOption) (*AuthMethodApiKey, error)
    public static AuthMethodApiKey Get(string name, Input<string> id, AuthMethodApiKeyState? state, CustomResourceOptions? opts = null)
    public static AuthMethodApiKey get(String name, Output<String> id, AuthMethodApiKeyState state, CustomResourceOptions options)
    resources:  existingAuthMethodApiKey:    type: akeyless:AuthMethodApiKey    get:      id: ${id}
    import {
      to = akeyless_auth_method_api_key.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 AuthMethodApiKeyState
    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 AuthMethodApiKeyState
    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 AuthMethodApiKeyState
    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 AuthMethodApiKeyState
    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:
    AccessExpires double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AccessId string
    Auth Method access ID
    AccessKey string
    Auth Method access key
    AllowedClientTypes List<string>
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    AuditLogsClaims List<string>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodApiKeyId string
    The ID of this resource.
    BoundIps List<string>
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Auth Method description
    ExpirationEventIns List<string>
    How many days before the expiration of the auth method would you like to be notified.
    ForceSubClaims bool
    if true: enforce role-association must include sub claims
    GwBoundIps List<string>
    A CIDR whitelist with the GW IPs that the access is restricted to
    JwtTtl double
    Jwt TTL
    Name string
    Auth Method name
    ProductTypes List<string>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    Retry AuthMethodApiKeyRetry
    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.
    AccessExpires float64
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AccessId string
    Auth Method access ID
    AccessKey string
    Auth Method access key
    AllowedClientTypes []string
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    AuditLogsClaims []string
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    AuthMethodApiKeyId string
    The ID of this resource.
    BoundIps []string
    A CIDR whitelist with the IPs that the access is restricted to
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Auth Method description
    ExpirationEventIns []string
    How many days before the expiration of the auth method would you like to be notified.
    ForceSubClaims bool
    if true: enforce role-association must include sub claims
    GwBoundIps []string
    A CIDR whitelist with the GW IPs that the access is restricted to
    JwtTtl float64
    Jwt TTL
    Name string
    Auth Method name
    ProductTypes []string
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    Retry AuthMethodApiKeyRetryArgs
    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.
    access_expires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    access_id string
    Auth Method access ID
    access_key string
    Auth Method access key
    allowed_client_types list(string)
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    audit_logs_claims list(string)
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_api_key_id string
    The ID of this resource.
    bound_ips list(string)
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Auth Method description
    expiration_event_ins list(string)
    How many days before the expiration of the auth method would you like to be notified.
    force_sub_claims bool
    if true: enforce role-association must include sub claims
    gw_bound_ips list(string)
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwt_ttl number
    Jwt TTL
    name string
    Auth Method name
    product_types list(string)
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    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.
    accessExpires Double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId String
    Auth Method access ID
    accessKey String
    Auth Method access key
    allowedClientTypes List<String>
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodApiKeyId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Auth Method description
    expirationEventIns List<String>
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims Boolean
    if true: enforce role-association must include sub claims
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwtTtl Double
    Jwt TTL
    name String
    Auth Method name
    productTypes List<String>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    retry AuthMethodApiKeyRetry
    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.
    accessExpires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId string
    Auth Method access ID
    accessKey string
    Auth Method access key
    allowedClientTypes string[]
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    auditLogsClaims string[]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodApiKeyId string
    The ID of this resource.
    boundIps string[]
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Auth Method description
    expirationEventIns string[]
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims boolean
    if true: enforce role-association must include sub claims
    gwBoundIps string[]
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwtTtl number
    Jwt TTL
    name string
    Auth Method name
    productTypes string[]
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    retry AuthMethodApiKeyRetry
    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.
    access_expires float
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    access_id str
    Auth Method access ID
    access_key str
    Auth Method access key
    allowed_client_types Sequence[str]
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    auth_method_api_key_id str
    The ID of this resource.
    bound_ips Sequence[str]
    A CIDR whitelist with the IPs that the access is restricted to
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Auth Method description
    expiration_event_ins Sequence[str]
    How many days before the expiration of the auth method would you like to be notified.
    force_sub_claims bool
    if true: enforce role-association must include sub claims
    gw_bound_ips Sequence[str]
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwt_ttl float
    Jwt TTL
    name str
    Auth Method name
    product_types Sequence[str]
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    retry AuthMethodApiKeyRetryArgs
    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.
    accessExpires Number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    accessId String
    Auth Method access ID
    accessKey String
    Auth Method access key
    allowedClientTypes List<String>
    limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
    auditLogsClaims List<String>
    Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
    authMethodApiKeyId String
    The ID of this resource.
    boundIps List<String>
    A CIDR whitelist with the IPs that the access is restricted to
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Auth Method description
    expirationEventIns List<String>
    How many days before the expiration of the auth method would you like to be notified.
    forceSubClaims Boolean
    if true: enforce role-association must include sub claims
    gwBoundIps List<String>
    A CIDR whitelist with the GW IPs that the access is restricted to
    jwtTtl Number
    Jwt TTL
    name String
    Auth Method name
    productTypes List<String>
    Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
    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.

    Supporting Types

    AuthMethodApiKeyRetry, AuthMethodApiKeyRetryArgs

    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