pulumi-fusionauth/getTenant.js

A Pulumi package for managing FusionAuth instances.

"use strict";
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
Object.defineProperty(exports, "__esModule", { value: true });
exports.getTenantOutput = exports.getTenant = void 0;
const pulumi = require("@pulumi/pulumi");
const utilities = require("./utilities");
/**
 * ## # 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",
 * });
 * ```
 */
function getTenant(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invoke("fusionauth:index/getTenant:getTenant", {
        "name": args.name,
    }, opts);
}
exports.getTenant = getTenant;
/**
 * ## # 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",
 * });
 * ```
 */
function getTenantOutput(args, opts) {
    opts = pulumi.mergeOptions(utilities.resourceOptsDefaults(), opts || {});
    return pulumi.runtime.invokeOutput("fusionauth:index/getTenant:getTenant", {
        "name": args.name,
    }, opts);
}
exports.getTenantOutput = getTenantOutput;
//# sourceMappingURL=getTenant.js.map