okta.app.getOauth
Use this data source to retrieve an OIDC application from Okta.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Okta = Pulumi.Okta;
return await Deployment.RunAsync(() =>
{
var test = Okta.App.GetOauth.Invoke(new()
{
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 = 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:
- Active
Only bool tells the provider to query for only
ACTIVE
applications.- Id string
id
of application to retrieve, conflicts withlabel
andlabel_prefix
.- Label string
The label of the app to retrieve, conflicts with
label_prefix
andid
. Label uses the?q=<label>
query parameter exposed by Okta's List Apps API. The API will search bothname
andlabel
using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications- Label
Prefix string Label prefix of the app to retrieve, conflicts with
label
andid
. This will tell the provider to do astarts with
query as opposed to anequals
query.- Skip
Groups bool Indicator that allows the app to skip
groups
sync. Default isfalse
.- Skip
Users bool Indicator that allows the app to skip
users
sync. Default isfalse
.
- Active
Only bool tells the provider to query for only
ACTIVE
applications.- Id string
id
of application to retrieve, conflicts withlabel
andlabel_prefix
.- Label string
The label of the app to retrieve, conflicts with
label_prefix
andid
. Label uses the?q=<label>
query parameter exposed by Okta's List Apps API. The API will search bothname
andlabel
using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications- Label
Prefix string Label prefix of the app to retrieve, conflicts with
label
andid
. This will tell the provider to do astarts with
query as opposed to anequals
query.- Skip
Groups bool Indicator that allows the app to skip
groups
sync. Default isfalse
.- Skip
Users bool Indicator that allows the app to skip
users
sync. Default isfalse
.
- active
Only Boolean tells the provider to query for only
ACTIVE
applications.- id String
id
of application to retrieve, conflicts withlabel
andlabel_prefix
.- label String
The label of the app to retrieve, conflicts with
label_prefix
andid
. Label uses the?q=<label>
query parameter exposed by Okta's List Apps API. The API will search bothname
andlabel
using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications- label
Prefix String Label prefix of the app to retrieve, conflicts with
label
andid
. This will tell the provider to do astarts with
query as opposed to anequals
query.- skip
Groups Boolean Indicator that allows the app to skip
groups
sync. Default isfalse
.- skip
Users Boolean Indicator that allows the app to skip
users
sync. Default isfalse
.
- active
Only boolean tells the provider to query for only
ACTIVE
applications.- id string
id
of application to retrieve, conflicts withlabel
andlabel_prefix
.- label string
The label of the app to retrieve, conflicts with
label_prefix
andid
. Label uses the?q=<label>
query parameter exposed by Okta's List Apps API. The API will search bothname
andlabel
using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications- label
Prefix string Label prefix of the app to retrieve, conflicts with
label
andid
. This will tell the provider to do astarts with
query as opposed to anequals
query.- skip
Groups boolean Indicator that allows the app to skip
groups
sync. Default isfalse
.- skip
Users boolean Indicator that allows the app to skip
users
sync. Default isfalse
.
- active_
only bool tells the provider to query for only
ACTIVE
applications.- id str
id
of application to retrieve, conflicts withlabel
andlabel_prefix
.- label str
The label of the app to retrieve, conflicts with
label_prefix
andid
. Label uses the?q=<label>
query parameter exposed by Okta's List Apps API. The API will search bothname
andlabel
using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications- label_
prefix str Label prefix of the app to retrieve, conflicts with
label
andid
. This will tell the provider to do astarts with
query as opposed to anequals
query.- skip_
groups bool Indicator that allows the app to skip
groups
sync. Default isfalse
.- skip_
users bool Indicator that allows the app to skip
users
sync. Default isfalse
.
- active
Only Boolean tells the provider to query for only
ACTIVE
applications.- id String
id
of application to retrieve, conflicts withlabel
andlabel_prefix
.- label String
The label of the app to retrieve, conflicts with
label_prefix
andid
. Label uses the?q=<label>
query parameter exposed by Okta's List Apps API. The API will search bothname
andlabel
using that query. Therefore similarily named and labeled apps may be returned in the query and have the unitended result of associating the wrong app with this data source. See: https://developer.okta.com/docs/reference/api/apps/#list-applications- label
Prefix String Label prefix of the app to retrieve, conflicts with
label
andid
. This will tell the provider to do astarts with
query as opposed to anequals
query.- skip
Groups Boolean Indicator that allows the app to skip
groups
sync. Default isfalse
.- skip
Users Boolean Indicator that allows the app to skip
users
sync. Default isfalse
.
getOauth Result
The following output properties are available:
- Auto
Submit boolToolbar Display auto submit toolbar.
- Client
Id string OAuth client ID. If set during creation, app is created with this id.
- Client
Secret string The latest active client secret of the application. See: https://developer.okta.com/docs/reference/api/apps/#oauth-credential-object
- Client
Uri string URI to a web page providing information about the client.
- Grant
Types List<string> List of OAuth 2.0 grant types.
- Groups List<string>
List of groups IDs assigned to the application.
The
groups
field is now deprecated for the data sourceokta_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 string
generic JSON containing discoverable resources related to the app
- Login
Mode string The type of Idp-Initiated login that the client supports, if any.
- Login
Scopes List<string> List of scopes to use for the request.
- Login
Uri string URI that initiates login.
- Logo
Uri string URI that references a logo for the client.
- Name string
Name of application.
- Policy
Uri string URI to web page providing client policy document.
- Post
Logout List<string>Redirect Uris List of URIs for redirection after logout.
- Redirect
Uris List<string> List of URIs for use in the redirect-based flow.
- Response
Types 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.
The
users
field is now deprecated for the data sourceokta_app_oauth
, please replace all uses of this with:okta_app_user_assignments
- Wildcard
Redirect string - Active
Only bool - Id string
ID of application.
- Label string
Label of application.
- Label
Prefix string - Skip
Groups bool - Skip
Users bool
- Auto
Submit boolToolbar Display auto submit toolbar.
- Client
Id string OAuth client ID. If set during creation, app is created with this id.
- Client
Secret string The latest active client secret of the application. See: https://developer.okta.com/docs/reference/api/apps/#oauth-credential-object
- Client
Uri string URI to a web page providing information about the client.
- Grant
Types []string List of OAuth 2.0 grant types.
- Groups []string
List of groups IDs assigned to the application.
The
groups
field is now deprecated for the data sourceokta_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 string
generic JSON containing discoverable resources related to the app
- Login
Mode string The type of Idp-Initiated login that the client supports, if any.
- Login
Scopes []string List of scopes to use for the request.
- Login
Uri string URI that initiates login.
- Logo
Uri string URI that references a logo for the client.
- Name string
Name of application.
- Policy
Uri string URI to web page providing client policy document.
- Post
Logout []stringRedirect Uris List of URIs for redirection after logout.
- Redirect
Uris []string List of URIs for use in the redirect-based flow.
- Response
Types []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.
The
users
field is now deprecated for the data sourceokta_app_oauth
, please replace all uses of this with:okta_app_user_assignments
- Wildcard
Redirect string - Active
Only bool - Id string
ID of application.
- Label string
Label of application.
- Label
Prefix string - Skip
Groups bool - Skip
Users bool
- auto
Submit BooleanToolbar Display auto submit toolbar.
- client
Id String OAuth client ID. If set during creation, app is created with this id.
- client
Secret String The latest active client secret of the application. See: https://developer.okta.com/docs/reference/api/apps/#oauth-credential-object
- client
Uri String URI to a web page providing information about the client.
- grant
Types List<String> List of OAuth 2.0 grant types.
- groups List<String>
List of groups IDs assigned to the application.
The
groups
field is now deprecated for the data sourceokta_app_oauth
, please replace all uses of this with:okta_app_group_assignments
- hide
Ios Boolean Do not display application icon on mobile app.
- hide
Web Boolean Do not display application icon to users.
- links String
generic JSON containing discoverable resources related to the app
- login
Mode String The type of Idp-Initiated login that the client supports, if any.
- login
Scopes List<String> List of scopes to use for the request.
- login
Uri String URI that initiates login.
- logo
Uri String URI that references a logo for the client.
- name String
Name of application.
- policy
Uri String URI to web page providing client policy document.
- post
Logout List<String>Redirect Uris List of URIs for redirection after logout.
- redirect
Uris List<String> List of URIs for use in the redirect-based flow.
- response
Types 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.
The
users
field is now deprecated for the data sourceokta_app_oauth
, please replace all uses of this with:okta_app_user_assignments
- wildcard
Redirect String - active
Only Boolean - id String
ID of application.
- label String
Label of application.
- label
Prefix String - skip
Groups Boolean - skip
Users Boolean
- auto
Submit booleanToolbar Display auto submit toolbar.
- client
Id string OAuth client ID. If set during creation, app is created with this id.
- client
Secret string The latest active client secret of the application. See: https://developer.okta.com/docs/reference/api/apps/#oauth-credential-object
- client
Uri string URI to a web page providing information about the client.
- grant
Types string[] List of OAuth 2.0 grant types.
- groups string[]
List of groups IDs assigned to the application.
The
groups
field is now deprecated for the data sourceokta_app_oauth
, please replace all uses of this with:okta_app_group_assignments
- hide
Ios boolean Do not display application icon on mobile app.
- hide
Web boolean Do not display application icon to users.
- links string
generic JSON containing discoverable resources related to the app
- login
Mode string The type of Idp-Initiated login that the client supports, if any.
- login
Scopes string[] List of scopes to use for the request.
- login
Uri string URI that initiates login.
- logo
Uri string URI that references a logo for the client.
- name string
Name of application.
- policy
Uri string URI to web page providing client policy document.
- post
Logout string[]Redirect Uris List of URIs for redirection after logout.
- redirect
Uris string[] List of URIs for use in the redirect-based flow.
- response
Types 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.
The
users
field is now deprecated for the data sourceokta_app_oauth
, please replace all uses of this with:okta_app_user_assignments
- wildcard
Redirect string - active
Only boolean - id string
ID of application.
- label string
Label of application.
- label
Prefix string - skip
Groups boolean - skip
Users boolean
- auto_
submit_ booltoolbar Display auto submit toolbar.
- client_
id str OAuth client ID. If set during creation, app is created with this id.
- client_
secret str The latest active client secret of the application. See: https://developer.okta.com/docs/reference/api/apps/#oauth-credential-object
- 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.
The
groups
field is now deprecated for the data sourceokta_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_ Sequence[str]redirect_ uris 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.
The
users
field is now deprecated for the data sourceokta_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
- auto
Submit BooleanToolbar Display auto submit toolbar.
- client
Id String OAuth client ID. If set during creation, app is created with this id.
- client
Secret String The latest active client secret of the application. See: https://developer.okta.com/docs/reference/api/apps/#oauth-credential-object
- client
Uri String URI to a web page providing information about the client.
- grant
Types List<String> List of OAuth 2.0 grant types.
- groups List<String>
List of groups IDs assigned to the application.
The
groups
field is now deprecated for the data sourceokta_app_oauth
, please replace all uses of this with:okta_app_group_assignments
- hide
Ios Boolean Do not display application icon on mobile app.
- hide
Web Boolean Do not display application icon to users.
- links String
generic JSON containing discoverable resources related to the app
- login
Mode String The type of Idp-Initiated login that the client supports, if any.
- login
Scopes List<String> List of scopes to use for the request.
- login
Uri String URI that initiates login.
- logo
Uri String URI that references a logo for the client.
- name String
Name of application.
- policy
Uri String URI to web page providing client policy document.
- post
Logout List<String>Redirect Uris List of URIs for redirection after logout.
- redirect
Uris List<String> List of URIs for use in the redirect-based flow.
- response
Types 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.
The
users
field is now deprecated for the data sourceokta_app_oauth
, please replace all uses of this with:okta_app_user_assignments
- wildcard
Redirect String - active
Only Boolean - id String
ID of application.
- label String
Label of application.
- label
Prefix String - skip
Groups Boolean - skip
Users Boolean
Package Details
- Repository
- Okta pulumi/pulumi-okta
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
okta
Terraform Provider.