pulumi-fusionauth/getApplicationOAuthScope.d.ts

A Pulumi package for managing FusionAuth instances.

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 = fusionauth.getApplicationOAuthScope({
 *     applicationId: data.fusionauth_application["this"].id,
 *     name: "data:read",
 * });
 * ```
 */
export declare function getApplicationOAuthScope(args: GetApplicationOAuthScopeArgs, opts?: pulumi.InvokeOptions): Promise<GetApplicationOAuthScopeResult>;
/**
 * A collection of arguments for invoking getApplicationOAuthScope.
 */
export interface GetApplicationOAuthScopeArgs {
    /**
     * ID of the application that this role is for.
     */
    applicationId: string;
    /**
     * The name of the Role.
     */
    name: string;
}
/**
 * A collection of values returned by getApplicationOAuthScope.
 */
export interface GetApplicationOAuthScopeResult {
    readonly applicationId: string;
    /**
     * (Optional) An object that can hold any information about the OAuth Scope that should be persisted.
     */
    readonly data: {
        [key: string]: string;
    };
    /**
     * (Optional) "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
     */
    readonly defaultConsentDetail: string;
    /**
     * (Optional) The default message to display on the OAuth consent screen if one cannot be found in the theme.
     */
    readonly defaultConsentMessage: string;
    /**
     * (Optional) A description of the OAuth Scope. This is used for display purposes only.
     */
    readonly description: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly name: string;
    /**
     * (Optional) Determines if the OAuth Scope is required when requested in an OAuth workflow.
     */
    readonly required: boolean;
    /**
     * (Optional) The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.
     */
    readonly scopeId: string;
}
/**
 * ## # 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 = fusionauth.getApplicationOAuthScope({
 *     applicationId: data.fusionauth_application["this"].id,
 *     name: "data:read",
 * });
 * ```
 */
export declare function getApplicationOAuthScopeOutput(args: GetApplicationOAuthScopeOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetApplicationOAuthScopeResult>;
/**
 * A collection of arguments for invoking getApplicationOAuthScope.
 */
export interface GetApplicationOAuthScopeOutputArgs {
    /**
     * ID of the application that this role is for.
     */
    applicationId: pulumi.Input<string>;
    /**
     * The name of the Role.
     */
    name: pulumi.Input<string>;
}