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

akeyless.AuthMethodApiKey

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

    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)
    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.

    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,
    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,
    Name = "string",
    ProductTypes = new[]
    {
        "string",
    },
});

    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"),
	},
})

    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")
    .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"])

    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"],
});

    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

    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]
    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]
    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]
    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]
    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]
    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]

    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.
    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) -> 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:  _:    type: akeyless:AuthMethodApiKey    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this 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]
    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]
    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]
    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]
    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]
    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]

    Package Details

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