pulumi-fusionauth/getTenant.d.ts

A Pulumi package for managing FusionAuth instances.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## # Tenant Resource
 *
 * A FusionAuth Tenant is a named object that represents a discrete namespace for Users, Applications and Groups. A user is unique by email address or username within a tenant.
 *
 * Tenants may be useful to support a multi-tenant application where you wish to use a single instance of FusionAuth but require the ability to have duplicate users across the tenants in your own application. In this scenario a user may exist multiple times with the same email address and different passwords across tenants.
 *
 * Tenants may also be useful in a test or staging environment to allow multiple users to call APIs and create and modify users without possibility of collision.
 *
 * [Tenants API](https://fusionauth.io/docs/v1/tech/apis/tenants)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fusionauth from "@pulumi/fusionauth";
 *
 * const default = fusionauth.getTenant({
 *     name: "Default",
 * });
 * ```
 */
export declare function getTenant(args: GetTenantArgs, opts?: pulumi.InvokeOptions): Promise<GetTenantResult>;
/**
 * A collection of arguments for invoking getTenant.
 */
export interface GetTenantArgs {
    /**
     * The name of the Tenant.
     */
    name: string;
}
/**
 * A collection of values returned by getTenant.
 */
export interface GetTenantResult {
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly name: string;
}
/**
 * ## # Tenant Resource
 *
 * A FusionAuth Tenant is a named object that represents a discrete namespace for Users, Applications and Groups. A user is unique by email address or username within a tenant.
 *
 * Tenants may be useful to support a multi-tenant application where you wish to use a single instance of FusionAuth but require the ability to have duplicate users across the tenants in your own application. In this scenario a user may exist multiple times with the same email address and different passwords across tenants.
 *
 * Tenants may also be useful in a test or staging environment to allow multiple users to call APIs and create and modify users without possibility of collision.
 *
 * [Tenants API](https://fusionauth.io/docs/v1/tech/apis/tenants)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fusionauth from "@pulumi/fusionauth";
 *
 * const default = fusionauth.getTenant({
 *     name: "Default",
 * });
 * ```
 */
export declare function getTenantOutput(args: GetTenantOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetTenantResult>;
/**
 * A collection of arguments for invoking getTenant.
 */
export interface GetTenantOutputArgs {
    /**
     * The name of the Tenant.
     */
    name: pulumi.Input<string>;
}