← All packages

Okta

Pulumi Official
Package maintained by Pulumi
v3.14.0 published on Thursday, Aug 4, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. Okta
  3. Okta
  4. app
  5. getOauth

getOauth

Use this data source to retrieve an OIDC application from Okta.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var test = Output.Create(Okta.App.GetOauth.InvokeAsync(new Okta.App.GetOauthArgs
        {
            Label = "Example App",
        }));
    }

}

package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/app"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := app.GetOauth(ctx, &app.GetOauthArgs{
			Label: pulumi.StringRef("Example App"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.app.AppFunctions;
import com.pulumi.okta.app.inputs.GetOauthArgs;
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 test = AppFunctions.getOauth(GetOauthArgs.builder()
            .label("Example App")
            .build());

    }
}

import pulumi
import pulumi_okta as okta

test = okta.app.get_oauth(label="Example App")

import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const test = pulumi.output(okta.app.getOauth({
    label: "Example App",
}));

variables:
  test:
    Fn::Invoke:
      Function: okta:app:getOauth
      Arguments:
        label: Example App

Using getOauth

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 getOauth(args: GetOauthArgs, opts?: InvokeOptions): Promise<GetOauthResult>
function getOauthOutput(args: GetOauthOutputArgs, opts?: InvokeOptions): Output<GetOauthResult>
def get_oauth(active_only: Optional[bool] = None,
              id: Optional[str] = None,
              label: Optional[str] = None,
              label_prefix: Optional[str] = None,
              skip_groups: Optional[bool] = None,
              skip_users: Optional[bool] = None,
              opts: Optional[InvokeOptions] = None) -> GetOauthResult
