Example Usage
Create StageAuthenticatorWebauthn Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new StageAuthenticatorWebauthn(name: string, args?: StageAuthenticatorWebauthnArgs, opts?: CustomResourceOptions);@overload
def StageAuthenticatorWebauthn(resource_name: str,
args: Optional[StageAuthenticatorWebauthnArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def StageAuthenticatorWebauthn(resource_name: str,
opts: Optional[ResourceOptions] = None,
authenticator_attachment: Optional[str] = None,
configure_flow: Optional[str] = None,
device_type_restrictions: Optional[Sequence[str]] = None,
friendly_name: Optional[str] = None,
max_attempts: Optional[float] = None,
name: Optional[str] = None,
resident_key_requirement: Optional[str] = None,
stage_authenticator_webauthn_id: Optional[str] = None,
user_verification: Optional[str] = None)func NewStageAuthenticatorWebauthn(ctx *Context, name string, args *StageAuthenticatorWebauthnArgs, opts ...ResourceOption) (*StageAuthenticatorWebauthn, error)public StageAuthenticatorWebauthn(string name, StageAuthenticatorWebauthnArgs? args = null, CustomResourceOptions? opts = null)
public StageAuthenticatorWebauthn(String name, StageAuthenticatorWebauthnArgs args)
public StageAuthenticatorWebauthn(String name, StageAuthenticatorWebauthnArgs args, CustomResourceOptions options)
type: authentik:StageAuthenticatorWebauthn
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 StageAuthenticatorWebauthnArgs
- 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 StageAuthenticatorWebauthnArgs
- 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 StageAuthenticatorWebauthnArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StageAuthenticatorWebauthnArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StageAuthenticatorWebauthnArgs
- 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 stageAuthenticatorWebauthnResource = new Authentik.StageAuthenticatorWebauthn("stageAuthenticatorWebauthnResource", new()
{
AuthenticatorAttachment = "string",
ConfigureFlow = "string",
DeviceTypeRestrictions = new[]
{
"string",
},
FriendlyName = "string",
MaxAttempts = 0,
Name = "string",
ResidentKeyRequirement = "string",
StageAuthenticatorWebauthnId = "string",
UserVerification = "string",
});
example, err := authentik.NewStageAuthenticatorWebauthn(ctx, "stageAuthenticatorWebauthnResource", &authentik.StageAuthenticatorWebauthnArgs{
AuthenticatorAttachment: pulumi.String("string"),
ConfigureFlow: pulumi.String("string"),
DeviceTypeRestrictions: pulumi.StringArray{
pulumi.String("string"),
},
FriendlyName: pulumi.String("string"),
MaxAttempts: pulumi.Float64(0),
Name: pulumi.String("string"),
ResidentKeyRequirement: pulumi.String("string"),
StageAuthenticatorWebauthnId: pulumi.String("string"),
UserVerification: pulumi.String("string"),
})
var stageAuthenticatorWebauthnResource = new StageAuthenticatorWebauthn("stageAuthenticatorWebauthnResource", StageAuthenticatorWebauthnArgs.builder()
.authenticatorAttachment("string")
.configureFlow("string")
.deviceTypeRestrictions("string")
.friendlyName("string")
.maxAttempts(0.0)
.name("string")
.residentKeyRequirement("string")
.stageAuthenticatorWebauthnId("string")
.userVerification("string")
.build());
stage_authenticator_webauthn_resource = authentik.StageAuthenticatorWebauthn("stageAuthenticatorWebauthnResource",
authenticator_attachment="string",
configure_flow="string",
device_type_restrictions=["string"],
friendly_name="string",
max_attempts=0,
name="string",
resident_key_requirement="string",
stage_authenticator_webauthn_id="string",
user_verification="string")
const stageAuthenticatorWebauthnResource = new authentik.StageAuthenticatorWebauthn("stageAuthenticatorWebauthnResource", {
authenticatorAttachment: "string",
configureFlow: "string",
deviceTypeRestrictions: ["string"],
friendlyName: "string",
maxAttempts: 0,
name: "string",
residentKeyRequirement: "string",
stageAuthenticatorWebauthnId: "string",
userVerification: "string",
});
type: authentik:StageAuthenticatorWebauthn
properties:
authenticatorAttachment: string
configureFlow: string
deviceTypeRestrictions:
- string
friendlyName: string
maxAttempts: 0
name: string
residentKeyRequirement: string
stageAuthenticatorWebauthnId: string
userVerification: string
StageAuthenticatorWebauthn 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 StageAuthenticatorWebauthn resource accepts the following input properties:
- Authenticator
Attachment string - Allowed values:
platformcross-platform
- Configure
Flow string - Device
Type List<string>Restrictions - Friendly
Name string - Defaults to ``.
- Max
Attempts double - Name string
- Resident
Key stringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- Stage
Authenticator stringWebauthn Id - User
Verification string - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- Authenticator
Attachment string - Allowed values:
platformcross-platform
- Configure
Flow string - Device
Type []stringRestrictions - Friendly
Name string - Defaults to ``.
- Max
Attempts float64 - Name string
- Resident
Key stringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- Stage
Authenticator stringWebauthn Id - User
Verification string - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- authenticator
Attachment String - Allowed values:
platformcross-platform
- configure
Flow String - device
Type List<String>Restrictions - friendly
Name String - Defaults to ``.
- max
Attempts Double - name String
- resident
Key StringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- stage
Authenticator StringWebauthn Id - user
Verification String - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- authenticator
Attachment string - Allowed values:
platformcross-platform
- configure
Flow string - device
Type string[]Restrictions - friendly
Name string - Defaults to ``.
- max
Attempts number - name string
- resident
Key stringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- stage
Authenticator stringWebauthn Id - user
Verification string - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- authenticator_
attachment str - Allowed values:
platformcross-platform
- configure_
flow str - device_
type_ Sequence[str]restrictions - friendly_
name str - Defaults to ``.
- max_
attempts float - name str
- resident_
key_ strrequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- stage_
authenticator_ strwebauthn_ id - user_
verification str - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- authenticator
Attachment String - Allowed values:
platformcross-platform
- configure
Flow String - device
Type List<String>Restrictions - friendly
Name String - Defaults to ``.
- max
Attempts Number - name String
- resident
Key StringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- stage
Authenticator StringWebauthn Id - user
Verification String - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
Outputs
All input properties are implicitly available as output properties. Additionally, the StageAuthenticatorWebauthn 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 str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing StageAuthenticatorWebauthn Resource
Get an existing StageAuthenticatorWebauthn 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?: StageAuthenticatorWebauthnState, opts?: CustomResourceOptions): StageAuthenticatorWebauthn@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
authenticator_attachment: Optional[str] = None,
configure_flow: Optional[str] = None,
device_type_restrictions: Optional[Sequence[str]] = None,
friendly_name: Optional[str] = None,
max_attempts: Optional[float] = None,
name: Optional[str] = None,
resident_key_requirement: Optional[str] = None,
stage_authenticator_webauthn_id: Optional[str] = None,
user_verification: Optional[str] = None) -> StageAuthenticatorWebauthnfunc GetStageAuthenticatorWebauthn(ctx *Context, name string, id IDInput, state *StageAuthenticatorWebauthnState, opts ...ResourceOption) (*StageAuthenticatorWebauthn, error)public static StageAuthenticatorWebauthn Get(string name, Input<string> id, StageAuthenticatorWebauthnState? state, CustomResourceOptions? opts = null)public static StageAuthenticatorWebauthn get(String name, Output<String> id, StageAuthenticatorWebauthnState state, CustomResourceOptions options)resources: _: type: authentik:StageAuthenticatorWebauthn 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.
- Authenticator
Attachment string - Allowed values:
platformcross-platform
- Configure
Flow string - Device
Type List<string>Restrictions - Friendly
Name string - Defaults to ``.
- Max
Attempts double - Name string
- Resident
Key stringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- Stage
Authenticator stringWebauthn Id - User
Verification string - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- Authenticator
Attachment string - Allowed values:
platformcross-platform
- Configure
Flow string - Device
Type []stringRestrictions - Friendly
Name string - Defaults to ``.
- Max
Attempts float64 - Name string
- Resident
Key stringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- Stage
Authenticator stringWebauthn Id - User
Verification string - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- authenticator
Attachment String - Allowed values:
platformcross-platform
- configure
Flow String - device
Type List<String>Restrictions - friendly
Name String - Defaults to ``.
- max
Attempts Double - name String
- resident
Key StringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- stage
Authenticator StringWebauthn Id - user
Verification String - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- authenticator
Attachment string - Allowed values:
platformcross-platform
- configure
Flow string - device
Type string[]Restrictions - friendly
Name string - Defaults to ``.
- max
Attempts number - name string
- resident
Key stringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- stage
Authenticator stringWebauthn Id - user
Verification string - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- authenticator_
attachment str - Allowed values:
platformcross-platform
- configure_
flow str - device_
type_ Sequence[str]restrictions - friendly_
name str - Defaults to ``.
- max_
attempts float - name str
- resident_
key_ strrequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- stage_
authenticator_ strwebauthn_ id - user_
verification str - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
- authenticator
Attachment String - Allowed values:
platformcross-platform
- configure
Flow String - device
Type List<String>Restrictions - friendly
Name String - Defaults to ``.
- max
Attempts Number - name String
- resident
Key StringRequirement - Allowed values:
discouragedpreferredrequiredDefaults topreferred.
- stage
Authenticator StringWebauthn Id - user
Verification String - Allowed values:
requiredpreferreddiscouragedDefaults topreferred.
Package Details
- Repository
- authentik goauthentik/terraform-provider-authentik
- License
- Notes
- This Pulumi package is based on the
authentikTerraform Provider.
