fusionauth.FusionAuthEntity

# Entity Resource

Entities are arbitrary objects which can be modeled in FusionAuth. Anything which is not a user but might need permissions managed by FusionAuth is a possible entity. Examples might include devices, cars, computers, customers, companies, etc.

FusionAuth’s Entity Management has the following major concepts:

• Entity Types categorize Entities. An Entity Type could be Device, API or Company.
• Permissions are defined on an Entity Type. These are arbitrary strings which can fit the business domain. A Permission could be read, write, or file-lawsuit.
• Entities are instances of a single type. An Entity could be a nest device, an Email API or Raviga.
• Entities can have Grants. Grants are relationships between a target Entity and one of two other types: a recipient Entity or a User. Grants can have zero or more Permissions associated with them.

You can use the Client Credentials grant to see if an Entity has permission to access another Entity.

Entity API

Create FusionAuthEntity Resource

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

Constructor syntax

new FusionAuthEntity(name: string, args: FusionAuthEntityArgs, opts?: CustomResourceOptions);

@overload
def FusionAuthEntity(resource_name: str,
                     args: FusionAuthEntityArgs,
                     opts: Optional[ResourceOptions] = None)

@overload
def FusionAuthEntity(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     entity_type_id: Optional[str] = None,
                     client_id: Optional[str] = None,
                     client_secret: Optional[str] = None,
                     data: Optional[str] = None,
                     entity_id: Optional[str] = None,
                     name: Optional[str] = None,
                     tenant_id: Optional[str] = None)

func NewFusionAuthEntity(ctx *Context, name string, args FusionAuthEntityArgs, opts ...ResourceOption) (*FusionAuthEntity, error)

public FusionAuthEntity(string name, FusionAuthEntityArgs args, CustomResourceOptions? opts = null)

public FusionAuthEntity(String name, FusionAuthEntityArgs args)
public FusionAuthEntity(String name, FusionAuthEntityArgs args, CustomResourceOptions options)

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

Parameters

Constructor example

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

var fusionAuthEntityResource = new Fusionauth.FusionAuthEntity("fusionAuthEntityResource", new()
{
    EntityTypeId = "string",
    ClientId = "string",
    ClientSecret = "string",
    Data = "string",
    EntityId = "string",
    Name = "string",
    TenantId = "string",
});

example, err := fusionauth.NewFusionAuthEntity(ctx, "fusionAuthEntityResource", &fusionauth.FusionAuthEntityArgs{
	EntityTypeId: pulumi.String("string"),
	ClientId:     pulumi.String("string"),
	ClientSecret: pulumi.String("string"),
	Data:         pulumi.String("string"),
	EntityId:     pulumi.String("string"),
	Name:         pulumi.String("string"),
	TenantId:     pulumi.String("string"),
})

var fusionAuthEntityResource = new FusionAuthEntity("fusionAuthEntityResource", FusionAuthEntityArgs.builder()
    .entityTypeId("string")
    .clientId("string")
    .clientSecret("string")
    .data("string")
    .entityId("string")
    .name("string")
    .tenantId("string")
    .build());

fusion_auth_entity_resource = fusionauth.FusionAuthEntity("fusionAuthEntityResource",
    entity_type_id="string",
    client_id="string",
    client_secret="string",
    data="string",
    entity_id="string",
    name="string",
    tenant_id="string")

const fusionAuthEntityResource = new fusionauth.FusionAuthEntity("fusionAuthEntityResource", {
    entityTypeId: "string",
    clientId: "string",
    clientSecret: "string",
    data: "string",
    entityId: "string",
    name: "string",
    tenantId: "string",
});

type: fusionauth:FusionAuthEntity
properties:
    clientId: string
    clientSecret: string
    data: string
    entityId: string
    entityTypeId: string
    name: string
    tenantId: string

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

Outputs

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

Look up Existing FusionAuthEntity Resource

Get an existing FusionAuthEntity 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?: FusionAuthEntityState, opts?: CustomResourceOptions): FusionAuthEntity

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        data: Optional[str] = None,
        entity_id: Optional[str] = None,
        entity_type_id: Optional[str] = None,
        name: Optional[str] = None,
        tenant_id: Optional[str] = None) -> FusionAuthEntity

func GetFusionAuthEntity(ctx *Context, name string, id IDInput, state *FusionAuthEntityState, opts ...ResourceOption) (*FusionAuthEntity, error)

public static FusionAuthEntity Get(string name, Input<string> id, FusionAuthEntityState? state, CustomResourceOptions? opts = null)

public static FusionAuthEntity get(String name, Output<String> id, FusionAuthEntityState state, CustomResourceOptions options)

resources:  _:    type: fusionauth:FusionAuthEntity    get:      id: ${id}

Package Details

Repository

fusionauth theogravity/pulumi-fusionauth

License

MIT

Notes

This Pulumi package is based on the fusionauth Terraform Provider.