published on Thursday, Nov 19, 2026 by akeyless-community
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:
- Access
Expires double - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- Allowed
Client List<string>Types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- Audit
Logs List<string>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringApi Key Id - 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 List<string>Ins - How many days before the expiration of the auth method would you like to be notified.
- Force
Sub boolClaims - if true: enforce role-association must include sub claims
- Gw
Bound List<string>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- Jwt
Ttl double - 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
Auth
Method Api Key Retry - 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 float64 - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- Allowed
Client []stringTypes - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- Audit
Logs []stringClaims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringApi Key Id - The ID of this resource.
- Bound
Ips []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 []stringIns - How many days before the expiration of the auth method would you like to be notified.
- Force
Sub boolClaims - if true: enforce role-association must include sub claims
- Gw
Bound []stringIps - A CIDR whitelist with the GW IPs that the access is restricted to
- Jwt
Ttl float64 - Jwt TTL
- Name string
- Auth Method name
- Product
Types []string - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- Retry
Auth
Method Api Key Retry Args - 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_ list(string)types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit_
logs_ list(string)claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ stringapi_ key_ id - 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_ list(string)ins - How many days before the expiration of the auth method would you like to be notified.
- force_
sub_ boolclaims - if true: enforce role-association must include sub claims
- gw_
bound_ list(string)ips - 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.
- access
Expires Double - Access expiration date in Unix timestamp (select 0 for access without expiry date)
- allowed
Client List<String>Types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringApi Key Id - 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 List<String>Ins - How many days before the expiration of the auth method would you like to be notified.
- force
Sub BooleanClaims - if true: enforce role-association must include sub claims
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- jwt
Ttl Double - 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
Auth
Method Api Key Retry - 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 string[]Types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit
Logs string[]Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method stringApi Key Id - The ID of this resource.
- bound
Ips 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 string[]Ins - How many days before the expiration of the auth method would you like to be notified.
- force
Sub booleanClaims - if true: enforce role-association must include sub claims
- gw
Bound string[]Ips - 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 string[] - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry
Auth
Method Api Key Retry - 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_ Sequence[str]types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit_
logs_ Sequence[str]claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ strapi_ key_ id - 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_ Sequence[str]ins - How many days before the expiration of the auth method would you like to be notified.
- force_
sub_ boolclaims - if true: enforce role-association must include sub claims
- gw_
bound_ Sequence[str]ips - 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
Auth
Method Api Key Retry Args - 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 List<String>Types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringApi Key Id - 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 List<String>Ins - How many days before the expiration of the auth method would you like to be notified.
- force
Sub BooleanClaims - if true: enforce role-association must include sub claims
- gw
Bound List<String>Ips - 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 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:
- 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.
- 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.
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) -> AuthMethodApiKeyfunc 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.
- Access
Expires double - 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 List<string>Types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- Audit
Logs List<string>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringApi Key Id - 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 List<string>Ins - How many days before the expiration of the auth method would you like to be notified.
- Force
Sub boolClaims - if true: enforce role-association must include sub claims
- Gw
Bound List<string>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- Jwt
Ttl double - 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
Auth
Method Api Key Retry - 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 float64 - 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 []stringTypes - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- Audit
Logs []stringClaims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- Auth
Method stringApi Key Id - The ID of this resource.
- Bound
Ips []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 []stringIns - How many days before the expiration of the auth method would you like to be notified.
- Force
Sub boolClaims - if true: enforce role-association must include sub claims
- Gw
Bound []stringIps - A CIDR whitelist with the GW IPs that the access is restricted to
- Jwt
Ttl float64 - Jwt TTL
- Name string
- Auth Method name
- Product
Types []string - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- Retry
Auth
Method Api Key Retry Args - 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_ list(string)types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit_
logs_ list(string)claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ stringapi_ key_ id - 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_ list(string)ins - How many days before the expiration of the auth method would you like to be notified.
- force_
sub_ boolclaims - if true: enforce role-association must include sub claims
- gw_
bound_ list(string)ips - 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.
- access
Expires Double - 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 List<String>Types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringApi Key Id - 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 List<String>Ins - How many days before the expiration of the auth method would you like to be notified.
- force
Sub BooleanClaims - if true: enforce role-association must include sub claims
- gw
Bound List<String>Ips - A CIDR whitelist with the GW IPs that the access is restricted to
- jwt
Ttl Double - 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
Auth
Method Api Key Retry - 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 string[]Types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit
Logs string[]Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method stringApi Key Id - The ID of this resource.
- bound
Ips 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 string[]Ins - How many days before the expiration of the auth method would you like to be notified.
- force
Sub booleanClaims - if true: enforce role-association must include sub claims
- gw
Bound string[]Ips - 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 string[] - Choose the relevant product type for the auth method [sm, sra, pm, dp, ca]
- retry
Auth
Method Api Key Retry - 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_ Sequence[str]types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit_
logs_ Sequence[str]claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth_
method_ strapi_ key_ id - 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_ Sequence[str]ins - How many days before the expiration of the auth method would you like to be notified.
- force_
sub_ boolclaims - if true: enforce role-association must include sub claims
- gw_
bound_ Sequence[str]ips - 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
Auth
Method Api Key Retry Args - 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 List<String>Types - limit the auth method usage for specific client types [cli,ui,gateway-admin,sdk,mobile,extension]
- audit
Logs List<String>Claims - Subclaims to include in audit logs, e.g "--audit-logs-claims email --audit-logs-claims username"
- auth
Method StringApi Key Id - 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 List<String>Ins - How many days before the expiration of the auth method would you like to be notified.
- force
Sub BooleanClaims - if true: enforce role-association must include sub claims
- gw
Bound List<String>Ips - 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 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
- Error
Message List<string>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds double - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval doubleSeconds - Maximum wait between retries, in seconds.
- Max
Retries double - Maximum number of retries after the first attempt.
- Retry
On List<double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- Error
Message []stringRegexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds float64 - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval float64Seconds - Maximum wait between retries, in seconds.
- Max
Retries float64 - Maximum number of retries after the first attempt.
- Retry
On []float64Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ list(string)regexes - 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_ numberseconds - Maximum wait between retries, in seconds.
- max_
retries number - Maximum number of retries after the first attempt.
- retry_
on_ list(number)status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Double - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval DoubleSeconds - Maximum wait between retries, in seconds.
- max
Retries Double - Maximum number of retries after the first attempt.
- retry
On List<Double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message string[]Regexes - 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 numberSeconds - Maximum wait between retries, in seconds.
- max
Retries number - Maximum number of retries after the first attempt.
- retry
On number[]Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ Sequence[str]regexes - 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_ floatseconds - Maximum wait between retries, in seconds.
- max_
retries float - Maximum number of retries after the first attempt.
- retry_
on_ Sequence[float]status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - 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 NumberSeconds - Maximum wait between retries, in seconds.
- max
Retries Number - Maximum number of retries after the first attempt.
- retry
On List<Number>Status Codes - 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
akeylessTerraform Provider.
published on Thursday, Nov 19, 2026 by akeyless-community