OauthApp

Create a OauthApp Resource

new OauthApp(name: string, args: OauthAppArgs, opts?: CustomResourceOptions);

def OauthApp(resource_name, opts=None, auto_key_rotation=None, auto_submit_toolbar=None, client_basic_secret=None, client_uri=None, consent_method=None, custom_client_id=None, grant_types=None, groups=None, hide_ios=None, hide_web=None, issuer_mode=None, label=None, login_uri=None, logo_uri=None, omit_secret=None, policy_uri=None, post_logout_redirect_uris=None, profile=None, redirect_uris=None, response_types=None, status=None, token_endpoint_auth_method=None, tos_uri=None, type=None, users=None, __props__=None);

func NewOauthApp(ctx *Context, name string, args OauthAppArgs, opts ...ResourceOption) (*OauthApp, error)

public OauthApp(string name, OauthAppArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args OauthAppArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args OauthAppArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args OauthAppArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

OauthApp Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The OauthApp resource accepts the following input properties:

Label string: Pretty name of app.
Type string: The type of client application.
AutoKeyRotation bool: Requested key rotation mode.
AutoSubmitToolbar bool: Display auto submit toolbar
ClientBasicSecret string: OAuth client secret key, this can be set when token_endpoint_auth_method is client_secret_basic.
ClientUri string: URI to a web page providing information about the client.
ConsentMethod string: Early Access Property. Indicates whether user consent is required or implicit. Valid values: REQUIRED, TRUSTED. Default value is TRUSTED
CustomClientId string: This property allows you to set your client_id.
GrantTypes List<string>: List of OAuth 2.0 grant types. Conditional validation params found here https://developer.okta.com/docs/api/resources/apps#credentials-settings-details. Defaults to minimum requirements per app type.
Groups List<string>: Groups associated with the application
HideIos bool: Do not display application icon on mobile app
HideWeb bool: Do not display application icon to users
IssuerMode string: Early Access Property. Indicates whether the Okta Authorization Server uses the original Okta org domain URL or a custom domain URL as the issuer of ID token for this client.
LoginUri string: URI that initiates login.
LogoUri string: URI that references a logo for the client.
OmitSecret bool: This tells the provider not to persist the application’s secret to state. If this is ever changes from true => false your app will be recreated.
PolicyUri string: Early Access Property. URI to web page providing client policy document.
PostLogoutRedirectUris List<string>: List of URIs for redirection after logout
Profile string: Custom JSON that represents an OAuth application’s profile
RedirectUris List<string>: List of URIs for use in the redirect-based flow. This is required for all application types except service. Note: see okta_app_oauth_redirect_uri for appending to this list in a decentralized way.
ResponseTypes List<string>: List of OAuth 2.0 response type strings.
Status string: Status of application.
TokenEndpointAuthMethod string: Requested authentication method for the token endpoint.
TosUri string: Early Access Property. URI to web page providing client tos (terms of service).
Users List<OauthAppUserArgs>: Users associated with the application

Label string: Pretty name of app.
Type string: The type of client application.
AutoKeyRotation bool: Requested key rotation mode.
AutoSubmitToolbar bool: Display auto submit toolbar
ClientBasicSecret string: OAuth client secret key, this can be set when token_endpoint_auth_method is client_secret_basic.
ClientUri string: URI to a web page providing information about the client.
ConsentMethod string: Early Access Property. Indicates whether user consent is required or implicit. Valid values: REQUIRED, TRUSTED. Default value is TRUSTED
CustomClientId string: This property allows you to set your client_id.
GrantTypes []string: List of OAuth 2.0 grant types. Conditional validation params found here https://developer.okta.com/docs/api/resources/apps#credentials-settings-details. Defaults to minimum requirements per app type.
Groups []string: Groups associated with the application
HideIos bool: Do not display application icon on mobile app
HideWeb bool: Do not display application icon to users
IssuerMode string: Early Access Property. Indicates whether the Okta Authorization Server uses the original Okta org domain URL or a custom domain URL as the issuer of ID token for this client.
LoginUri string: URI that initiates login.
LogoUri string: URI that references a logo for the client.
OmitSecret bool: This tells the provider not to persist the application’s secret to state. If this is ever changes from true => false your app will be recreated.
PolicyUri string: Early Access Property. URI to web page providing client policy document.
PostLogoutRedirectUris []string: List of URIs for redirection after logout
Profile string: Custom JSON that represents an OAuth application’s profile
RedirectUris []string: List of URIs for use in the redirect-based flow. This is required for all application types except service. Note: see okta_app_oauth_redirect_uri for appending to this list in a decentralized way.
ResponseTypes []string: List of OAuth 2.0 response type strings.
Status string: Status of application.
TokenEndpointAuthMethod string: Requested authentication method for the token endpoint.
TosUri string: Early Access Property. URI to web page providing client tos (terms of service).
Users []OauthAppUser: Users associated with the application

label string: Pretty name of app.
type string: The type of client application.
autoKeyRotation boolean: Requested key rotation mode.
autoSubmitToolbar boolean: Display auto submit toolbar
clientBasicSecret string: OAuth client secret key, this can be set when token_endpoint_auth_method is client_secret_basic.
clientUri string: URI to a web page providing information about the client.
consentMethod string: Early Access Property. Indicates whether user consent is required or implicit. Valid values: REQUIRED, TRUSTED. Default value is TRUSTED
customClientId string: This property allows you to set your client_id.
grantTypes string[]: List of OAuth 2.0 grant types. Conditional validation params found here https://developer.okta.com/docs/api/resources/apps#credentials-settings-details. Defaults to minimum requirements per app type.
groups string[]: Groups associated with the application
hideIos boolean: Do not display application icon on mobile app
hideWeb boolean: Do not display application icon to users
issuerMode string: Early Access Property. Indicates whether the Okta Authorization Server uses the original Okta org domain URL or a custom domain URL as the issuer of ID token for this client.
loginUri string: URI that initiates login.
logoUri string: URI that references a logo for the client.
omitSecret boolean: This tells the provider not to persist the application’s secret to state. If this is ever changes from true => false your app will be recreated.
policyUri string: Early Access Property. URI to web page providing client policy document.
postLogoutRedirectUris string[]: List of URIs for redirection after logout
profile string: Custom JSON that represents an OAuth application’s profile
redirectUris string[]: List of URIs for use in the redirect-based flow. This is required for all application types except service. Note: see okta_app_oauth_redirect_uri for appending to this list in a decentralized way.
responseTypes string[]: List of OAuth 2.0 response type strings.
status string: Status of application.
tokenEndpointAuthMethod string: Requested authentication method for the token endpoint.
tosUri string: Early Access Property. URI to web page providing client tos (terms of service).
users OauthAppUser[]: Users associated with the application

label str: Pretty name of app.
type str: The type of client application.
auto_key_rotation bool: Requested key rotation mode.
auto_submit_toolbar bool: Display auto submit toolbar
client_basic_secret str: OAuth client secret key, this can be set when token_endpoint_auth_method is client_secret_basic.
client_uri str: URI to a web page providing information about the client.
consent_method str: Early Access Property. Indicates whether user consent is required or implicit. Valid values: REQUIRED, TRUSTED. Default value is TRUSTED
custom_client_id str: This property allows you to set your client_id.
grant_types List[str]: List of OAuth 2.0 grant types. Conditional validation params found here https://developer.okta.com/docs/api/resources/apps#credentials-settings-details. Defaults to minimum requirements per app type.
groups List[str]: Groups associated with the application
hide_ios bool: Do not display application icon on mobile app
hide_web bool: Do not display application icon to users
issuer_mode str: Early Access Property. Indicates whether the Okta Authorization Server uses the original Okta org domain URL or a custom domain URL as the issuer of ID token for this client.
login_uri str: URI that initiates login.
logo_uri str: URI that references a logo for the client.
omit_secret bool: This tells the provider not to persist the application’s secret to state. If this is ever changes from true => false your app will be recreated.
policy_uri str: Early Access Property. URI to web page providing client policy document.
post_logout_redirect_uris List[str]: List of URIs for redirection after logout
profile str: Custom JSON that represents an OAuth application’s profile
redirect_uris List[str]: List of URIs for use in the redirect-based flow. This is required for all application types except service. Note: see okta_app_oauth_redirect_uri for appending to this list in a decentralized way.
response_types List[str]: List of OAuth 2.0 response type strings.
status str: Status of application.
token_endpoint_auth_method str: Requested authentication method for the token endpoint.
tos_uri str: Early Access Property. URI to web page providing client tos (terms of service).
users List[OauthAppUser]: Users associated with the application

Outputs

All input properties are implicitly available as output properties. Additionally, the OauthApp resource produces the following output properties:

ClientId string: OAuth client ID.
ClientSecret string: OAuth client secret key. This will be in plain text in your statefile unless you set omit_secret above.
Id string: The provider-assigned unique ID for this managed resource.
Name string: name of app.
SignOnMode string: Sign on mode of application.

ClientId string: OAuth client ID.
ClientSecret string: OAuth client secret key. This will be in plain text in your statefile unless you set omit_secret above.
Id string: The provider-assigned unique ID for this managed resource.
Name string: name of app.
SignOnMode string: Sign on mode of application.

clientId string: OAuth client ID.
clientSecret string: OAuth client secret key. This will be in plain text in your statefile unless you set omit_secret above.
id string: The provider-assigned unique ID for this managed resource.
name string: name of app.
signOnMode string: Sign on mode of application.

client_id str: OAuth client ID.
client_secret str: OAuth client secret key. This will be in plain text in your statefile unless you set omit_secret above.
id str: The provider-assigned unique ID for this managed resource.
name str: name of app.
sign_on_mode str: Sign on mode of application.

Look up an Existing OauthApp Resource

Get an existing OauthApp resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: OauthAppState, opts?: CustomResourceOptions): OauthApp

