pulumi-fusionauth
Version:
A Pulumi package for managing FusionAuth instances.
165 lines (164 loc) • 6.27 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* ## # Application OAuth Scope Resource
*
* The Application OAuth Scope resource allows you to define the scopes that an application can request when using OAuth.
*
* [Application OAuth Scope API](https://fusionauth.io/docs/apis/scopes)
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as fusionauth from "pulumi-fusionauth";
*
* const _this = new fusionauth.FusionAuthApplicationOAuthScope("this", {
* applicationId: fusionauth_application["this"].id,
* data: {
* addedBy: "Tom",
* addedOn: "2025-02-05",
* },
* defaultConsentDetail: "This will provide the requesting application read-only access to your data",
* defaultConsentMessage: "View your data",
* description: "Provides an application read-only access to a user's data",
* required: true,
* });
* ```
*/
export declare class FusionAuthApplicationOAuthScope extends pulumi.CustomResource {
/**
* Get an existing FusionAuthApplicationOAuthScope 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?: FusionAuthApplicationOAuthScopeState, opts?: pulumi.CustomResourceOptions): FusionAuthApplicationOAuthScope;
/**
* Returns true if the given object is an instance of FusionAuthApplicationOAuthScope. 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 FusionAuthApplicationOAuthScope;
/**
* ID of the application that this role is for.
*/
readonly applicationId: pulumi.Output<string>;
/**
* An object that can hold any information about the OAuth Scope that should be persisted.
*/
readonly data: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
*/
readonly defaultConsentDetail: pulumi.Output<string | undefined>;
/**
* The default message to display on the OAuth consent screen if one cannot be found in the theme.
*/
readonly defaultConsentMessage: pulumi.Output<string | undefined>;
/**
* A description of the OAuth Scope. This is used for display purposes only.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The name of the Role.
*/
readonly name: pulumi.Output<string>;
/**
* Determines if the OAuth Scope is required when requested in an OAuth workflow.
*/
readonly required: pulumi.Output<boolean | undefined>;
/**
* The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.
*/
readonly scopeId: pulumi.Output<string>;
/**
* Create a FusionAuthApplicationOAuthScope 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: FusionAuthApplicationOAuthScopeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FusionAuthApplicationOAuthScope resources.
*/
export interface FusionAuthApplicationOAuthScopeState {
/**
* ID of the application that this role is for.
*/
applicationId?: pulumi.Input<string>;
/**
* An object that can hold any information about the OAuth Scope that should be persisted.
*/
data?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
*/
defaultConsentDetail?: pulumi.Input<string>;
/**
* The default message to display on the OAuth consent screen if one cannot be found in the theme.
*/
defaultConsentMessage?: pulumi.Input<string>;
/**
* A description of the OAuth Scope. This is used for display purposes only.
*/
description?: pulumi.Input<string>;
/**
* The name of the Role.
*/
name?: pulumi.Input<string>;
/**
* Determines if the OAuth Scope is required when requested in an OAuth workflow.
*/
required?: pulumi.Input<boolean>;
/**
* The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.
*/
scopeId?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a FusionAuthApplicationOAuthScope resource.
*/
export interface FusionAuthApplicationOAuthScopeArgs {
/**
* ID of the application that this role is for.
*/
applicationId: pulumi.Input<string>;
/**
* An object that can hold any information about the OAuth Scope that should be persisted.
*/
data?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
*/
defaultConsentDetail?: pulumi.Input<string>;
/**
* The default message to display on the OAuth consent screen if one cannot be found in the theme.
*/
defaultConsentMessage?: pulumi.Input<string>;
/**
* A description of the OAuth Scope. This is used for display purposes only.
*/
description?: pulumi.Input<string>;
/**
* The name of the Role.
*/
name?: pulumi.Input<string>;
/**
* Determines if the OAuth Scope is required when requested in an OAuth workflow.
*/
required?: pulumi.Input<boolean>;
/**
* The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.
*/
scopeId?: pulumi.Input<string>;
}