Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akeyless Provider
  3. API Docs
  4. AuthMethodApiKey
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

akeyless.AuthMethodApiKey

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

    AWS 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[AuthMethodApiKeyInitArgs] = None,
                     opts: Optional[ResourceOptions] = None)

@overload
def AuthMethodApiKey(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     access_expires: Optional[float] = 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,
                     force_sub_claims: Optional[bool] = None,
                     jwt_ttl: Optional[float] = None,
                     name: Optional[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 AuthMethodApiKeyInitArgs
    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,
    AuditLogsClaims = new[]
    {
        "string",
    },
    AuthMethodApiKeyId = "string",
    BoundIps = new[]
    {
        "string",
    },
    DeleteProtection = "string",
    ForceSubClaims = false,
    JwtTtl = 0,
    Name = "string",
});

    example, err := akeyless.NewAuthMethodApiKey(ctx, "authMethodApiKeyResource", &akeyless.AuthMethodApiKeyArgs{
	AccessExpires: pulumi.Float64(0),
	AuditLogsClaims: pulumi.StringArray{
		pulumi.String("string"),
	},
	AuthMethodApiKeyId: pulumi.String("string"),
	BoundIps: pulumi.StringArray{
		pulumi.String("string"),
	},
	DeleteProtection: pulumi.String("string"),
	ForceSubClaims:   pulumi.Bool(false),
	JwtTtl:           pulumi.Float64(0),
	Name:             pulumi.String("string"),
})

    var authMethodApiKeyResource = new AuthMethodApiKey("authMethodApiKeyResource", AuthMethodApiKeyArgs.builder()
    .accessExpires(0)
    .auditLogsClaims("string")
    .authMethodApiKeyId("string")
    .boundIps("string")
    .deleteProtection("string")
    .forceSubClaims(false)
    .jwtTtl(0)
    .name("string")
    .build());

    auth_method_api_key_resource = akeyless.AuthMethodApiKey("authMethodApiKeyResource",
    access_expires=0,
    audit_logs_claims=["string"],
    auth_method_api_key_id="string",
    bound_ips=["string"],
    delete_protection="string",
    force_sub_claims=False,
    jwt_ttl=0,
    name="string")

    const authMethodApiKeyResource = new akeyless.AuthMethodApiKey("authMethodApiKeyResource", {
    accessExpires: 0,
    auditLogsClaims: ["string"],
    authMethodApiKeyId: "string",
    boundIps: ["string"],
    deleteProtection: "string",
    forceSubClaims: false,
    jwtTtl: 0,
    name: "string",
});

    type: akeyless:AuthMethodApiKey
properties:
    accessExpires: 0
    auditLogsClaims:
        - string
    authMethodApiKeyId: string
    boundIps:
        - string
    deleteProtection: string
    forceSubClaims: false
    jwtTtl: 0
    name: 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)
    AuditLogsClaims List<string>
    Subclaims to include in audit logs
    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 auth method, [true/false]
    ForceSubClaims bool
    enforce role-association must include sub claims
    JwtTtl double
    Creds expiration time in minutes
    Name string
    Auth Method name
    AccessExpires float64
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    AuditLogsClaims []string
    Subclaims to include in audit logs
    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 auth method, [true/false]
    ForceSubClaims bool
    enforce role-association must include sub claims
    JwtTtl float64
    Creds expiration time in minutes
    Name string
    Auth Method name
    accessExpires Double
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    auditLogsClaims List<String>
    Subclaims to include in audit logs
    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 auth method, [true/false]
    forceSubClaims Boolean
    enforce role-association must include sub claims
    jwtTtl Double
    Creds expiration time in minutes
    name String
    Auth Method name
    accessExpires number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    auditLogsClaims string[]
    Subclaims to include in audit logs
    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 auth method, [true/false]
    forceSubClaims boolean
    enforce role-association must include sub claims
    jwtTtl number
    Creds expiration time in minutes
    name string
    Auth Method name
    access_expires float
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs
    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 auth method, [true/false]
    force_sub_claims bool
    enforce role-association must include sub claims
    jwt_ttl float
    Creds expiration time in minutes
    name str
    Auth Method name
    accessExpires Number
    Access expiration date in Unix timestamp (select 0 for access without expiry date)
    auditLogsClaims List<String>
    Subclaims to include in audit logs
    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 auth method, [true/false]
    forceSubClaims Boolean
    enforce role-association must include sub claims
    jwtTtl Number
    Creds expiration time in minutes
    name String
    Auth Method name

    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,
        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,
        force_sub_claims: Optional[bool] = None,
        jwt_ttl: Optional[float] = None,
        name: Optional[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
    AuditLogsClaims List<string>
    Subclaims to include in audit logs
    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 auth method, [true/false]
    ForceSubClaims bool
    enforce role-association must include sub claims
    JwtTtl double
    Creds expiration time in minutes
    Name string
    Auth Method name
    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
    AuditLogsClaims []string
    Subclaims to include in audit logs
    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 auth method, [true/false]
    ForceSubClaims bool
    enforce role-association must include sub claims
    JwtTtl float64
    Creds expiration time in minutes
    Name string
    Auth Method name
    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
    auditLogsClaims List<String>
    Subclaims to include in audit logs
    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 auth method, [true/false]
    forceSubClaims Boolean
    enforce role-association must include sub claims
    jwtTtl Double
    Creds expiration time in minutes
    name String
    Auth Method name
    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
    auditLogsClaims string[]
    Subclaims to include in audit logs
    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 auth method, [true/false]
    forceSubClaims boolean
    enforce role-association must include sub claims
    jwtTtl number
    Creds expiration time in minutes
    name string
    Auth Method name
    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
    audit_logs_claims Sequence[str]
    Subclaims to include in audit logs
    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 auth method, [true/false]
    force_sub_claims bool
    enforce role-association must include sub claims
    jwt_ttl float
    Creds expiration time in minutes
    name str
    Auth Method name
    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
    auditLogsClaims List<String>
    Subclaims to include in audit logs
    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 auth method, [true/false]
    forceSubClaims Boolean
    enforce role-association must include sub claims
    jwtTtl Number
    Creds expiration time in minutes
    name String
    Auth Method name

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
    akeyless-community/terraform-provider-akeyless