pulumi-fusionauth/fusionAuthApplicationRole.d.ts

A Pulumi package for managing FusionAuth instances.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## # Application Role Resource
 *
 * This Resource is used to create a role for an Application.
 *
 * [Application Roles API](https://fusionauth.io/docs/v1/tech/apis/applications)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as fusionauth from "pulumi-fusionauth";
 *
 * const myAppAdminRole = new fusionauth.FusionAuthApplicationRole("myAppAdminRole", {
 *     applicationId: fusionauth_application.my_app.id,
 *     description: "",
 *     isDefault: false,
 *     isSuperRole: true,
 * });
 * ```
 */
export declare class FusionAuthApplicationRole extends pulumi.CustomResource {
    /**
     * Get an existing FusionAuthApplicationRole 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?: FusionAuthApplicationRoleState, opts?: pulumi.CustomResourceOptions): FusionAuthApplicationRole;
    /**
     * Returns true if the given object is an instance of FusionAuthApplicationRole.  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 FusionAuthApplicationRole;
    /**
     * ID of the application that this role is for.
     */
    readonly applicationId: pulumi.Output<string>;
    /**
     * A description for the role.
     */
    readonly description: pulumi.Output<string | undefined>;
    /**
     * Whether or not the Role is a default role. A default role is automatically assigned to a user during registration if no roles are provided.
     */
    readonly isDefault: pulumi.Output<boolean | undefined>;
    /**
     * Whether or not the Role is a considered to be a super user role. This is a marker to indicate that it supersedes all other roles. FusionAuth will attempt to enforce this contract when using the web UI, it is not enforced programmatically when using the API.
     */
    readonly isSuperRole: pulumi.Output<boolean | undefined>;
    /**
     * The name of the Role.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Create a FusionAuthApplicationRole 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: FusionAuthApplicationRoleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering FusionAuthApplicationRole resources.
 */
export interface FusionAuthApplicationRoleState {
    /**
     * ID of the application that this role is for.
     */
    applicationId?: pulumi.Input<string>;
    /**
     * A description for the role.
     */
    description?: pulumi.Input<string>;
    /**
     * Whether or not the Role is a default role. A default role is automatically assigned to a user during registration if no roles are provided.
     */
    isDefault?: pulumi.Input<boolean>;
    /**
     * Whether or not the Role is a considered to be a super user role. This is a marker to indicate that it supersedes all other roles. FusionAuth will attempt to enforce this contract when using the web UI, it is not enforced programmatically when using the API.
     */
    isSuperRole?: pulumi.Input<boolean>;
    /**
     * The name of the Role.
     */
    name?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a FusionAuthApplicationRole resource.
 */
export interface FusionAuthApplicationRoleArgs {
    /**
     * ID of the application that this role is for.
     */
    applicationId: pulumi.Input<string>;
    /**
     * A description for the role.
     */
    description?: pulumi.Input<string>;
    /**
     * Whether or not the Role is a default role. A default role is automatically assigned to a user during registration if no roles are provided.
     */
    isDefault?: pulumi.Input<boolean>;
    /**
     * Whether or not the Role is a considered to be a super user role. This is a marker to indicate that it supersedes all other roles. FusionAuth will attempt to enforce this contract when using the web UI, it is not enforced programmatically when using the API.
     */
    isSuperRole?: pulumi.Input<boolean>;
    /**
     * The name of the Role.
     */
    name?: pulumi.Input<string>;
}