FusionAuth v6.0.2, Feb 9 25

FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity

fusionauth.FusionAuthEntityGrant

Explore with Pulumi AI

FusionAuth v6.0.2 published on Sunday, Feb 9, 2025 by Theo Gravity

theogravity/pulumi-fusionauth

# Entity Grant Resource

Entities can have Grants. Grants are relationships between a target Entity and one of two other types:

A Recipient Entity
A User.

Grants can have zero or more Permissions associated with them.

Entity Grant API

Example Usage

Create FusionAuthEntityGrant Resource

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

new FusionAuthEntityGrant(name: string, args: FusionAuthEntityGrantArgs, opts?: CustomResourceOptions);

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

@overload
def FusionAuthEntityGrant(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          entity_id: Optional[str] = None,
                          data: Optional[str] = None,
                          permissions: Optional[Sequence[str]] = None,
                          recipient_entity_id: Optional[str] = None,
                          tenant_id: Optional[str] = None,
                          user_id: Optional[str] = None)

func NewFusionAuthEntityGrant(ctx *Context, name string, args FusionAuthEntityGrantArgs, opts ...ResourceOption) (*FusionAuthEntityGrant, error)

public FusionAuthEntityGrant(string name, FusionAuthEntityGrantArgs args, CustomResourceOptions? opts = null)

public FusionAuthEntityGrant(String name, FusionAuthEntityGrantArgs args)
public FusionAuthEntityGrant(String name, FusionAuthEntityGrantArgs args, CustomResourceOptions options)

type: fusionauth:FusionAuthEntityGrant
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 FusionAuthEntityGrantArgs: 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 FusionAuthEntityGrantArgs: 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 FusionAuthEntityGrantArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args FusionAuthEntityGrantArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args FusionAuthEntityGrantArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

var fusionAuthEntityGrantResource = new Fusionauth.FusionAuthEntityGrant("fusionAuthEntityGrantResource", new()
{
    EntityId = "string",
    Data = "string",
    Permissions = new[]
    {
        "string",
    },
    RecipientEntityId = "string",
    TenantId = "string",
    UserId = "string",
});

example, err := fusionauth.NewFusionAuthEntityGrant(ctx, "fusionAuthEntityGrantResource", &fusionauth.FusionAuthEntityGrantArgs{
	EntityId: pulumi.String("string"),
	Data:     pulumi.String("string"),
	Permissions: pulumi.StringArray{
		pulumi.String("string"),
	},
	RecipientEntityId: pulumi.String("string"),
	TenantId:          pulumi.String("string"),
	UserId:            pulumi.String("string"),
})

var fusionAuthEntityGrantResource = new FusionAuthEntityGrant("fusionAuthEntityGrantResource", FusionAuthEntityGrantArgs.builder()
    .entityId("string")
    .data("string")
    .permissions("string")
    .recipientEntityId("string")
    .tenantId("string")
    .userId("string")
    .build());

fusion_auth_entity_grant_resource = fusionauth.FusionAuthEntityGrant("fusionAuthEntityGrantResource",
    entity_id="string",
    data="string",
    permissions=["string"],
    recipient_entity_id="string",
    tenant_id="string",
    user_id="string")

const fusionAuthEntityGrantResource = new fusionauth.FusionAuthEntityGrant("fusionAuthEntityGrantResource", {
    entityId: "string",
    data: "string",
    permissions: ["string"],
    recipientEntityId: "string",
    tenantId: "string",
    userId: "string",
});

type: fusionauth:FusionAuthEntityGrant
properties:
    data: string
    entityId: string
    permissions:
        - string
    recipientEntityId: string
    tenantId: string
    userId: string

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

EntityId string: The Id of the Entity to which access is granted.
Data string: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
Permissions List<string>: The set of permissions of this Grant.
RecipientEntityId string: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
TenantId string: The unique Id of the tenant used to scope this API request.
UserId string: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

