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

    Passkey resource

    Create Passkey Resource

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

    Constructor syntax

    new Passkey(name: string, args: PasskeyArgs, opts?: CustomResourceOptions);
    @overload
    def Passkey(resource_name: str,
                args: PasskeyArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Passkey(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                alg: Optional[str] = None,
                accessibility: Optional[str] = None,
                delete_protection: Optional[str] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                origin_urls: Optional[Sequence[str]] = None,
                passkey_id: Optional[str] = None,
                protection_key_name: Optional[str] = None,
                retry: Optional[PasskeyRetryArgs] = None,
                tags: Optional[Sequence[str]] = None,
                username: Optional[str] = None)
    func NewPasskey(ctx *Context, name string, args PasskeyArgs, opts ...ResourceOption) (*Passkey, error)
    public Passkey(string name, PasskeyArgs args, CustomResourceOptions? opts = null)
    public Passkey(String name, PasskeyArgs args)
    public Passkey(String name, PasskeyArgs args, CustomResourceOptions options)
    
    type: akeyless:Passkey
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_passkey" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args PasskeyArgs
    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 PasskeyArgs
    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 PasskeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PasskeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PasskeyArgs
    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 passkeyResource = new Akeyless.Passkey("passkeyResource", new()
    {
        Alg = "string",
        Accessibility = "string",
        DeleteProtection = "string",
        Description = "string",
        Name = "string",
        OriginUrls = new[]
        {
            "string",
        },
        PasskeyId = "string",
        ProtectionKeyName = "string",
        Retry = new Akeyless.Inputs.PasskeyRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
        Tags = new[]
        {
            "string",
        },
        Username = "string",
    });
    
    example, err := akeyless.NewPasskey(ctx, "passkeyResource", &akeyless.PasskeyArgs{
    	Alg:              pulumi.String("string"),
    	Accessibility:    pulumi.String("string"),
    	DeleteProtection: pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	OriginUrls: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	PasskeyId:         pulumi.String("string"),
    	ProtectionKeyName: pulumi.String("string"),
    	Retry: &akeyless.PasskeyRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Username: pulumi.String("string"),
    })
    
    resource "akeyless_passkey" "passkeyResource" {
      lifecycle {
        create_before_destroy = true
      }
      alg                 = "string"
      accessibility       = "string"
      delete_protection   = "string"
      description         = "string"
      name                = "string"
      origin_urls         = ["string"]
      passkey_id          = "string"
      protection_key_name = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
      tags     = ["string"]
      username = "string"
    }
    
    var passkeyResource = new Passkey("passkeyResource", PasskeyArgs.builder()
        .alg("string")
        .accessibility("string")
        .deleteProtection("string")
        .description("string")
        .name("string")
        .originUrls("string")
        .passkeyId("string")
        .protectionKeyName("string")
        .retry(PasskeyRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .tags("string")
        .username("string")
        .build());
    
    passkey_resource = akeyless.Passkey("passkeyResource",
        alg="string",
        accessibility="string",
        delete_protection="string",
        description="string",
        name="string",
        origin_urls=["string"],
        passkey_id="string",
        protection_key_name="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)],
        },
        tags=["string"],
        username="string")
    
    const passkeyResource = new akeyless.Passkey("passkeyResource", {
        alg: "string",
        accessibility: "string",
        deleteProtection: "string",
        description: "string",
        name: "string",
        originUrls: ["string"],
        passkeyId: "string",
        protectionKeyName: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
        tags: ["string"],
        username: "string",
    });
    
    type: akeyless:Passkey
    properties:
        accessibility: string
        alg: string
        deleteProtection: string
        description: string
        name: string
        originUrls:
            - string
        passkeyId: string
        protectionKeyName: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        tags:
            - string
        username: string
    

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

    Alg string
    Passkey type; options: [EC256, EC384, EC512]
    Accessibility string
    For personal password manager
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    Name string
    ClassicKey name
    OriginUrls List<string>
    Originating websites for this passkey
    PasskeyId string
    The ID of this resource.
    ProtectionKeyName string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    Retry PasskeyRetry
    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.
    Tags List<string>
    Add tags attached to this object
    Username string
    For Password Management use
    Alg string
    Passkey type; options: [EC256, EC384, EC512]
    Accessibility string
    For personal password manager
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    Name string
    ClassicKey name
    OriginUrls []string
    Originating websites for this passkey
    PasskeyId string
    The ID of this resource.
    ProtectionKeyName string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    Retry PasskeyRetryArgs
    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.
    Tags []string
    Add tags attached to this object
    Username string
    For Password Management use
    alg string
    Passkey type; options: [EC256, EC384, EC512]
    accessibility string
    For personal password manager
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    name string
    ClassicKey name
    origin_urls list(string)
    Originating websites for this passkey
    passkey_id string
    The ID of this resource.
    protection_key_name string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    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.
    tags list(string)
    Add tags attached to this object
    username string
    For Password Management use
    alg String
    Passkey type; options: [EC256, EC384, EC512]
    accessibility String
    For personal password manager
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    name String
    ClassicKey name
    originUrls List<String>
    Originating websites for this passkey
    passkeyId String
    The ID of this resource.
    protectionKeyName String
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    retry PasskeyRetry
    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.
    tags List<String>
    Add tags attached to this object
    username String
    For Password Management use
    alg string
    Passkey type; options: [EC256, EC384, EC512]
    accessibility string
    For personal password manager
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    name string
    ClassicKey name
    originUrls string[]
    Originating websites for this passkey
    passkeyId string
    The ID of this resource.
    protectionKeyName string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    retry PasskeyRetry
    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.
    tags string[]
    Add tags attached to this object
    username string
    For Password Management use
    alg str
    Passkey type; options: [EC256, EC384, EC512]
    accessibility str
    For personal password manager
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    name str
    ClassicKey name
    origin_urls Sequence[str]
    Originating websites for this passkey
    passkey_id str
    The ID of this resource.
    protection_key_name str
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    retry PasskeyRetryArgs
    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.
    tags Sequence[str]
    Add tags attached to this object
    username str
    For Password Management use
    alg String
    Passkey type; options: [EC256, EC384, EC512]
    accessibility String
    For personal password manager
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    name String
    ClassicKey name
    originUrls List<String>
    Originating websites for this passkey
    passkeyId String
    The ID of this resource.
    protectionKeyName String
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    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.
    tags List<String>
    Add tags attached to this object
    username String
    For Password Management use

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Passkey Resource

    Get an existing Passkey 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?: PasskeyState, opts?: CustomResourceOptions): Passkey
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            accessibility: Optional[str] = None,
            alg: Optional[str] = None,
            delete_protection: Optional[str] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            origin_urls: Optional[Sequence[str]] = None,
            passkey_id: Optional[str] = None,
            protection_key_name: Optional[str] = None,
            retry: Optional[PasskeyRetryArgs] = None,
            tags: Optional[Sequence[str]] = None,
            username: Optional[str] = None) -> Passkey
    func GetPasskey(ctx *Context, name string, id IDInput, state *PasskeyState, opts ...ResourceOption) (*Passkey, error)
    public static Passkey Get(string name, Input<string> id, PasskeyState? state, CustomResourceOptions? opts = null)
    public static Passkey get(String name, Output<String> id, PasskeyState state, CustomResourceOptions options)
    resources:  existingPasskey:    type: akeyless:Passkey    get:      id: ${id}
    import {
      to = akeyless_passkey.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 PasskeyState
    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 PasskeyState
    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 PasskeyState
    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 PasskeyState
    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:
    Accessibility string
    For personal password manager
    Alg string
    Passkey type; options: [EC256, EC384, EC512]
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    Name string
    ClassicKey name
    OriginUrls List<string>
    Originating websites for this passkey
    PasskeyId string
    The ID of this resource.
    ProtectionKeyName string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    Retry PasskeyRetry
    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.
    Tags List<string>
    Add tags attached to this object
    Username string
    For Password Management use
    Accessibility string
    For personal password manager
    Alg string
    Passkey type; options: [EC256, EC384, EC512]
    DeleteProtection string
    Protection from accidental deletion of this object [true/false]
    Description string
    Description of the object
    Name string
    ClassicKey name
    OriginUrls []string
    Originating websites for this passkey
    PasskeyId string
    The ID of this resource.
    ProtectionKeyName string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    Retry PasskeyRetryArgs
    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.
    Tags []string
    Add tags attached to this object
    Username string
    For Password Management use
    accessibility string
    For personal password manager
    alg string
    Passkey type; options: [EC256, EC384, EC512]
    delete_protection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    name string
    ClassicKey name
    origin_urls list(string)
    Originating websites for this passkey
    passkey_id string
    The ID of this resource.
    protection_key_name string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    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.
    tags list(string)
    Add tags attached to this object
    username string
    For Password Management use
    accessibility String
    For personal password manager
    alg String
    Passkey type; options: [EC256, EC384, EC512]
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    name String
    ClassicKey name
    originUrls List<String>
    Originating websites for this passkey
    passkeyId String
    The ID of this resource.
    protectionKeyName String
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    retry PasskeyRetry
    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.
    tags List<String>
    Add tags attached to this object
    username String
    For Password Management use
    accessibility string
    For personal password manager
    alg string
    Passkey type; options: [EC256, EC384, EC512]
    deleteProtection string
    Protection from accidental deletion of this object [true/false]
    description string
    Description of the object
    name string
    ClassicKey name
    originUrls string[]
    Originating websites for this passkey
    passkeyId string
    The ID of this resource.
    protectionKeyName string
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    retry PasskeyRetry
    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.
    tags string[]
    Add tags attached to this object
    username string
    For Password Management use
    accessibility str
    For personal password manager
    alg str
    Passkey type; options: [EC256, EC384, EC512]
    delete_protection str
    Protection from accidental deletion of this object [true/false]
    description str
    Description of the object
    name str
    ClassicKey name
    origin_urls Sequence[str]
    Originating websites for this passkey
    passkey_id str
    The ID of this resource.
    protection_key_name str
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    retry PasskeyRetryArgs
    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.
    tags Sequence[str]
    Add tags attached to this object
    username str
    For Password Management use
    accessibility String
    For personal password manager
    alg String
    Passkey type; options: [EC256, EC384, EC512]
    deleteProtection String
    Protection from accidental deletion of this object [true/false]
    description String
    Description of the object
    name String
    ClassicKey name
    originUrls List<String>
    Originating websites for this passkey
    passkeyId String
    The ID of this resource.
    protectionKeyName String
    The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
    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.
    tags List<String>
    Add tags attached to this object
    username String
    For Password Management use

    Supporting Types

    PasskeyRetry, PasskeyRetryArgs

    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