1. Packages
  2. Fortios
  3. API Docs
  4. user
  5. Certificate
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

fortios.user.Certificate

Explore with Pulumi AI

fortios logo
Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse

    Configure certificate users. Applies to FortiOS Version >= 7.0.1.

    Create Certificate Resource

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

    Constructor syntax

    new Certificate(name: string, args?: CertificateArgs, opts?: CustomResourceOptions);
    @overload
    def Certificate(resource_name: str,
                    args: Optional[CertificateArgs] = None,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def Certificate(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    common_name: Optional[str] = None,
                    fosid: Optional[int] = None,
                    issuer: Optional[str] = None,
                    name: Optional[str] = None,
                    status: Optional[str] = None,
                    type: Optional[str] = None,
                    vdomparam: Optional[str] = None)
    func NewCertificate(ctx *Context, name string, args *CertificateArgs, opts ...ResourceOption) (*Certificate, error)
    public Certificate(string name, CertificateArgs? args = null, CustomResourceOptions? opts = null)
    public Certificate(String name, CertificateArgs args)
    public Certificate(String name, CertificateArgs args, CustomResourceOptions options)
    
    type: fortios:user:Certificate
    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 CertificateArgs
    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 CertificateArgs
    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 CertificateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CertificateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CertificateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var certificateResource = new Fortios.User.Certificate("certificateResource", new()
    {
        CommonName = "string",
        Fosid = 0,
        Issuer = "string",
        Name = "string",
        Status = "string",
        Type = "string",
        Vdomparam = "string",
    });
    
    example, err := user.NewCertificate(ctx, "certificateResource", &user.CertificateArgs{
    	CommonName: pulumi.String("string"),
    	Fosid:      pulumi.Int(0),
    	Issuer:     pulumi.String("string"),
    	Name:       pulumi.String("string"),
    	Status:     pulumi.String("string"),
    	Type:       pulumi.String("string"),
    	Vdomparam:  pulumi.String("string"),
    })
    
    var certificateResource = new Certificate("certificateResource", CertificateArgs.builder()        
        .commonName("string")
        .fosid(0)
        .issuer("string")
        .name("string")
        .status("string")
        .type("string")
        .vdomparam("string")
        .build());
    
    certificate_resource = fortios.user.Certificate("certificateResource",
        common_name="string",
        fosid=0,
        issuer="string",
        name="string",
        status="string",
        type="string",
        vdomparam="string")
    
    const certificateResource = new fortios.user.Certificate("certificateResource", {
        commonName: "string",
        fosid: 0,
        issuer: "string",
        name: "string",
        status: "string",
        type: "string",
        vdomparam: "string",
    });
    
    type: fortios:user:Certificate
    properties:
        commonName: string
        fosid: 0
        issuer: string
        name: string
        status: string
        type: string
        vdomparam: string
    

    Certificate Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Certificate resource accepts the following input properties:

    CommonName string
    Certificate common name.
    Fosid int
    User ID.
    Issuer string
    CA certificate used for client certificate verification.
    Name string
    User name.
    Status string
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    Type string
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    CommonName string
    Certificate common name.
    Fosid int
    User ID.
    Issuer string
    CA certificate used for client certificate verification.
    Name string
    User name.
    Status string
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    Type string
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    commonName String
    Certificate common name.
    fosid Integer
    User ID.
    issuer String
    CA certificate used for client certificate verification.
    name String
    User name.
    status String
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    type String
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    commonName string
    Certificate common name.
    fosid number
    User ID.
    issuer string
    CA certificate used for client certificate verification.
    name string
    User name.
    status string
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    type string
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    common_name str
    Certificate common name.
    fosid int
    User ID.
    issuer str
    CA certificate used for client certificate verification.
    name str
    User name.
    status str
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    type str
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    commonName String
    Certificate common name.
    fosid Number
    User ID.
    issuer String
    CA certificate used for client certificate verification.
    name String
    User name.
    status String
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    type String
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Certificate 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 Certificate Resource

    Get an existing Certificate 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?: CertificateState, opts?: CustomResourceOptions): Certificate
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            common_name: Optional[str] = None,
            fosid: Optional[int] = None,
            issuer: Optional[str] = None,
            name: Optional[str] = None,
            status: Optional[str] = None,
            type: Optional[str] = None,
            vdomparam: Optional[str] = None) -> Certificate
    func GetCertificate(ctx *Context, name string, id IDInput, state *CertificateState, opts ...ResourceOption) (*Certificate, error)
    public static Certificate Get(string name, Input<string> id, CertificateState? state, CustomResourceOptions? opts = null)
    public static Certificate get(String name, Output<String> id, CertificateState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CommonName string
    Certificate common name.
    Fosid int
    User ID.
    Issuer string
    CA certificate used for client certificate verification.
    Name string
    User name.
    Status string
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    Type string
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    CommonName string
    Certificate common name.
    Fosid int
    User ID.
    Issuer string
    CA certificate used for client certificate verification.
    Name string
    User name.
    Status string
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    Type string
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    Vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    commonName String
    Certificate common name.
    fosid Integer
    User ID.
    issuer String
    CA certificate used for client certificate verification.
    name String
    User name.
    status String
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    type String
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    commonName string
    Certificate common name.
    fosid number
    User ID.
    issuer string
    CA certificate used for client certificate verification.
    name string
    User name.
    status string
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    type string
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    vdomparam string
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    common_name str
    Certificate common name.
    fosid int
    User ID.
    issuer str
    CA certificate used for client certificate verification.
    name str
    User name.
    status str
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    type str
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    vdomparam str
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.
    commonName String
    Certificate common name.
    fosid Number
    User ID.
    issuer String
    CA certificate used for client certificate verification.
    name String
    User name.
    status String
    Enable/disable allowing the certificate user to authenticate with the FortiGate unit. Valid values: enable, disable.
    type String
    Type of certificate authentication method. Valid values: single-certificate, trusted-issuer.
    vdomparam String
    Specifies the vdom to which the resource will be applied when the FortiGate unit is running in VDOM mode. Only one vdom can be specified. If you want to inherit the vdom configuration of the provider, please do not set this parameter.

    Import

    User Certificate can be imported using any of these accepted formats:

    $ pulumi import fortios:user/certificate:Certificate labelname {{name}}
    

    If you do not want to import arguments of block:

    $ export “FORTIOS_IMPORT_TABLE”=“false”

    $ pulumi import fortios:user/certificate:Certificate labelname {{name}}
    

    $ unset “FORTIOS_IMPORT_TABLE”

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    fortios pulumiverse/pulumi-fortios
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the fortios Terraform Provider.
    fortios logo
    Fortios v0.0.5 published on Tuesday, Apr 9, 2024 by pulumiverse