static get(resource_name, id, opts=None, auto_key_rotation=None, auto_submit_toolbar=None, client_basic_secret=None, client_id=None, client_secret=None, client_uri=None, consent_method=None, custom_client_id=None, grant_types=None, groups=None, hide_ios=None, hide_web=None, issuer_mode=None, label=None, login_uri=None, logo_uri=None, name=None, omit_secret=None, policy_uri=None, post_logout_redirect_uris=None, profile=None, redirect_uris=None, response_types=None, sign_on_mode=None, status=None, token_endpoint_auth_method=None, tos_uri=None, type=None, users=None, __props__=None);

func GetOauthApp(ctx *Context, name string, id IDInput, state *OauthAppState, opts ...ResourceOption) (*OauthApp, error)

public static OauthApp Get(string name, Input<string> id, OauthAppState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AutoKeyRotation bool: Requested key rotation mode.
AutoSubmitToolbar bool: Display auto submit toolbar
ClientBasicSecret string: OAuth client secret key, this can be set when token_endpoint_auth_method is client_secret_basic.
ClientId string: OAuth client ID.
ClientSecret string: OAuth client secret key. This will be in plain text in your statefile unless you set omit_secret above.
ClientUri string: URI to a web page providing information about the client.
ConsentMethod string: Early Access Property. Indicates whether user consent is required or implicit. Valid values: REQUIRED, TRUSTED. Default value is TRUSTED
CustomClientId string: This property allows you to set your client_id.
GrantTypes List<string>: List of OAuth 2.0 grant types. Conditional validation params found here https://developer.okta.com/docs/api/resources/apps#credentials-settings-details. Defaults to minimum requirements per app type.
Groups List<string>: Groups associated with the application
HideIos bool: Do not display application icon on mobile app
HideWeb bool: Do not display application icon to users
IssuerMode string: Early Access Property. Indicates whether the Okta Authorization Server uses the original Okta org domain URL or a custom domain URL as the issuer of ID token for this client.
Label string: Pretty name of app.
LoginUri string: URI that initiates login.
LogoUri string: URI that references a logo for the client.
Name string: name of app.
OmitSecret bool: This tells the provider not to persist the application’s secret to state. If this is ever changes from true => false your app will be recreated.
PolicyUri string: Early Access Property. URI to web page providing client policy document.
PostLogoutRedirectUris List<string>: List of URIs for redirection after logout
Profile string: Custom JSON that represents an OAuth application’s profile
RedirectUris List<string>: List of URIs for use in the redirect-based flow. This is required for all application types except service. Note: see okta_app_oauth_redirect_uri for appending to this list in a decentralized way.
ResponseTypes List<string>: List of OAuth 2.0 response type strings.
SignOnMode string: Sign on mode of application.
Status string: Status of application.
TokenEndpointAuthMethod string: Requested authentication method for the token endpoint.
TosUri string: Early Access Property. URI to web page providing client tos (terms of service).
Type string: The type of client application.
Users List<OauthAppUserArgs>: Users associated with the application

AutoKeyRotation bool: Requested key rotation mode.
AutoSubmitToolbar bool: Display auto submit toolbar
ClientBasicSecret string: OAuth client secret key, this can be set when token_endpoint_auth_method is client_secret_basic.
ClientId string: OAuth client ID.
ClientSecret string: OAuth client secret key. This will be in plain text in your statefile unless you set omit_secret above.
ClientUri string: URI to a web page providing information about the client.
ConsentMethod string: Early Access Property. Indicates whether user consent is required or implicit. Valid values: REQUIRED, TRUSTED. Default value is TRUSTED
CustomClientId string: This property allows you to set your client_id.
GrantTypes []string: List of OAuth 2.0 grant types. Conditional validation params found here https://developer.okta.com/docs/api/resources/apps#credentials-settings-details. Defaults to minimum requirements per app type.
Groups []string: Groups associated with the application
HideIos bool: Do not display application icon on mobile app
HideWeb bool: Do not display application icon to users
IssuerMode string: Early Access Property. Indicates whether the Okta Authorization Server uses the original Okta org domain URL or a custom domain URL as the issuer of ID token for this client.
Label string: Pretty name of app.
LoginUri string: URI that initiates login.
LogoUri string: URI that references a logo for the client.
Name string: name of app.
OmitSecret bool: This tells the provider not to persist the application’s secret to state. If this is ever changes from true => false your app will be recreated.
PolicyUri string: Early Access Property. URI to web page providing client policy document.
PostLogoutRedirectUris []string: List of URIs for redirection after logout
Profile string: Custom JSON that represents an OAuth application’s profile
RedirectUris []string: List of URIs for use in the redirect-based flow. This is required for all application types except service. Note: see okta_app_oauth_redirect_uri for appending to this list in a decentralized way.
ResponseTypes []string: List of OAuth 2.0 response type strings.
SignOnMode string: Sign on mode of application.
Status string: Status of application.
TokenEndpointAuthMethod string: Requested authentication method for the token endpoint.
TosUri string: Early Access Property. URI to web page providing client tos (terms of service).
Type string: The type of client application.
Users []OauthAppUser: Users associated with the application

autoKeyRotation boolean: Requested key rotation mode.
autoSubmitToolbar boolean: Display auto submit toolbar
clientBasicSecret string: OAuth client secret key, this can be set when token_endpoint_auth_method is client_secret_basic.
clientId string: OAuth client ID.
clientSecret string: OAuth client secret key. This will be in plain text in your statefile unless you set omit_secret above.
clientUri string: URI to a web page providing information about the client.
consentMethod string: Early Access Property. Indicates whether user consent is required or implicit. Valid values: REQUIRED, TRUSTED. Default value is TRUSTED
customClientId string: This property allows you to set your client_id.
grantTypes string[]: List of OAuth 2.0 grant types. Conditional validation params found here https://developer.okta.com/docs/api/resources/apps#credentials-settings-details. Defaults to minimum requirements per app type.
groups string[]: Groups associated with the application
hideIos boolean: Do not display application icon on mobile app
hideWeb boolean: Do not display application icon to users
issuerMode string: Early Access Property. Indicates whether the Okta Authorization Server uses the original Okta org domain URL or a custom domain URL as the issuer of ID token for this client.
label string: Pretty name of app.
loginUri string: URI that initiates login.
logoUri string: URI that references a logo for the client.
name string: name of app.
omitSecret boolean: This tells the provider not to persist the application’s secret to state. If this is ever changes from true => false your app will be recreated.
policyUri string: Early Access Property. URI to web page providing client policy document.
postLogoutRedirectUris string[]: List of URIs for redirection after logout
profile string: Custom JSON that represents an OAuth application’s profile
redirectUris string[]: List of URIs for use in the redirect-based flow. This is required for all application types except service. Note: see okta_app_oauth_redirect_uri for appending to this list in a decentralized way.
responseTypes string[]: List of OAuth 2.0 response type strings.
signOnMode string: Sign on mode of application.
status string: Status of application.
tokenEndpointAuthMethod string: Requested authentication method for the token endpoint.
tosUri string: Early Access Property. URI to web page providing client tos (terms of service).
type string: The type of client application.
users OauthAppUser[]: Users associated with the application

auto_key_rotation bool: Requested key rotation mode.
auto_submit_toolbar bool: Display auto submit toolbar
client_basic_secret str: OAuth client secret key, this can be set when token_endpoint_auth_method is client_secret_basic.
client_id str: OAuth client ID.
client_secret str: OAuth client secret key. This will be in plain text in your statefile unless you set omit_secret above.
client_uri str: URI to a web page providing information about the client.
consent_method str: Early Access Property. Indicates whether user consent is required or implicit. Valid values: REQUIRED, TRUSTED. Default value is TRUSTED
custom_client_id str: This property allows you to set your client_id.
grant_types List[str]: List of OAuth 2.0 grant types. Conditional validation params found here https://developer.okta.com/docs/api/resources/apps#credentials-settings-details. Defaults to minimum requirements per app type.
groups List[str]: Groups associated with the application
hide_ios bool: Do not display application icon on mobile app
hide_web bool: Do not display application icon to users
issuer_mode str: Early Access Property. Indicates whether the Okta Authorization Server uses the original Okta org domain URL or a custom domain URL as the issuer of ID token for this client.
label str: Pretty name of app.
login_uri str: URI that initiates login.
logo_uri str: URI that references a logo for the client.
name str: name of app.
omit_secret bool: This tells the provider not to persist the application’s secret to state. If this is ever changes from true => false your app will be recreated.
policy_uri str: Early Access Property. URI to web page providing client policy document.
post_logout_redirect_uris List[str]: List of URIs for redirection after logout
profile str: Custom JSON that represents an OAuth application’s profile
redirect_uris List[str]: List of URIs for use in the redirect-based flow. This is required for all application types except service. Note: see okta_app_oauth_redirect_uri for appending to this list in a decentralized way.
response_types List[str]: List of OAuth 2.0 response type strings.
sign_on_mode str: Sign on mode of application.
status str: Status of application.
token_endpoint_auth_method str: Requested authentication method for the token endpoint.
tos_uri str: Early Access Property. URI to web page providing client tos (terms of service).
type str: The type of client application.
users List[OauthAppUser]: Users associated with the application

Supporting Types

OauthAppUser

See the input and output API doc for this type.

Id string
Password string
Scope string
Username string

Id string
Password string
Scope string
Username string

id string
password string
scope string
username string

id str
password str
scope str
username str

Package Details

Repository: https://github.com/pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud