pulumi-fusionauth/fusionAuthEntityGrant.d.ts

A Pulumi package for managing FusionAuth instances.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## # 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](https://fusionauth.io/docs/v1/tech/apis/entity-management/grants)
 *
 * ## Example Usage
 */
export declare class FusionAuthEntityGrant extends pulumi.CustomResource {
    /**
     * Get an existing FusionAuthEntityGrant resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FusionAuthEntityGrantState, opts?: pulumi.CustomResourceOptions): FusionAuthEntityGrant;
    /**
     * Returns true if the given object is an instance of FusionAuthEntityGrant.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is FusionAuthEntityGrant;
    /**
     * 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.
     */
    readonly data: pulumi.Output<string | undefined>;
    /**
     * The Id of the Entity to which access is granted.
     */
    readonly entityId: pulumi.Output<string>;
    /**
     * The set of permissions of this Grant.
     */
    readonly permissions: pulumi.Output<string[] | undefined>;
    /**
     * The Entity Id for which access is granted. If `recipientEntityId` is not provided, then the `userId` will be required.
     */
    readonly recipientEntityId: pulumi.Output<string | undefined>;
    /**
     * The unique Id of the tenant used to scope this API request.
     */
    readonly tenantId: pulumi.Output<string>;
    /**
     * The User Id for which access is granted. If `userId` is not provided, then the `recipientEntityId` will be required.
     */
    readonly userId: pulumi.Output<string | undefined>;
    /**
     * Create a FusionAuthEntityGrant resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: FusionAuthEntityGrantArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FusionAuthEntityGrant resources.
 */
export interface FusionAuthEntityGrantState {
    /**
     * 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.
     */
    data?: pulumi.Input<string>;
    /**
     * The Id of the Entity to which access is granted.
     */
    entityId?: pulumi.Input<string>;
    /**
     * The set of permissions of this Grant.
     */
    permissions?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The Entity Id for which access is granted. If `recipientEntityId` is not provided, then the `userId` will be required.
     */
    recipientEntityId?: pulumi.Input<string>;
    /**
     * The unique Id of the tenant used to scope this API request.
     */
    tenantId?: pulumi.Input<string>;
    /**
     * The User Id for which access is granted. If `userId` is not provided, then the `recipientEntityId` will be required.
     */
    userId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a FusionAuthEntityGrant resource.
 */
export interface FusionAuthEntityGrantArgs {
    /**
     * 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.
     */
    data?: pulumi.Input<string>;
    /**
     * The Id of the Entity to which access is granted.
     */
    entityId: pulumi.Input<string>;
    /**
     * The set of permissions of this Grant.
     */
    permissions?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The Entity Id for which access is granted. If `recipientEntityId` is not provided, then the `userId` will be required.
     */
    recipientEntityId?: pulumi.Input<string>;
    /**
     * The unique Id of the tenant used to scope this API request.
     */
    tenantId?: pulumi.Input<string>;
    /**
     * The User Id for which access is granted. If `userId` is not provided, then the `recipientEntityId` will be required.
     */
    userId?: pulumi.Input<string>;
}