Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. FusionAuth
  3. API Docs
  4. FusionAuthEntityType
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
theogravity/pulumi-fusionauth

fusionauth.FusionAuthEntityType

Explore with Pulumi AI

fusionauth logo
FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
theogravity/pulumi-fusionauth

    # Entity Type Resource

    Entity Types categorize Entities. For example, an Entity Type could be Device, API or Company.

    Entity Type API

    Example Usage

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

const company = new fusionauth.FusionAuthEntityType("company", {
    data: JSON.stringify({
        createdBy: "jared@fusionauth.io",
    }),
    jwtConfiguration: {
        accessTokenKeyId: "a7516c7c-6234-4021-b0b4-8870c807aeb2",
        enabled: true,
        timeToLiveInSeconds: 3600,
    },
});

    import pulumi
import json
import theogravity_pulumi_fusionauth as fusionauth

company = fusionauth.FusionAuthEntityType("company",
    data=json.dumps({
        "createdBy": "jared@fusionauth.io",
    }),
    jwt_configuration=fusionauth.FusionAuthEntityTypeJwtConfigurationArgs(
        access_token_key_id="a7516c7c-6234-4021-b0b4-8870c807aeb2",
        enabled=True,
        time_to_live_in_seconds=3600,
    ))

    package main

import (
	"encoding/json"

	"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 {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"createdBy": "jared@fusionauth.io",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = fusionauth.NewFusionAuthEntityType(ctx, "company", &fusionauth.FusionAuthEntityTypeArgs{
			Data: pulumi.String(json0),
			JwtConfiguration: &fusionauth.FusionAuthEntityTypeJwtConfigurationArgs{
				AccessTokenKeyId:    pulumi.String("a7516c7c-6234-4021-b0b4-8870c807aeb2"),
				Enabled:             pulumi.Bool(true),
				TimeToLiveInSeconds: pulumi.Int(3600),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Fusionauth = theogravity.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var company = new Fusionauth.FusionAuthEntityType("company", new()
    {
        Data = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["createdBy"] = "jared@fusionauth.io",
        }),
        JwtConfiguration = new Fusionauth.Inputs.FusionAuthEntityTypeJwtConfigurationArgs
        {
            AccessTokenKeyId = "a7516c7c-6234-4021-b0b4-8870c807aeb2",
            Enabled = true,
            TimeToLiveInSeconds = 3600,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionAuthEntityType;
import com.pulumi.fusionauth.FusionAuthEntityTypeArgs;
import com.pulumi.fusionauth.inputs.FusionAuthEntityTypeJwtConfigurationArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 company = new FusionAuthEntityType("company", FusionAuthEntityTypeArgs.builder()
            .data(serializeJson(
                jsonObject(
                    jsonProperty("createdBy", "jared@fusionauth.io")
                )))
            .jwtConfiguration(FusionAuthEntityTypeJwtConfigurationArgs.builder()
                .accessTokenKeyId("a7516c7c-6234-4021-b0b4-8870c807aeb2")
                .enabled(true)
                .timeToLiveInSeconds(3600)
                .build())
            .build());

    }
}

    resources:
  company:
    type: fusionauth:FusionAuthEntityType
    properties:
      data:
        fn::toJSON:
          createdBy: jared@fusionauth.io
      jwtConfiguration:
        accessTokenKeyId: a7516c7c-6234-4021-b0b4-8870c807aeb2
        enabled: true
        timeToLiveInSeconds: 3600

    Create FusionAuthEntityType Resource

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

    Constructor syntax

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

@overload
def FusionAuthEntityType(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         data: Optional[str] = None,
                         entity_type_id: Optional[str] = None,
                         jwt_configuration: Optional[FusionAuthEntityTypeJwtConfigurationArgs] = None,
                         name: Optional[str] = None)
    func NewFusionAuthEntityType(ctx *Context, name string, args *FusionAuthEntityTypeArgs, opts ...ResourceOption) (*FusionAuthEntityType, error)
    public FusionAuthEntityType(string name, FusionAuthEntityTypeArgs? args = null, CustomResourceOptions? opts = null)
    public FusionAuthEntityType(String name, FusionAuthEntityTypeArgs args)
public FusionAuthEntityType(String name, FusionAuthEntityTypeArgs args, CustomResourceOptions options)

    type: fusionauth:FusionAuthEntityType
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 FusionAuthEntityTypeArgs
    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 FusionAuthEntityTypeArgs
    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 FusionAuthEntityTypeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FusionAuthEntityTypeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FusionAuthEntityTypeArgs
    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 fusionAuthEntityTypeResource = new Fusionauth.FusionAuthEntityType("fusionAuthEntityTypeResource", new()
{
    Data = "string",
    EntityTypeId = "string",
    JwtConfiguration = new Fusionauth.Inputs.FusionAuthEntityTypeJwtConfigurationArgs
    {
        AccessTokenKeyId = "string",
        Enabled = false,
        TimeToLiveInSeconds = 0,
    },
    Name = "string",
});

    example, err := fusionauth.NewFusionAuthEntityType(ctx, "fusionAuthEntityTypeResource", &fusionauth.FusionAuthEntityTypeArgs{
	Data:         pulumi.String("string"),
	EntityTypeId: pulumi.String("string"),
	JwtConfiguration: &fusionauth.FusionAuthEntityTypeJwtConfigurationArgs{
		AccessTokenKeyId:    pulumi.String("string"),
		Enabled:             pulumi.Bool(false),
		TimeToLiveInSeconds: pulumi.Int(0),
	},
	Name: pulumi.String("string"),
})

    var fusionAuthEntityTypeResource = new FusionAuthEntityType("fusionAuthEntityTypeResource", FusionAuthEntityTypeArgs.builder()
    .data("string")
    .entityTypeId("string")
    .jwtConfiguration(FusionAuthEntityTypeJwtConfigurationArgs.builder()
        .accessTokenKeyId("string")
        .enabled(false)
        .timeToLiveInSeconds(0)
        .build())
    .name("string")
    .build());

    fusion_auth_entity_type_resource = fusionauth.FusionAuthEntityType("fusionAuthEntityTypeResource",
    data="string",
    entity_type_id="string",
    jwt_configuration={
        "access_token_key_id": "string",
        "enabled": False,
        "time_to_live_in_seconds": 0,
    },
    name="string")

    const fusionAuthEntityTypeResource = new fusionauth.FusionAuthEntityType("fusionAuthEntityTypeResource", {
    data: "string",
    entityTypeId: "string",
    jwtConfiguration: {
        accessTokenKeyId: "string",
        enabled: false,
        timeToLiveInSeconds: 0,
    },
    name: "string",
});

    type: fusionauth:FusionAuthEntityType
properties:
    data: string
    entityTypeId: string
    jwtConfiguration:
        accessTokenKeyId: string
        enabled: false
        timeToLiveInSeconds: 0
    name: string

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

    Data string
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    EntityTypeId string
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    JwtConfiguration theogravity.Fusionauth.Inputs.FusionAuthEntityTypeJwtConfiguration
    A block to configure JSON Web Token (JWT) options.
    Name string
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    Data string
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    EntityTypeId string
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    JwtConfiguration FusionAuthEntityTypeJwtConfigurationArgs
    A block to configure JSON Web Token (JWT) options.
    Name string
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    data String
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    entityTypeId String
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    jwtConfiguration FusionAuthEntityTypeJwtConfiguration
    A block to configure JSON Web Token (JWT) options.
    name String
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    data string
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    entityTypeId string
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    jwtConfiguration FusionAuthEntityTypeJwtConfiguration
    A block to configure JSON Web Token (JWT) options.
    name string
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    data str
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    entity_type_id str
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    jwt_configuration FusionAuthEntityTypeJwtConfigurationArgs
    A block to configure JSON Web Token (JWT) options.
    name str
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    data String
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    entityTypeId String
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    jwtConfiguration Property Map
    A block to configure JSON Web Token (JWT) options.
    name String
    A descriptive name for the entity type (i.e. Customer or Email_Service).

    Outputs

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

    Get an existing FusionAuthEntityType 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?: FusionAuthEntityTypeState, opts?: CustomResourceOptions): FusionAuthEntityType
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data: Optional[str] = None,
        entity_type_id: Optional[str] = None,
        jwt_configuration: Optional[FusionAuthEntityTypeJwtConfigurationArgs] = None,
        name: Optional[str] = None) -> FusionAuthEntityType
    func GetFusionAuthEntityType(ctx *Context, name string, id IDInput, state *FusionAuthEntityTypeState, opts ...ResourceOption) (*FusionAuthEntityType, error)
    public static FusionAuthEntityType Get(string name, Input<string> id, FusionAuthEntityTypeState? state, CustomResourceOptions? opts = null)
    public static FusionAuthEntityType get(String name, Output<String> id, FusionAuthEntityTypeState 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:
    Data string
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    EntityTypeId string
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    JwtConfiguration theogravity.Fusionauth.Inputs.FusionAuthEntityTypeJwtConfiguration
    A block to configure JSON Web Token (JWT) options.
    Name string
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    Data string
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    EntityTypeId string
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    JwtConfiguration FusionAuthEntityTypeJwtConfigurationArgs
    A block to configure JSON Web Token (JWT) options.
    Name string
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    data String
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    entityTypeId String
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    jwtConfiguration FusionAuthEntityTypeJwtConfiguration
    A block to configure JSON Web Token (JWT) options.
    name String
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    data string
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    entityTypeId string
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    jwtConfiguration FusionAuthEntityTypeJwtConfiguration
    A block to configure JSON Web Token (JWT) options.
    name string
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    data str
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    entity_type_id str
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    jwt_configuration FusionAuthEntityTypeJwtConfigurationArgs
    A block to configure JSON Web Token (JWT) options.
    name str
    A descriptive name for the entity type (i.e. Customer or Email_Service).
    data String
    An object that can hold any information about the Entity Type that should be persisted. Must be a JSON string.
    entityTypeId String
    The ID to use for the new Entity Type. If not specified a secure random UUID will be generated.
    jwtConfiguration Property Map
    A block to configure JSON Web Token (JWT) options.
    name String
    A descriptive name for the entity type (i.e. Customer or Email_Service).

    Supporting Types

    FusionAuthEntityTypeJwtConfiguration, FusionAuthEntityTypeJwtConfigurationArgs

    AccessTokenKeyId string
    The unique ID of the signing key used to sign the access token. Required when enabled is set to true.
    Enabled bool
    Indicates if this application is using the JWT configuration defined here or the global JWT configuration defined by the Tenant. If this is false the signing algorithm configured in the Tenant will be used. If true the signing algorithm defined in this application will be used.
    TimeToLiveInSeconds int
    The length of time in seconds the JWT will live before it is expired and no longer valid. Required when enabled is set to true.
    AccessTokenKeyId string
    The unique ID of the signing key used to sign the access token. Required when enabled is set to true.
    Enabled bool
    Indicates if this application is using the JWT configuration defined here or the global JWT configuration defined by the Tenant. If this is false the signing algorithm configured in the Tenant will be used. If true the signing algorithm defined in this application will be used.
    TimeToLiveInSeconds int
    The length of time in seconds the JWT will live before it is expired and no longer valid. Required when enabled is set to true.
    accessTokenKeyId String
    The unique ID of the signing key used to sign the access token. Required when enabled is set to true.
    enabled Boolean
    Indicates if this application is using the JWT configuration defined here or the global JWT configuration defined by the Tenant. If this is false the signing algorithm configured in the Tenant will be used. If true the signing algorithm defined in this application will be used.
    timeToLiveInSeconds Integer
    The length of time in seconds the JWT will live before it is expired and no longer valid. Required when enabled is set to true.
    accessTokenKeyId string
    The unique ID of the signing key used to sign the access token. Required when enabled is set to true.
    enabled boolean
    Indicates if this application is using the JWT configuration defined here or the global JWT configuration defined by the Tenant. If this is false the signing algorithm configured in the Tenant will be used. If true the signing algorithm defined in this application will be used.
    timeToLiveInSeconds number
    The length of time in seconds the JWT will live before it is expired and no longer valid. Required when enabled is set to true.
    access_token_key_id str
    The unique ID of the signing key used to sign the access token. Required when enabled is set to true.
    enabled bool
    Indicates if this application is using the JWT configuration defined here or the global JWT configuration defined by the Tenant. If this is false the signing algorithm configured in the Tenant will be used. If true the signing algorithm defined in this application will be used.
    time_to_live_in_seconds int
    The length of time in seconds the JWT will live before it is expired and no longer valid. Required when enabled is set to true.
    accessTokenKeyId String
    The unique ID of the signing key used to sign the access token. Required when enabled is set to true.
    enabled Boolean
    Indicates if this application is using the JWT configuration defined here or the global JWT configuration defined by the Tenant. If this is false the signing algorithm configured in the Tenant will be used. If true the signing algorithm defined in this application will be used.
    timeToLiveInSeconds Number
    The length of time in seconds the JWT will live before it is expired and no longer valid. Required when enabled is set to true.

    Package Details

    Repository
    fusionauth theogravity/pulumi-fusionauth
    License
    MIT
    Notes
    This Pulumi package is based on the fusionauth Terraform Provider.
    fusionauth logo
    FusionAuth v5.1.0 published on Tuesday, Oct 22, 2024 by Theo Gravity
    theogravity/pulumi-fusionauth