Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthApiKey
FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.FusionAuthApiKey

Explore with Pulumi AI

FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity
theogravity/pulumi-fusionauth

# API Key

The FusionAuth APIs are primarily secured using API keys. This API can only be accessed using an API key that is set as a keyManager. In order to retrieve, update or delete an API key, an API key with equal or greater permissions must be used. A “tenant-scoped” API key can retrieve, create, update or delete an API key for the same tenant. This page describes APIs that are used to manage API keys.

API Key

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as fusionauth from "pulumi-fusionauth";

const example = new fusionauth.FusionAuthApiKey("example", {
    description: "my super secret key",
    key: "super-secret-key",
    permissionsEndpoints: [{
        "delete": true,
        endpoint: "/api/application",
        get: true,
        patch: true,
        post: true,
        put: true,
    }],
    tenantId: "94f751c5-4883-4684-a817-6b106778edec",
});
Copy
import pulumi
import theogravity_pulumi_fusionauth as fusionauth

example = fusionauth.FusionAuthApiKey("example",
    description="my super secret key",
    key="super-secret-key",
    permissions_endpoints=[{
        "delete": True,
        "endpoint": "/api/application",
        "get": True,
        "patch": True,
        "post": True,
        "put": True,
    }],
    tenant_id="94f751c5-4883-4684-a817-6b106778edec")