EntityId string: The Id of the Entity to which access is granted.
Data string: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
Permissions []string: The set of permissions of this Grant.
RecipientEntityId string: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
TenantId string: The unique Id of the tenant used to scope this API request.
UserId string: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

entityId String: The Id of the Entity to which access is granted.
data String: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
permissions List<String>: The set of permissions of this Grant.
recipientEntityId String: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
tenantId String: The unique Id of the tenant used to scope this API request.
userId String: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

entityId string: The Id of the Entity to which access is granted.
data string: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
permissions string[]: The set of permissions of this Grant.
recipientEntityId string: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
tenantId string: The unique Id of the tenant used to scope this API request.
userId string: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

entity_id str: The Id of the Entity to which access is granted.
data str: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
permissions Sequence[str]: The set of permissions of this Grant.
recipient_entity_id str: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
tenant_id str: The unique Id of the tenant used to scope this API request.
user_id str: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

entityId String: The Id of the Entity to which access is granted.
data String: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
permissions List<String>: The set of permissions of this Grant.
recipientEntityId String: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
tenantId String: The unique Id of the tenant used to scope this API request.
userId String: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

Outputs

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

Get an existing FusionAuthEntityGrant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

TypeScript
Python
Go
C#
Java
YAML

public static get(name: string, id: Input<ID>, state?: FusionAuthEntityGrantState, opts?: CustomResourceOptions): FusionAuthEntityGrant

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        data: Optional[str] = None,
        entity_id: Optional[str] = None,
        permissions: Optional[Sequence[str]] = None,
        recipient_entity_id: Optional[str] = None,
        tenant_id: Optional[str] = None,
        user_id: Optional[str] = None) -> FusionAuthEntityGrant

func GetFusionAuthEntityGrant(ctx *Context, name string, id IDInput, state *FusionAuthEntityGrantState, opts ...ResourceOption) (*FusionAuthEntityGrant, error)

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

public static FusionAuthEntityGrant get(String name, Output<String> id, FusionAuthEntityGrantState state, CustomResourceOptions options)

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

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 Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
EntityId string: The Id of the Entity to which access is granted.
Permissions List<string>: The set of permissions of this Grant.
RecipientEntityId string: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
TenantId string: The unique Id of the tenant used to scope this API request.
UserId string: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

Data string: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
EntityId string: The Id of the Entity to which access is granted.
Permissions []string: The set of permissions of this Grant.
RecipientEntityId string: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
TenantId string: The unique Id of the tenant used to scope this API request.
UserId string: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

data String: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
entityId String: The Id of the Entity to which access is granted.
permissions List<String>: The set of permissions of this Grant.
recipientEntityId String: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
tenantId String: The unique Id of the tenant used to scope this API request.
userId String: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

data string: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
entityId string: The Id of the Entity to which access is granted.
permissions string[]: The set of permissions of this Grant.
recipientEntityId string: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
tenantId string: The unique Id of the tenant used to scope this API request.
userId string: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

data str: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
entity_id str: The Id of the Entity to which access is granted.
permissions Sequence[str]: The set of permissions of this Grant.
recipient_entity_id str: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
tenant_id str: The unique Id of the tenant used to scope this API request.
user_id str: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

data String: An object that can hold any information about the Grant that should be persisted. Please review the limits on data field types as you plan for and build your custom data schema. Must be a JSON string.
entityId String: The Id of the Entity to which access is granted.
permissions List<String>: The set of permissions of this Grant.
recipientEntityId String: The Entity Id for which access is granted. If recipient_entity_id is not provided, then the user_id will be required.
tenantId String: The unique Id of the tenant used to scope this API request.
userId String: The User Id for which access is granted. If user_id is not provided, then the recipient_entity_id will be required.

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

fusionauth.FusionAuthEntityGrant

On this page

On this page

# Entity Grant Resource

Example Usage

Create FusionAuthEntityGrant Resource

Constructor syntax

Parameters

Constructor example

FusionAuthEntityGrant Resource Properties

Inputs

Outputs

Look up Existing FusionAuthEntityGrant Resource

Package Details

On this page

On this page