fusionauth.getApplicationOAuthScope

FusionAuth v6.0.2, Feb 9 25

Viewing docs for FusionAuth v6.0.2
published on Sunday, Feb 9, 2025 by Theo Gravity

Schema (JSON)

theogravity/pulumi-fusionauth

Viewing docs for FusionAuth v6.0.2
published on Sunday, Feb 9, 2025 by Theo Gravity

Schema (JSON)

theogravity/pulumi-fusionauth

# 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

Example Usage

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",
});

import pulumi
import pulumi_fusionauth as fusionauth

this = fusionauth.get_application_o_auth_scope(application_id=data["fusionauth_application"]["this"]["id"],
    name="data:read")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/theogravity/pulumi-fusionauth/sdk/go/fusionauth"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := fusionauth.GetApplicationOAuthScope(ctx, &fusionauth.GetApplicationOAuthScopeArgs{
			ApplicationId: data.Fusionauth_application.This.Id,
			Name:          "data:read",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Fusionauth = Pulumi.Fusionauth;

return await Deployment.RunAsync(() => 
{
    var @this = Fusionauth.GetApplicationOAuthScope.Invoke(new()
    {
        ApplicationId = data.Fusionauth_application.This.Id,
        Name = "data:read",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.fusionauth.FusionauthFunctions;
import com.pulumi.fusionauth.inputs.GetApplicationOAuthScopeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var this = FusionauthFunctions.getApplicationOAuthScope(GetApplicationOAuthScopeArgs.builder()
            .applicationId(data.fusionauth_application().this().id())
            .name("data:read")
            .build());

    }
}

variables:
  this:
    fn::invoke:
      function: fusionauth:getApplicationOAuthScope
      arguments:
        applicationId: ${data.fusionauth_application.this.id}
        name: data:read

Using getApplicationOAuthScope

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApplicationOAuthScope(args: GetApplicationOAuthScopeArgs, opts?: InvokeOptions): Promise<GetApplicationOAuthScopeResult>
function getApplicationOAuthScopeOutput(args: GetApplicationOAuthScopeOutputArgs, opts?: InvokeOptions): Output<GetApplicationOAuthScopeResult>

def get_application_o_auth_scope(application_id: Optional[str] = None,
                                 name: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetApplicationOAuthScopeResult
def get_application_o_auth_scope_output(application_id: Optional[pulumi.Input[str]] = None,
                                 name: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetApplicationOAuthScopeResult]

func GetApplicationOAuthScope(ctx *Context, args *GetApplicationOAuthScopeArgs, opts ...InvokeOption) (*GetApplicationOAuthScopeResult, error)
func GetApplicationOAuthScopeOutput(ctx *Context, args *GetApplicationOAuthScopeOutputArgs, opts ...InvokeOption) GetApplicationOAuthScopeResultOutput

> Note: This function is named GetApplicationOAuthScope in the Go SDK.

public static class GetApplicationOAuthScope 
{
    public static Task<GetApplicationOAuthScopeResult> InvokeAsync(GetApplicationOAuthScopeArgs args, InvokeOptions? opts = null)
    public static Output<GetApplicationOAuthScopeResult> Invoke(GetApplicationOAuthScopeInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApplicationOAuthScopeResult> getApplicationOAuthScope(GetApplicationOAuthScopeArgs args, InvokeOptions options)
public static Output<GetApplicationOAuthScopeResult> getApplicationOAuthScope(GetApplicationOAuthScopeArgs args, InvokeOptions options)

fn::invoke:
  function: fusionauth:index/getApplicationOAuthScope:getApplicationOAuthScope
  arguments:
    # arguments dictionary

The following arguments are supported:

ApplicationId string: ID of the application that this role is for.
Name string: The name of the Role.

ApplicationId string: ID of the application that this role is for.
Name string: The name of the Role.

applicationId String: ID of the application that this role is for.
name String: The name of the Role.

applicationId string: ID of the application that this role is for.
name string: The name of the Role.

application_id str: ID of the application that this role is for.
name str: The name of the Role.

applicationId String: ID of the application that this role is for.
name String: The name of the Role.

getApplicationOAuthScope Result

The following output properties are available:

ApplicationId string
Data Dictionary<string, string>: (Optional) An object that can hold any information about the OAuth Scope that should be persisted.
DefaultConsentDetail string: (Optional) "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
DefaultConsentMessage string: (Optional) The default message to display on the OAuth consent screen if one cannot be found in the theme.
Description string: (Optional) A description of the OAuth Scope. This is used for display purposes only.
Id string: The provider-assigned unique ID for this managed resource.
Name string
Required bool: (Optional) Determines if the OAuth Scope is required when requested in an OAuth workflow.
ScopeId string: (Optional) The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.

ApplicationId string
Data map[string]string: (Optional) An object that can hold any information about the OAuth Scope that should be persisted.
DefaultConsentDetail string: (Optional) "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
DefaultConsentMessage string: (Optional) The default message to display on the OAuth consent screen if one cannot be found in the theme.
Description string: (Optional) A description of the OAuth Scope. This is used for display purposes only.
Id string: The provider-assigned unique ID for this managed resource.
Name string
Required bool: (Optional) Determines if the OAuth Scope is required when requested in an OAuth workflow.
ScopeId string: (Optional) The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.

applicationId String
data Map<String,String>: (Optional) An object that can hold any information about the OAuth Scope that should be persisted.
defaultConsentDetail String: (Optional) "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
defaultConsentMessage String: (Optional) The default message to display on the OAuth consent screen if one cannot be found in the theme.
description String: (Optional) A description of the OAuth Scope. This is used for display purposes only.
id String: The provider-assigned unique ID for this managed resource.
name String
required Boolean: (Optional) Determines if the OAuth Scope is required when requested in an OAuth workflow.
scopeId String: (Optional) The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.

applicationId string
data {[key: string]: string}: (Optional) An object that can hold any information about the OAuth Scope that should be persisted.
defaultConsentDetail string: (Optional) "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
defaultConsentMessage string: (Optional) The default message to display on the OAuth consent screen if one cannot be found in the theme.
description string: (Optional) A description of the OAuth Scope. This is used for display purposes only.
id string: The provider-assigned unique ID for this managed resource.
name string
required boolean: (Optional) Determines if the OAuth Scope is required when requested in an OAuth workflow.
scopeId string: (Optional) The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.

application_id str
data Mapping[str, str]: (Optional) An object that can hold any information about the OAuth Scope that should be persisted.
default_consent_detail str: (Optional) "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
default_consent_message str: (Optional) The default message to display on the OAuth consent screen if one cannot be found in the theme.
description str: (Optional) A description of the OAuth Scope. This is used for display purposes only.
id str: The provider-assigned unique ID for this managed resource.
name str
required bool: (Optional) Determines if the OAuth Scope is required when requested in an OAuth workflow.
scope_id str: (Optional) The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.

applicationId String
data Map<String>: (Optional) An object that can hold any information about the OAuth Scope that should be persisted.
defaultConsentDetail String: (Optional) "The default detail to display on the OAuth consent screen if one cannot be found in the theme.
defaultConsentMessage String: (Optional) The default message to display on the OAuth consent screen if one cannot be found in the theme.
description String: (Optional) A description of the OAuth Scope. This is used for display purposes only.
id String: The provider-assigned unique ID for this managed resource.
name String
required Boolean: (Optional) Determines if the OAuth Scope is required when requested in an OAuth workflow.
scopeId String: (Optional) The Id to use for the new OAuth Scope. If not specified a secure random UUID will be generated.