Copy
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.NewFusionAuthApiKey(ctx, "example", &fusionauth.FusionAuthApiKeyArgs{
			Description: pulumi.String("my super secret key"),
			Key:         pulumi.String("super-secret-key"),
			PermissionsEndpoints: fusionauth.FusionAuthApiKeyPermissionsEndpointArray{
				&fusionauth.FusionAuthApiKeyPermissionsEndpointArgs{
					Delete:   pulumi.Bool(true),
					Endpoint: pulumi.String("/api/application"),
					Get:      pulumi.Bool(true),
					Patch:    pulumi.Bool(true),
					Post:     pulumi.Bool(true),
					Put:      pulumi.Bool(true),
				},
			},
			TenantId: pulumi.String("94f751c5-4883-4684-a817-6b106778edec"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var example = new Fusionauth.FusionAuthApiKey("example", new()
    {
        Description = "my super secret key",
        Key = "super-secret-key",
        PermissionsEndpoints = new[]
        {
            new Fusionauth.Inputs.FusionAuthApiKeyPermissionsEndpointArgs
            {
                Delete = true,
                Endpoint = "/api/application",
                Get = true,
                Patch = true,
                Post = true,
                Put = true,
            },
        },
        TenantId = "94f751c5-4883-4684-a817-6b106778edec",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthApiKey;
import com.pulumi.fusionauth.FusionAuthApiKeyArgs;
import com.pulumi.fusionauth.inputs.FusionAuthApiKeyPermissionsEndpointArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        var example = new FusionAuthApiKey("example", FusionAuthApiKeyArgs.builder()
            .description("my super secret key")
            .key("super-secret-key")
            .permissionsEndpoints(FusionAuthApiKeyPermissionsEndpointArgs.builder()
                .delete(true)
                .endpoint("/api/application")
                .get(true)
                .patch(true)
                .post(true)
                .put(true)
                .build())
            .tenantId("94f751c5-4883-4684-a817-6b106778edec")
            .build());

    }
}
Copy
resources:
  example:
    type: fusionauth:FusionAuthApiKey
    properties:
      description: my super secret key
      key: super-secret-key
      permissionsEndpoints:
        - delete: true
          endpoint: /api/application
          get: true
          patch: true
          post: true
          put: true
      tenantId: 94f751c5-4883-4684-a817-6b106778edec
Copy

Create FusionAuthApiKey Resource

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

Constructor syntax

new FusionAuthApiKey(name: string, args?: FusionAuthApiKeyArgs, opts?: CustomResourceOptions);
@overload
def FusionAuthApiKey(resource_name: str,
                     args: Optional[FusionAuthApiKeyArgs] = None,
                     opts: Optional[ResourceOptions] = None)

@overload
def FusionAuthApiKey(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     description: Optional[str] = None,
                     expiration_instant: Optional[int] = None,
                     ip_access_control_list_id: Optional[str] = None,
                     key: Optional[str] = None,
                     key_id: Optional[str] = None,
                     permissions_endpoints: Optional[Sequence[FusionAuthApiKeyPermissionsEndpointArgs]] = None,
                     tenant_id: Optional[str] = None)
func NewFusionAuthApiKey(ctx *Context, name string, args *FusionAuthApiKeyArgs, opts ...ResourceOption) (*FusionAuthApiKey, error)
public FusionAuthApiKey(string name, FusionAuthApiKeyArgs? args = null, CustomResourceOptions? opts = null)
public FusionAuthApiKey(String name, FusionAuthApiKeyArgs args)
public FusionAuthApiKey(String name, FusionAuthApiKeyArgs args, CustomResourceOptions options)

type: fusionauth:FusionAuthApiKey
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args FusionAuthApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args FusionAuthApiKeyArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args FusionAuthApiKeyArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args FusionAuthApiKeyArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FusionAuthApiKeyArgs
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 fusionAuthApiKeyResource = new Fusionauth.FusionAuthApiKey("fusionAuthApiKeyResource", new()
{
    Description = "string",
    ExpirationInstant = 0,
    IpAccessControlListId = "string",
    Key = "string",
    KeyId = "string",
    PermissionsEndpoints = new[]
    {
        new Fusionauth.Inputs.FusionAuthApiKeyPermissionsEndpointArgs
        {
            Endpoint = "string",
            Delete = false,
            Get = false,
            Patch = false,
            Post = false,
            Put = false,
        },
    },
    TenantId = "string",
});
Copy
example, err := fusionauth.NewFusionAuthApiKey(ctx, "fusionAuthApiKeyResource", &fusionauth.FusionAuthApiKeyArgs{
	Description:           pulumi.String("string"),
	ExpirationInstant:     pulumi.Int(0),
	IpAccessControlListId: pulumi.String("string"),
	Key:                   pulumi.String("string"),
	KeyId:                 pulumi.String("string"),
	PermissionsEndpoints: fusionauth.FusionAuthApiKeyPermissionsEndpointArray{
		&fusionauth.FusionAuthApiKeyPermissionsEndpointArgs{
			Endpoint: pulumi.String("string"),
			Delete:   pulumi.Bool(false),
			Get:      pulumi.Bool(false),
			Patch:    pulumi.Bool(false),
			Post:     pulumi.Bool(false),
			Put:      pulumi.Bool(false),
		},
	},
	TenantId: pulumi.String("string"),
})
Copy
var fusionAuthApiKeyResource = new FusionAuthApiKey("fusionAuthApiKeyResource", FusionAuthApiKeyArgs.builder()
    .description("string")
    .expirationInstant(0)
    .ipAccessControlListId("string")
    .key("string")
    .keyId("string")
    .permissionsEndpoints(FusionAuthApiKeyPermissionsEndpointArgs.builder()
        .endpoint("string")
        .delete(false)
        .get(false)
        .patch(false)
        .post(false)
        .put(false)
        .build())
    .tenantId("string")
    .build());
Copy
fusion_auth_api_key_resource = fusionauth.FusionAuthApiKey("fusionAuthApiKeyResource",
    description="string",
    expiration_instant=0,
    ip_access_control_list_id="string",
    key="string",
    key_id="string",
    permissions_endpoints=[{
        "endpoint": "string",
        "delete": False,
        "get": False,
        "patch": False,
        "post": False,
        "put": False,
    }],
    tenant_id="string")
Copy
const fusionAuthApiKeyResource = new fusionauth.FusionAuthApiKey("fusionAuthApiKeyResource", {
    description: "string",
    expirationInstant: 0,
    ipAccessControlListId: "string",
    key: "string",
    keyId: "string",
    permissionsEndpoints: [{
        endpoint: "string",
        "delete": false,
        get: false,
        patch: false,
        post: false,
        put: false,
    }],
    tenantId: "string",
});
Copy
type: fusionauth:FusionAuthApiKey
properties:
    description: string
    expirationInstant: 0
    ipAccessControlListId: string
    key: string
    keyId: string
    permissionsEndpoints:
        - delete: false
          endpoint: string
          get: false
          patch: false
          post: false
          put: false
    tenantId: string
Copy

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

Description string
Description of the key.
ExpirationInstant int
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
IpAccessControlListId string
The Id of the IP Access Control List limiting access to this API key.
Key Changes to this property will trigger replacement. string
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
KeyId string
The Id to use for the new Form. If not specified a secure random UUID will be generated.
PermissionsEndpoints List<theogravity.Fusionauth.Inputs.FusionAuthApiKeyPermissionsEndpoint>
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
TenantId Changes to this property will trigger replacement. string
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
Description string
Description of the key.
ExpirationInstant int
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
IpAccessControlListId string
The Id of the IP Access Control List limiting access to this API key.
Key Changes to this property will trigger replacement. string
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
KeyId string
The Id to use for the new Form. If not specified a secure random UUID will be generated.
PermissionsEndpoints []FusionAuthApiKeyPermissionsEndpointArgs
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
TenantId Changes to this property will trigger replacement. string
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
description String
Description of the key.
expirationInstant Integer
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
ipAccessControlListId String
The Id of the IP Access Control List limiting access to this API key.
key Changes to this property will trigger replacement. String
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
keyId String
The Id to use for the new Form. If not specified a secure random UUID will be generated.
permissionsEndpoints List<FusionAuthApiKeyPermissionsEndpoint>
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
tenantId Changes to this property will trigger replacement. String
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
description string
Description of the key.
expirationInstant number
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
ipAccessControlListId string
The Id of the IP Access Control List limiting access to this API key.
key Changes to this property will trigger replacement. string
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
keyId string
The Id to use for the new Form. If not specified a secure random UUID will be generated.
permissionsEndpoints FusionAuthApiKeyPermissionsEndpoint[]
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
tenantId Changes to this property will trigger replacement. string
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
description str
Description of the key.
expiration_instant int
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
ip_access_control_list_id str
The Id of the IP Access Control List limiting access to this API key.
key Changes to this property will trigger replacement. str
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
key_id str
The Id to use for the new Form. If not specified a secure random UUID will be generated.
permissions_endpoints Sequence[FusionAuthApiKeyPermissionsEndpointArgs]
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
tenant_id Changes to this property will trigger replacement. str
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
description String
Description of the key.
expirationInstant Number
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
ipAccessControlListId String
The Id of the IP Access Control List limiting access to this API key.
key Changes to this property will trigger replacement. String
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
keyId String
The Id to use for the new Form. If not specified a secure random UUID will be generated.
permissionsEndpoints List<Property Map>
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
tenantId Changes to this property will trigger replacement. String
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.

Outputs

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

Get an existing FusionAuthApiKey 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?: FusionAuthApiKeyState, opts?: CustomResourceOptions): FusionAuthApiKey
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        expiration_instant: Optional[int] = None,
        ip_access_control_list_id: Optional[str] = None,
        key: Optional[str] = None,
        key_id: Optional[str] = None,
        permissions_endpoints: Optional[Sequence[FusionAuthApiKeyPermissionsEndpointArgs]] = None,
        tenant_id: Optional[str] = None) -> FusionAuthApiKey
func GetFusionAuthApiKey(ctx *Context, name string, id IDInput, state *FusionAuthApiKeyState, opts ...ResourceOption) (*FusionAuthApiKey, error)
public static FusionAuthApiKey Get(string name, Input<string> id, FusionAuthApiKeyState? state, CustomResourceOptions? opts = null)
public static FusionAuthApiKey get(String name, Output<String> id, FusionAuthApiKeyState state, CustomResourceOptions options)
resources:  _:    type: fusionauth:FusionAuthApiKey    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
Description string
Description of the key.
ExpirationInstant int
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
IpAccessControlListId string
The Id of the IP Access Control List limiting access to this API key.
Key Changes to this property will trigger replacement. string
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
KeyId string
The Id to use for the new Form. If not specified a secure random UUID will be generated.
PermissionsEndpoints List<theogravity.Fusionauth.Inputs.FusionAuthApiKeyPermissionsEndpoint>
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
TenantId Changes to this property will trigger replacement. string
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
Description string
Description of the key.
ExpirationInstant int
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
IpAccessControlListId string
The Id of the IP Access Control List limiting access to this API key.
Key Changes to this property will trigger replacement. string
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
KeyId string
The Id to use for the new Form. If not specified a secure random UUID will be generated.
PermissionsEndpoints []FusionAuthApiKeyPermissionsEndpointArgs
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
TenantId Changes to this property will trigger replacement. string
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
description String
Description of the key.
expirationInstant Integer
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
ipAccessControlListId String
The Id of the IP Access Control List limiting access to this API key.
key Changes to this property will trigger replacement. String
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
keyId String
The Id to use for the new Form. If not specified a secure random UUID will be generated.
permissionsEndpoints List<FusionAuthApiKeyPermissionsEndpoint>
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
tenantId Changes to this property will trigger replacement. String
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
description string
Description of the key.
expirationInstant number
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
ipAccessControlListId string
The Id of the IP Access Control List limiting access to this API key.
key Changes to this property will trigger replacement. string
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
keyId string
The Id to use for the new Form. If not specified a secure random UUID will be generated.
permissionsEndpoints FusionAuthApiKeyPermissionsEndpoint[]
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
tenantId Changes to this property will trigger replacement. string
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
description str
Description of the key.
expiration_instant int
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
ip_access_control_list_id str
The Id of the IP Access Control List limiting access to this API key.
key Changes to this property will trigger replacement. str
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
key_id str
The Id to use for the new Form. If not specified a secure random UUID will be generated.
permissions_endpoints Sequence[FusionAuthApiKeyPermissionsEndpointArgs]
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
tenant_id Changes to this property will trigger replacement. str
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
description String
Description of the key.
expirationInstant Number
The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
ipAccessControlListId String
The Id of the IP Access Control List limiting access to this API key.
key Changes to this property will trigger replacement. String
API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
keyId String
The Id to use for the new Form. If not specified a secure random UUID will be generated.
permissionsEndpoints List<Property Map>
Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissions_endpoints object mean that this is a super key that authorizes this key for all the endpoints.
tenantId Changes to this property will trigger replacement. String
The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.

Supporting Types

FusionAuthApiKeyPermissionsEndpoint
, FusionAuthApiKeyPermissionsEndpointArgs

Endpoint This property is required. string
Delete bool
HTTP DELETE Verb
Get bool
HTTP GET Verb
Patch bool
HTTP PATCH Verb
Post bool
HTTP POST Verb
Put bool
HTTP PUT Verb
Endpoint This property is required. string
Delete bool
HTTP DELETE Verb
Get bool
HTTP GET Verb
Patch bool
HTTP PATCH Verb
Post bool
HTTP POST Verb
Put bool
HTTP PUT Verb
endpoint This property is required. String
delete Boolean
HTTP DELETE Verb
get Boolean
HTTP GET Verb
patch Boolean
HTTP PATCH Verb
post Boolean
HTTP POST Verb
put Boolean
HTTP PUT Verb
endpoint This property is required. string
delete boolean
HTTP DELETE Verb
get boolean
HTTP GET Verb
patch boolean
HTTP PATCH Verb
post boolean
HTTP POST Verb
put boolean
HTTP PUT Verb
endpoint This property is required. str
delete bool
HTTP DELETE Verb
get bool
HTTP GET Verb
patch bool
HTTP PATCH Verb
post bool
HTTP POST Verb
put bool
HTTP PUT Verb
endpoint This property is required. String
delete Boolean
HTTP DELETE Verb
get Boolean
HTTP GET Verb
patch Boolean
HTTP PATCH Verb
post Boolean
HTTP POST Verb
put Boolean
HTTP PUT Verb

Package Details

Repository
fusionauth theogravity/pulumi-fusionauth
License
MIT
Notes
This Pulumi package is based on the fusionauth Terraform Provider.
FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity
theogravity/pulumi-fusionauth