pulumi-fusionauth/fusionAuthApiKey.d.ts

A Pulumi package for managing FusionAuth instances.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * ## # API Key
 *
 * The FusionAuth APIs are primarily secured using API keys. This API can only be accessed using an API key that is set as a keyManager. In order to retrieve, update or delete an API key, an API key with equal or greater permissions must be used. A "tenant-scoped" API key can retrieve, create, update or delete an API key for the same tenant. This page describes APIs that are used to manage API keys.
 *
 * [API Key](https://fusionauth.io/docs/v1/tech/apis/api-keys/)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fusionauth from "pulumi-fusionauth";
 *
 * const example = new fusionauth.FusionAuthApiKey("example", {
 *     description: "my super secret key",
 *     key: "super-secret-key",
 *     permissionsEndpoints: [{
 *         "delete": true,
 *         endpoint: "/api/application",
 *         get: true,
 *         patch: true,
 *         post: true,
 *         put: true,
 *     }],
 *     tenantId: "94f751c5-4883-4684-a817-6b106778edec",
 * });
 * ```
 */
export declare class FusionAuthApiKey extends pulumi.CustomResource {
    /**
     * Get an existing FusionAuthApiKey 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?: FusionAuthApiKeyState, opts?: pulumi.CustomResourceOptions): FusionAuthApiKey;
    /**
     * Returns true if the given object is an instance of FusionAuthApiKey.  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 FusionAuthApiKey;
    /**
     * Description of the key.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
     */
    readonly expirationInstant: pulumi.Output<number | undefined>;
    /**
     * The Id of the IP Access Control List limiting access to this API key.
     */
    readonly ipAccessControlListId: pulumi.Output<string | undefined>;
    /**
     * API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
     */
    readonly key: pulumi.Output<string>;
    /**
     * The Id to use for the new Form. If not specified a secure random UUID will be generated.
     */
    readonly keyId: pulumi.Output<string | undefined>;
    /**
     * Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissionsEndpoints object mean that this is a super key that authorizes this key for all the endpoints.
     */
    readonly permissionsEndpoints: pulumi.Output<outputs.FusionAuthApiKeyPermissionsEndpoint[] | undefined>;
    /**
     * The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
     */
    readonly tenantId: pulumi.Output<string | undefined>;
    /**
     * Create a FusionAuthApiKey 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?: FusionAuthApiKeyArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FusionAuthApiKey resources.
 */
export interface FusionAuthApiKeyState {
    /**
     * Description of the key.
     */
    description?: pulumi.Input<string>;
    /**
     * The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
     */
    expirationInstant?: pulumi.Input<number>;
    /**
     * The Id of the IP Access Control List limiting access to this API key.
     */
    ipAccessControlListId?: pulumi.Input<string>;
    /**
     * API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
     */
    key?: pulumi.Input<string>;
    /**
     * The Id to use for the new Form. If not specified a secure random UUID will be generated.
     */
    keyId?: pulumi.Input<string>;
    /**
     * Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissionsEndpoints object mean that this is a super key that authorizes this key for all the endpoints.
     */
    permissionsEndpoints?: pulumi.Input<pulumi.Input<inputs.FusionAuthApiKeyPermissionsEndpoint>[]>;
    /**
     * The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
     */
    tenantId?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a FusionAuthApiKey resource.
 */
export interface FusionAuthApiKeyArgs {
    /**
     * Description of the key.
     */
    description?: pulumi.Input<string>;
    /**
     * The expiration instant of this API key. Using an expired API key for API Authentication will result in a 401 response code.
     */
    expirationInstant?: pulumi.Input<number>;
    /**
     * The Id of the IP Access Control List limiting access to this API key.
     */
    ipAccessControlListId?: pulumi.Input<string>;
    /**
     * API key string. When you create an API key the key is defaulted to a secure random value but the API key is simply a string, so you may call it super-secret-key if you’d like. However a long and random value makes a good API key in that it is unique and difficult to guess.
     */
    key?: pulumi.Input<string>;
    /**
     * The Id to use for the new Form. If not specified a secure random UUID will be generated.
     */
    keyId?: pulumi.Input<string>;
    /**
     * Endpoint permissions for this key. Each key of the object is an endpoint, with the value being an array of the HTTP methods which can be used against the endpoint. An Empty permissionsEndpoints object mean that this is a super key that authorizes this key for all the endpoints.
     */
    permissionsEndpoints?: pulumi.Input<pulumi.Input<inputs.FusionAuthApiKeyPermissionsEndpoint>[]>;
    /**
     * The unique Id of the Tenant. This value is required if the key is meant to be tenant scoped. Tenant scoped keys can only be used to access users and other tenant scoped objects for the specified tenant. This value is read-only once the key is created.
     */
    tenantId?: pulumi.Input<string>;
}