def get_oauth_output(active_only: Optional[pulumi.Input[bool]] = None,
              id: Optional[pulumi.Input[str]] = None,
              label: Optional[pulumi.Input[str]] = None,
              label_prefix: Optional[pulumi.Input[str]] = None,
              skip_groups: Optional[pulumi.Input[bool]] = None,
              skip_users: Optional[pulumi.Input[bool]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetOauthResult]
func GetOauth(ctx *Context, args *GetOauthArgs, opts ...InvokeOption) (*GetOauthResult, error)
func GetOauthOutput(ctx *Context, args *GetOauthOutputArgs, opts ...InvokeOption) GetOauthResultOutput

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

public static class GetOauth 
{
    public static Task<GetOauthResult> InvokeAsync(GetOauthArgs args, InvokeOptions? opts = null)
    public static Output<GetOauthResult> Invoke(GetOauthInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOauthResult> getOauth(GetOauthArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

Fn::Invoke:
  Function: okta:app/getOauth:getOauth
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ActiveOnly bool

tells the provider to query for only ACTIVE applications.

Id string

id of application to retrieve, conflicts with label and label_prefix.

Label string

The label of the app to retrieve, conflicts with label_prefix and id. Label uses the ?q=<label> query parameter exposed by Okta's API. It should be noted that at this time this searches both name and label. This is used to avoid paginating through all applications.

LabelPrefix string

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

SkipGroups bool

Indicator that allows the app to skip groups sync. Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync. Default is false.

ActiveOnly bool

tells the provider to query for only ACTIVE applications.

Id string

id of application to retrieve, conflicts with label and label_prefix.

Label string

The label of the app to retrieve, conflicts with label_prefix and id. Label uses the ?q=<label> query parameter exposed by Okta's API. It should be noted that at this time this searches both name and label. This is used to avoid paginating through all applications.

LabelPrefix string

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

SkipGroups bool

Indicator that allows the app to skip groups sync. Default is false.

SkipUsers bool

Indicator that allows the app to skip users sync. Default is false.

activeOnly Boolean

tells the provider to query for only ACTIVE applications.

id String

id of application to retrieve, conflicts with label and label_prefix.

label String

The label of the app to retrieve, conflicts with label_prefix and id. Label uses the ?q=<label> query parameter exposed by Okta's API. It should be noted that at this time this searches both name and label. This is used to avoid paginating through all applications.

labelPrefix String

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

skipGroups Boolean

Indicator that allows the app to skip groups sync. Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync. Default is false.

activeOnly boolean

tells the provider to query for only ACTIVE applications.

id string

id of application to retrieve, conflicts with label and label_prefix.

label string

The label of the app to retrieve, conflicts with label_prefix and id. Label uses the ?q=<label> query parameter exposed by Okta's API. It should be noted that at this time this searches both name and label. This is used to avoid paginating through all applications.

labelPrefix string

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

skipGroups boolean

Indicator that allows the app to skip groups sync. Default is false.

skipUsers boolean

Indicator that allows the app to skip users sync. Default is false.

active_only bool

tells the provider to query for only ACTIVE applications.

id str

id of application to retrieve, conflicts with label and label_prefix.

label str

The label of the app to retrieve, conflicts with label_prefix and id. Label uses the ?q=<label> query parameter exposed by Okta's API. It should be noted that at this time this searches both name and label. This is used to avoid paginating through all applications.

label_prefix str

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

skip_groups bool

Indicator that allows the app to skip groups sync. Default is false.

skip_users bool

Indicator that allows the app to skip users sync. Default is false.

activeOnly Boolean

tells the provider to query for only ACTIVE applications.

id String

id of application to retrieve, conflicts with label and label_prefix.

label String

The label of the app to retrieve, conflicts with label_prefix and id. Label uses the ?q=<label> query parameter exposed by Okta's API. It should be noted that at this time this searches both name and label. This is used to avoid paginating through all applications.

labelPrefix String

Label prefix of the app to retrieve, conflicts with label and id. This will tell the provider to do a starts with query as opposed to an equals query.

skipGroups Boolean

Indicator that allows the app to skip groups sync. Default is false.

skipUsers Boolean

Indicator that allows the app to skip users sync. Default is false.

getOauth Result

The following output properties are available:

AutoSubmitToolbar bool

Display auto submit toolbar.

ClientId string

OAuth client ID. If set during creation, app is created with this id.

ClientUri string

URI to a web page providing information about the client.

GrantTypes List<string>

List of OAuth 2.0 grant types.

Groups List<string>

List of groups IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.AppGroupAssignments.

Deprecated:

The groups field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_group_assignments

HideIos bool

Do not display application icon on mobile app.

HideWeb bool

Do not display application icon to users.

Links string

generic JSON containing discoverable resources related to the app

LoginMode string

The type of Idp-Initiated login that the client supports, if any.

LoginScopes List<string>

List of scopes to use for the request.

LoginUri string

URI that initiates login.

LogoUri string

URI that references a logo for the client.

Name string

Name of application.

PolicyUri string

URI to web page providing client policy document.

PostLogoutRedirectUris List<string>

List of URIs for redirection after logout.

RedirectUris List<string>

List of URIs for use in the redirect-based flow.

ResponseTypes List<string>

List of OAuth 2.0 response type strings.

Status string

Status of application.

Type string

The type of OAuth application.

Users List<string>

List of users IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.getAppUserAssignments.

Deprecated:

The users field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_user_assignments

WildcardRedirect string
ActiveOnly bool
Id string

ID of application.

Label string

Label of application.

LabelPrefix string
SkipGroups bool
SkipUsers bool
AutoSubmitToolbar bool

Display auto submit toolbar.

ClientId string

OAuth client ID. If set during creation, app is created with this id.

ClientUri string

URI to a web page providing information about the client.

GrantTypes []string

List of OAuth 2.0 grant types.

Groups []string

List of groups IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.AppGroupAssignments.

Deprecated:

The groups field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_group_assignments

HideIos bool

Do not display application icon on mobile app.

HideWeb bool

Do not display application icon to users.

Links string

generic JSON containing discoverable resources related to the app

LoginMode string

The type of Idp-Initiated login that the client supports, if any.

LoginScopes []string

List of scopes to use for the request.

LoginUri string

URI that initiates login.

LogoUri string

URI that references a logo for the client.

Name string

Name of application.

PolicyUri string

URI to web page providing client policy document.

PostLogoutRedirectUris []string

List of URIs for redirection after logout.

RedirectUris []string

List of URIs for use in the redirect-based flow.

ResponseTypes []string

List of OAuth 2.0 response type strings.

Status string

Status of application.

Type string

The type of OAuth application.

Users []string

List of users IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.getAppUserAssignments.

Deprecated:

The users field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_user_assignments

WildcardRedirect string
ActiveOnly bool
Id string

ID of application.

Label string

Label of application.

LabelPrefix string
SkipGroups bool
SkipUsers bool
autoSubmitToolbar Boolean

Display auto submit toolbar.

clientId String

OAuth client ID. If set during creation, app is created with this id.

clientUri String

URI to a web page providing information about the client.

grantTypes List<String>

List of OAuth 2.0 grant types.

groups List<String>

List of groups IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.AppGroupAssignments.

Deprecated:

The groups field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_group_assignments

hideIos Boolean

Do not display application icon on mobile app.

hideWeb Boolean

Do not display application icon to users.

links String

generic JSON containing discoverable resources related to the app

loginMode String

The type of Idp-Initiated login that the client supports, if any.

loginScopes List<String>

List of scopes to use for the request.

loginUri String

URI that initiates login.

logoUri String

URI that references a logo for the client.

name String

Name of application.

policyUri String

URI to web page providing client policy document.

postLogoutRedirectUris List<String>

List of URIs for redirection after logout.

redirectUris List<String>

List of URIs for use in the redirect-based flow.

responseTypes List<String>

List of OAuth 2.0 response type strings.

status String

Status of application.

type String

The type of OAuth application.

users List<String>

List of users IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.getAppUserAssignments.

Deprecated:

The users field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_user_assignments

wildcardRedirect String
activeOnly Boolean
id String

ID of application.

label String

Label of application.

labelPrefix String
skipGroups Boolean
skipUsers Boolean
autoSubmitToolbar boolean

Display auto submit toolbar.

clientId string

OAuth client ID. If set during creation, app is created with this id.

clientUri string

URI to a web page providing information about the client.

grantTypes string[]

List of OAuth 2.0 grant types.

groups string[]

List of groups IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.AppGroupAssignments.

Deprecated:

The groups field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_group_assignments

hideIos boolean

Do not display application icon on mobile app.

hideWeb boolean

Do not display application icon to users.

links string

generic JSON containing discoverable resources related to the app

loginMode string

The type of Idp-Initiated login that the client supports, if any.

loginScopes string[]

List of scopes to use for the request.

loginUri string

URI that initiates login.

logoUri string

URI that references a logo for the client.

name string

Name of application.

policyUri string

URI to web page providing client policy document.

postLogoutRedirectUris string[]

List of URIs for redirection after logout.

redirectUris string[]

List of URIs for use in the redirect-based flow.

responseTypes string[]

List of OAuth 2.0 response type strings.

status string

Status of application.

type string

The type of OAuth application.

users string[]

List of users IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.getAppUserAssignments.

Deprecated:

The users field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_user_assignments

wildcardRedirect string
activeOnly boolean
id string

ID of application.

label string

Label of application.

labelPrefix string
skipGroups boolean
skipUsers boolean
auto_submit_toolbar bool

Display auto submit toolbar.

client_id str

OAuth client ID. If set during creation, app is created with this id.

client_uri str

URI to a web page providing information about the client.

grant_types Sequence[str]

List of OAuth 2.0 grant types.

groups Sequence[str]

List of groups IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.AppGroupAssignments.

Deprecated:

The groups field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_group_assignments

hide_ios bool

Do not display application icon on mobile app.

hide_web bool

Do not display application icon to users.

links str

generic JSON containing discoverable resources related to the app

login_mode str

The type of Idp-Initiated login that the client supports, if any.

login_scopes Sequence[str]

List of scopes to use for the request.

login_uri str

URI that initiates login.

logo_uri str

URI that references a logo for the client.

name str

Name of application.

policy_uri str

URI to web page providing client policy document.

post_logout_redirect_uris Sequence[str]

List of URIs for redirection after logout.

redirect_uris Sequence[str]

List of URIs for use in the redirect-based flow.

response_types Sequence[str]

List of OAuth 2.0 response type strings.

status str

Status of application.

type str

The type of OAuth application.

users Sequence[str]

List of users IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.getAppUserAssignments.

Deprecated:

The users field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_user_assignments

wildcard_redirect str
active_only bool
id str

ID of application.

label str

Label of application.

label_prefix str
skip_groups bool
skip_users bool
autoSubmitToolbar Boolean

Display auto submit toolbar.

clientId String

OAuth client ID. If set during creation, app is created with this id.

clientUri String

URI to a web page providing information about the client.

grantTypes List<String>

List of OAuth 2.0 grant types.

groups List<String>

List of groups IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.AppGroupAssignments.

Deprecated:

The groups field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_group_assignments

hideIos Boolean

Do not display application icon on mobile app.

hideWeb Boolean

Do not display application icon to users.

links String

generic JSON containing discoverable resources related to the app

loginMode String

The type of Idp-Initiated login that the client supports, if any.

loginScopes List<String>

List of scopes to use for the request.

loginUri String

URI that initiates login.

logoUri String

URI that references a logo for the client.

name String

Name of application.

policyUri String

URI to web page providing client policy document.

postLogoutRedirectUris List<String>

List of URIs for redirection after logout.

redirectUris List<String>

List of URIs for use in the redirect-based flow.

responseTypes List<String>

List of OAuth 2.0 response type strings.

status String

Status of application.

type String

The type of OAuth application.

users List<String>

List of users IDs assigned to the application.

  • DEPRECATED: Please replace all usage of this field with the data source okta.getAppUserAssignments.

Deprecated:

The users field is now deprecated for the data source okta_app_oauth, please replace all uses of this with: okta_app_user_assignments

wildcardRedirect String
activeOnly Boolean
id String

ID of application.

label String

Label of application.

labelPrefix String
skipGroups Boolean
skipUsers Boolean

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes

This Pulumi package is based on the okta Terraform Provider.