FusionAuth

v0.9.7 published on Thursday, Jul 28, 2022 by Theo Gravity

FusionAuthKey

# Key Resource

Cryptographic keys are used in signing and verifying JWTs and verifying responses for third party identity providers. It is more likely you will interact with keys using the FusionAuth UI in the Key Master menu.

Keys API

Example Usage

using Pulumi;
using Fusionauth = theogravity.Fusionauth;

class MyStack : Stack
{
    public MyStack()
    {
        var adminId = new Fusionauth.FusionAuthKey("adminId", new Fusionauth.FusionAuthKeyArgs
        {
            Algorithm = "RS256",
            Length = 2048,
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/theogravity/pulumi-fusionauth/sdk/go/fusionauth"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fusionauth.NewFusionAuthKey(ctx, "adminId", &fusionauth.FusionAuthKeyArgs{
			Algorithm: pulumi.String("RS256"),
			Length:    pulumi.Int(2048),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var adminId = new FusionAuthKey("adminId", FusionAuthKeyArgs.builder()        
            .algorithm("RS256")
            .length(2048)
            .build());

    }
}
import pulumi
import theogravity_pulumi-fusionauth as fusionauth

admin_id = fusionauth.FusionAuthKey("adminId",
    algorithm="RS256",
    length=2048)
import * as pulumi from "@pulumi/pulumi";
import * as fusionauth from "@pulumi/fusionauth";

const adminId = new fusionauth.FusionAuthKey("admin_id", {
    algorithm: "RS256",
    length: 2048,
});
resources:
  adminId:
    type: fusionauth:FusionAuthKey
    properties:
      algorithm: RS256
      length: 2048

Create a FusionAuthKey Resource

new FusionAuthKey(name: string, args: FusionAuthKeyArgs, opts?: CustomResourceOptions);
@overload
def FusionAuthKey(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  algorithm: Optional[str] = None,
                  key_id: Optional[str] = None,
                  length: Optional[int] = None,
                  name: Optional[str] = None)
@overload
def FusionAuthKey(resource_name: str,
                  args: FusionAuthKeyArgs,
                  opts: Optional[ResourceOptions] = None)
func NewFusionAuthKey(ctx *Context, name string, args FusionAuthKeyArgs, opts ...ResourceOption) (*FusionAuthKey, error)
public FusionAuthKey(string name, FusionAuthKeyArgs args, CustomResourceOptions? opts = null)
public FusionAuthKey(String name, FusionAuthKeyArgs args)
public FusionAuthKey(String name, FusionAuthKeyArgs args, CustomResourceOptions options)
type: fusionauth:FusionAuthKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args FusionAuthKeyArgs
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 FusionAuthKeyArgs
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 FusionAuthKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FusionAuthKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FusionAuthKeyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

Algorithm string

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

KeyId string

The Id to use for the new key. If not specified a secure random UUID will be generated.

Length int

The length of the RSA or EC certificate. This field is required when generating RSA key types.

Name string

The name of the Key.

Algorithm string

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

KeyId string

The Id to use for the new key. If not specified a secure random UUID will be generated.

Length int

The length of the RSA or EC certificate. This field is required when generating RSA key types.

Name string

The name of the Key.

algorithm String

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

keyId String

The Id to use for the new key. If not specified a secure random UUID will be generated.

length Integer

The length of the RSA or EC certificate. This field is required when generating RSA key types.

name String

The name of the Key.

algorithm string

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

keyId string

The Id to use for the new key. If not specified a secure random UUID will be generated.

length number

The length of the RSA or EC certificate. This field is required when generating RSA key types.

name string

The name of the Key.

algorithm str

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

key_id str

The Id to use for the new key. If not specified a secure random UUID will be generated.

length int

The length of the RSA or EC certificate. This field is required when generating RSA key types.

name str

The name of the Key.

algorithm String

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

keyId String

The Id to use for the new key. If not specified a secure random UUID will be generated.

length Number

The length of the RSA or EC certificate. This field is required when generating RSA key types.

name String

The name of the Key.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Kid string

The id used in the JWT header to identify the key used to generate the signature

Id string

The provider-assigned unique ID for this managed resource.

Kid string

The id used in the JWT header to identify the key used to generate the signature

id String

The provider-assigned unique ID for this managed resource.

kid String

The id used in the JWT header to identify the key used to generate the signature

id string

The provider-assigned unique ID for this managed resource.

kid string

The id used in the JWT header to identify the key used to generate the signature

id str

The provider-assigned unique ID for this managed resource.

kid str

The id used in the JWT header to identify the key used to generate the signature

id String

The provider-assigned unique ID for this managed resource.

kid String

The id used in the JWT header to identify the key used to generate the signature

Look up an Existing FusionAuthKey Resource

Get an existing FusionAuthKey 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?: FusionAuthKeyState, opts?: CustomResourceOptions): FusionAuthKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        algorithm: Optional[str] = None,
        key_id: Optional[str] = None,
        kid: Optional[str] = None,
        length: Optional[int] = None,
        name: Optional[str] = None) -> FusionAuthKey
func GetFusionAuthKey(ctx *Context, name string, id IDInput, state *FusionAuthKeyState, opts ...ResourceOption) (*FusionAuthKey, error)
public static FusionAuthKey Get(string name, Input<string> id, FusionAuthKeyState? state, CustomResourceOptions? opts = null)
public static FusionAuthKey get(String name, Output<String> id, FusionAuthKeyState 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:
Algorithm string

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

KeyId string

The Id to use for the new key. If not specified a secure random UUID will be generated.

Kid string

The id used in the JWT header to identify the key used to generate the signature

Length int

The length of the RSA or EC certificate. This field is required when generating RSA key types.

Name string

The name of the Key.

Algorithm string

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

KeyId string

The Id to use for the new key. If not specified a secure random UUID will be generated.

Kid string

The id used in the JWT header to identify the key used to generate the signature

Length int

The length of the RSA or EC certificate. This field is required when generating RSA key types.

Name string

The name of the Key.

algorithm String

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

keyId String

The Id to use for the new key. If not specified a secure random UUID will be generated.

kid String

The id used in the JWT header to identify the key used to generate the signature

length Integer

The length of the RSA or EC certificate. This field is required when generating RSA key types.

name String

The name of the Key.

algorithm string

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

keyId string

The Id to use for the new key. If not specified a secure random UUID will be generated.

kid string

The id used in the JWT header to identify the key used to generate the signature

length number

The length of the RSA or EC certificate. This field is required when generating RSA key types.

name string

The name of the Key.

algorithm str

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

key_id str

The Id to use for the new key. If not specified a secure random UUID will be generated.

kid str

The id used in the JWT header to identify the key used to generate the signature

length int

The length of the RSA or EC certificate. This field is required when generating RSA key types.

name str

The name of the Key.

algorithm String

The algorithm used to encrypt the Key. The following values represent algorithms supported by FusionAuth:

keyId String

The Id to use for the new key. If not specified a secure random UUID will be generated.

kid String

The id used in the JWT header to identify the key used to generate the signature

length Number

The length of the RSA or EC certificate. This field is required when generating RSA key types.

name String

The name of the Key.

Package Details

Repository
https://github.com/theogravity/pulumi-fusionauth
License
MIT
Notes

This Pulumi package is based on the fusionauth Terraform Provider.