published on Sunday, Oct 11, 2026 by Descope
published on Sunday, Oct 11, 2026 by Descope
Manages a single OIDC federated application where Descope acts as the identity provider.
Create OidcApp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new OidcApp(name: string, args: OidcAppArgs, opts?: CustomResourceOptions);@overload
def OidcApp(resource_name: str,
args: OidcAppArgs,
opts: Optional[ResourceOptions] = None)
@overload
def OidcApp(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
device_code_disabled: Optional[bool] = None,
default_audience: Optional[str] = None,
claims: Optional[Sequence[str]] = None,
client_credentials_disabled: Optional[bool] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
client_type: Optional[str] = None,
disabled: Optional[bool] = None,
approved_redirect_urls: Optional[Sequence[str]] = None,
deletion_protection: Optional[bool] = None,
backchannel_logout_url: Optional[str] = None,
description: Optional[str] = None,
custom_idp_initiated_login_page_url: Optional[str] = None,
force_authentication: Optional[bool] = None,
force_pkce: Optional[bool] = None,
jwt_bearer_disabled: Optional[bool] = None,
login_page_url: Optional[str] = None,
logo: Optional[str] = None,
name: Optional[str] = None,
oidc_app_id: Optional[str] = None,
authorization_code_disabled: Optional[bool] = None,
refresh_token_disabled: Optional[bool] = None,
trusted_apps_audience: Optional[str] = None)func NewOidcApp(ctx *Context, name string, args OidcAppArgs, opts ...ResourceOption) (*OidcApp, error)public OidcApp(string name, OidcAppArgs args, CustomResourceOptions? opts = null)
public OidcApp(String name, OidcAppArgs args)
public OidcApp(String name, OidcAppArgs args, CustomResourceOptions options)
type: descope:OidcApp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "descope_oidc_app" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args OidcAppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args OidcAppArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args OidcAppArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args OidcAppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args OidcAppArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var oidcAppResource = new Descope.OidcApp("oidcAppResource", new()
{
ProjectId = "string",
DeviceCodeDisabled = false,
DefaultAudience = "string",
Claims = new[]
{
"string",
},
ClientCredentialsDisabled = false,
ClientId = "string",
ClientSecret = "string",
ClientType = "string",
Disabled = false,
ApprovedRedirectUrls = new[]
{
"string",
},
DeletionProtection = false,
BackchannelLogoutUrl = "string",
Description = "string",
CustomIdpInitiatedLoginPageUrl = "string",
ForceAuthentication = false,
ForcePkce = false,
JwtBearerDisabled = false,
LoginPageUrl = "string",
Logo = "string",
Name = "string",
OidcAppId = "string",
AuthorizationCodeDisabled = false,
RefreshTokenDisabled = false,
TrustedAppsAudience = "string",
});
example, err := descope.NewOidcApp(ctx, "oidcAppResource", &descope.OidcAppArgs{
ProjectId: pulumi.String("string"),
DeviceCodeDisabled: pulumi.Bool(false),
DefaultAudience: pulumi.String("string"),
Claims: pulumi.StringArray{
pulumi.String("string"),
},
ClientCredentialsDisabled: pulumi.Bool(false),
ClientId: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
ClientType: pulumi.String("string"),
Disabled: pulumi.Bool(false),
ApprovedRedirectUrls: pulumi.StringArray{
pulumi.String("string"),
},
DeletionProtection: pulumi.Bool(false),
BackchannelLogoutUrl: pulumi.String("string"),
Description: pulumi.String("string"),
CustomIdpInitiatedLoginPageUrl: pulumi.String("string"),
ForceAuthentication: pulumi.Bool(false),
ForcePkce: pulumi.Bool(false),
JwtBearerDisabled: pulumi.Bool(false),
LoginPageUrl: pulumi.String("string"),
Logo: pulumi.String("string"),
Name: pulumi.String("string"),
OidcAppId: pulumi.String("string"),
AuthorizationCodeDisabled: pulumi.Bool(false),
RefreshTokenDisabled: pulumi.Bool(false),
TrustedAppsAudience: pulumi.String("string"),
})
resource "descope_oidc_app" "oidcAppResource" {
lifecycle {
create_before_destroy = true
}
project_id = "string"
device_code_disabled = false
default_audience = "string"
claims = ["string"]
client_credentials_disabled = false
client_id = "string"
client_secret = "string"
client_type = "string"
disabled = false
approved_redirect_urls = ["string"]
deletion_protection = false
backchannel_logout_url = "string"
description = "string"
custom_idp_initiated_login_page_url = "string"
force_authentication = false
force_pkce = false
jwt_bearer_disabled = false
login_page_url = "string"
logo = "string"
name = "string"
oidc_app_id = "string"
authorization_code_disabled = false
refresh_token_disabled = false
trusted_apps_audience = "string"
}
var oidcAppResource = new OidcApp("oidcAppResource", OidcAppArgs.builder()
.projectId("string")
.deviceCodeDisabled(false)
.defaultAudience("string")
.claims("string")
.clientCredentialsDisabled(false)
.clientId("string")
.clientSecret("string")
.clientType("string")
.disabled(false)
.approvedRedirectUrls("string")
.deletionProtection(false)
.backchannelLogoutUrl("string")
.description("string")
.customIdpInitiatedLoginPageUrl("string")
.forceAuthentication(false)
.forcePkce(false)
.jwtBearerDisabled(false)
.loginPageUrl("string")
.logo("string")
.name("string")
.oidcAppId("string")
.authorizationCodeDisabled(false)
.refreshTokenDisabled(false)
.trustedAppsAudience("string")
.build());
oidc_app_resource = descope.OidcApp("oidcAppResource",
project_id="string",
device_code_disabled=False,
default_audience="string",
claims=["string"],
client_credentials_disabled=False,
client_id="string",
client_secret="string",
client_type="string",
disabled=False,
approved_redirect_urls=["string"],
deletion_protection=False,
backchannel_logout_url="string",
description="string",
custom_idp_initiated_login_page_url="string",
force_authentication=False,
force_pkce=False,
jwt_bearer_disabled=False,
login_page_url="string",
logo="string",
name="string",
oidc_app_id="string",
authorization_code_disabled=False,
refresh_token_disabled=False,
trusted_apps_audience="string")
const oidcAppResource = new descope.OidcApp("oidcAppResource", {
projectId: "string",
deviceCodeDisabled: false,
defaultAudience: "string",
claims: ["string"],
clientCredentialsDisabled: false,
clientId: "string",
clientSecret: "string",
clientType: "string",
disabled: false,
approvedRedirectUrls: ["string"],
deletionProtection: false,
backchannelLogoutUrl: "string",
description: "string",
customIdpInitiatedLoginPageUrl: "string",
forceAuthentication: false,
forcePkce: false,
jwtBearerDisabled: false,
loginPageUrl: "string",
logo: "string",
name: "string",
oidcAppId: "string",
authorizationCodeDisabled: false,
refreshTokenDisabled: false,
trustedAppsAudience: "string",
});
type: descope:OidcApp
properties:
approvedRedirectUrls:
- string
authorizationCodeDisabled: false
backchannelLogoutUrl: string
claims:
- string
clientCredentialsDisabled: false
clientId: string
clientSecret: string
clientType: string
customIdpInitiatedLoginPageUrl: string
defaultAudience: string
deletionProtection: false
description: string
deviceCodeDisabled: false
disabled: false
forceAuthentication: false
forcePkce: false
jwtBearerDisabled: false
loginPageUrl: string
logo: string
name: string
oidcAppId: string
projectId: string
refreshTokenDisabled: false
trustedAppsAudience: string
OidcApp Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The OidcApp resource accepts the following input properties:
- Project
Id string - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- Approved
Redirect List<string>Urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - bool
- Disables the
authorizationCodegrant type for this application. - Backchannel
Logout stringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- Claims List<string>
- A list of supported claims. e.g.
sub,email,exp. - Client
Credentials boolDisabled - Disables the
clientCredentialsgrant type for this application. - Client
Id string - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - Client
Secret string - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - Client
Type string - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - Custom
Idp stringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- Default
Audience string - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - Deletion
Protection bool - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - Description string
- A description for the OIDC application.
- Device
Code boolDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - Disabled bool
- Whether the application should be enabled or disabled.
- Force
Authentication bool - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- Force
Pkce bool - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - Jwt
Bearer boolDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - Login
Page stringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- Logo string
- A logo for the OIDC application. Should be a hosted image URL.
- Name string
- A name for the OIDC application.
- Oidc
App stringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- Refresh
Token boolDisabled - Disables the
refreshTokengrant type for this application. - Trusted
Apps stringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- Project
Id string - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- Approved
Redirect []stringUrls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - bool
- Disables the
authorizationCodegrant type for this application. - Backchannel
Logout stringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- Claims []string
- A list of supported claims. e.g.
sub,email,exp. - Client
Credentials boolDisabled - Disables the
clientCredentialsgrant type for this application. - Client
Id string - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - Client
Secret string - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - Client
Type string - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - Custom
Idp stringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- Default
Audience string - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - Deletion
Protection bool - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - Description string
- A description for the OIDC application.
- Device
Code boolDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - Disabled bool
- Whether the application should be enabled or disabled.
- Force
Authentication bool - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- Force
Pkce bool - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - Jwt
Bearer boolDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - Login
Page stringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- Logo string
- A logo for the OIDC application. Should be a hosted image URL.
- Name string
- A name for the OIDC application.
- Oidc
App stringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- Refresh
Token boolDisabled - Disables the
refreshTokengrant type for this application. - Trusted
Apps stringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- project_
id string - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- approved_
redirect_ list(string)urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - bool
- Disables the
authorizationCodegrant type for this application. - backchannel_
logout_ stringurl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims list(string)
- A list of supported claims. e.g.
sub,email,exp. - client_
credentials_ booldisabled - Disables the
clientCredentialsgrant type for this application. - client_
id string - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client_
secret string - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client_
type string - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom_
idp_ stringinitiated_ login_ page_ url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default_
audience string - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion_
protection bool - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description string
- A description for the OIDC application.
- device_
code_ booldisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled bool
- Whether the application should be enabled or disabled.
- force_
authentication bool - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force_
pkce bool - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt_
bearer_ booldisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login_
page_ stringurl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo string
- A logo for the OIDC application. Should be a hosted image URL.
- name string
- A name for the OIDC application.
- oidc_
app_ stringid - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- refresh_
token_ booldisabled - Disables the
refreshTokengrant type for this application. - trusted_
apps_ stringaudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- project
Id String - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- approved
Redirect List<String>Urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - Boolean
- Disables the
authorizationCodegrant type for this application. - backchannel
Logout StringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims List<String>
- A list of supported claims. e.g.
sub,email,exp. - client
Credentials BooleanDisabled - Disables the
clientCredentialsgrant type for this application. - client
Id String - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client
Secret String - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client
Type String - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom
Idp StringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default
Audience String - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion
Protection Boolean - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description String
- A description for the OIDC application.
- device
Code BooleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled Boolean
- Whether the application should be enabled or disabled.
- force
Authentication Boolean - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force
Pkce Boolean - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt
Bearer BooleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login
Page StringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo String
- A logo for the OIDC application. Should be a hosted image URL.
- name String
- A name for the OIDC application.
- oidc
App StringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- refresh
Token BooleanDisabled - Disables the
refreshTokengrant type for this application. - trusted
Apps StringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- project
Id string - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- approved
Redirect string[]Urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - boolean
- Disables the
authorizationCodegrant type for this application. - backchannel
Logout stringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims string[]
- A list of supported claims. e.g.
sub,email,exp. - client
Credentials booleanDisabled - Disables the
clientCredentialsgrant type for this application. - client
Id string - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client
Secret string - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client
Type string - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom
Idp stringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default
Audience string - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion
Protection boolean - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description string
- A description for the OIDC application.
- device
Code booleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled boolean
- Whether the application should be enabled or disabled.
- force
Authentication boolean - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force
Pkce boolean - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt
Bearer booleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login
Page stringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo string
- A logo for the OIDC application. Should be a hosted image URL.
- name string
- A name for the OIDC application.
- oidc
App stringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- refresh
Token booleanDisabled - Disables the
refreshTokengrant type for this application. - trusted
Apps stringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- project_
id str - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- approved_
redirect_ Sequence[str]urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - bool
- Disables the
authorizationCodegrant type for this application. - backchannel_
logout_ strurl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims Sequence[str]
- A list of supported claims. e.g.
sub,email,exp. - client_
credentials_ booldisabled - Disables the
clientCredentialsgrant type for this application. - client_
id str - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client_
secret str - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client_
type str - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom_
idp_ strinitiated_ login_ page_ url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default_
audience str - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion_
protection bool - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description str
- A description for the OIDC application.
- device_
code_ booldisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled bool
- Whether the application should be enabled or disabled.
- force_
authentication bool - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force_
pkce bool - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt_
bearer_ booldisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login_
page_ strurl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo str
- A logo for the OIDC application. Should be a hosted image URL.
- name str
- A name for the OIDC application.
- oidc_
app_ strid - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- refresh_
token_ booldisabled - Disables the
refreshTokengrant type for this application. - trusted_
apps_ straudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- project
Id String - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- approved
Redirect List<String>Urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - Boolean
- Disables the
authorizationCodegrant type for this application. - backchannel
Logout StringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims List<String>
- A list of supported claims. e.g.
sub,email,exp. - client
Credentials BooleanDisabled - Disables the
clientCredentialsgrant type for this application. - client
Id String - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client
Secret String - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client
Type String - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom
Idp StringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default
Audience String - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion
Protection Boolean - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description String
- A description for the OIDC application.
- device
Code BooleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled Boolean
- Whether the application should be enabled or disabled.
- force
Authentication Boolean - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force
Pkce Boolean - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt
Bearer BooleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login
Page StringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo String
- A logo for the OIDC application. Should be a hosted image URL.
- name String
- A name for the OIDC application.
- oidc
App StringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- refresh
Token BooleanDisabled - Disables the
refreshTokengrant type for this application. - trusted
Apps StringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
Outputs
All input properties are implicitly available as output properties. Additionally, the OidcApp resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing OidcApp Resource
Get an existing OidcApp 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?: OidcAppState, opts?: CustomResourceOptions): OidcApp@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
approved_redirect_urls: Optional[Sequence[str]] = None,
authorization_code_disabled: Optional[bool] = None,
backchannel_logout_url: Optional[str] = None,
claims: Optional[Sequence[str]] = None,
client_credentials_disabled: Optional[bool] = None,
client_id: Optional[str] = None,
client_secret: Optional[str] = None,
client_type: Optional[str] = None,
custom_idp_initiated_login_page_url: Optional[str] = None,
default_audience: Optional[str] = None,
deletion_protection: Optional[bool] = None,
description: Optional[str] = None,
device_code_disabled: Optional[bool] = None,
disabled: Optional[bool] = None,
force_authentication: Optional[bool] = None,
force_pkce: Optional[bool] = None,
jwt_bearer_disabled: Optional[bool] = None,
login_page_url: Optional[str] = None,
logo: Optional[str] = None,
name: Optional[str] = None,
oidc_app_id: Optional[str] = None,
project_id: Optional[str] = None,
refresh_token_disabled: Optional[bool] = None,
trusted_apps_audience: Optional[str] = None) -> OidcAppfunc GetOidcApp(ctx *Context, name string, id IDInput, state *OidcAppState, opts ...ResourceOption) (*OidcApp, error)public static OidcApp Get(string name, Input<string> id, OidcAppState? state, CustomResourceOptions? opts = null)public static OidcApp get(String name, Output<String> id, OidcAppState state, CustomResourceOptions options)resources: existingOidcApp: type: descope:OidcApp get: id: ${id}import {
to = descope_oidc_app.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state OidcAppState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state OidcAppState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state OidcAppState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state OidcAppState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Approved
Redirect List<string>Urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - bool
- Disables the
authorizationCodegrant type for this application. - Backchannel
Logout stringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- Claims List<string>
- A list of supported claims. e.g.
sub,email,exp. - Client
Credentials boolDisabled - Disables the
clientCredentialsgrant type for this application. - Client
Id string - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - Client
Secret string - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - Client
Type string - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - Custom
Idp stringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- Default
Audience string - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - Deletion
Protection bool - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - Description string
- A description for the OIDC application.
- Device
Code boolDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - Disabled bool
- Whether the application should be enabled or disabled.
- Force
Authentication bool - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- Force
Pkce bool - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - Jwt
Bearer boolDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - Login
Page stringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- Logo string
- A logo for the OIDC application. Should be a hosted image URL.
- Name string
- A name for the OIDC application.
- Oidc
App stringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- Project
Id string - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- Refresh
Token boolDisabled - Disables the
refreshTokengrant type for this application. - Trusted
Apps stringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- Approved
Redirect []stringUrls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - bool
- Disables the
authorizationCodegrant type for this application. - Backchannel
Logout stringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- Claims []string
- A list of supported claims. e.g.
sub,email,exp. - Client
Credentials boolDisabled - Disables the
clientCredentialsgrant type for this application. - Client
Id string - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - Client
Secret string - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - Client
Type string - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - Custom
Idp stringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- Default
Audience string - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - Deletion
Protection bool - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - Description string
- A description for the OIDC application.
- Device
Code boolDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - Disabled bool
- Whether the application should be enabled or disabled.
- Force
Authentication bool - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- Force
Pkce bool - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - Jwt
Bearer boolDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - Login
Page stringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- Logo string
- A logo for the OIDC application. Should be a hosted image URL.
- Name string
- A name for the OIDC application.
- Oidc
App stringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- Project
Id string - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- Refresh
Token boolDisabled - Disables the
refreshTokengrant type for this application. - Trusted
Apps stringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- approved_
redirect_ list(string)urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - bool
- Disables the
authorizationCodegrant type for this application. - backchannel_
logout_ stringurl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims list(string)
- A list of supported claims. e.g.
sub,email,exp. - client_
credentials_ booldisabled - Disables the
clientCredentialsgrant type for this application. - client_
id string - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client_
secret string - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client_
type string - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom_
idp_ stringinitiated_ login_ page_ url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default_
audience string - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion_
protection bool - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description string
- A description for the OIDC application.
- device_
code_ booldisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled bool
- Whether the application should be enabled or disabled.
- force_
authentication bool - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force_
pkce bool - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt_
bearer_ booldisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login_
page_ stringurl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo string
- A logo for the OIDC application. Should be a hosted image URL.
- name string
- A name for the OIDC application.
- oidc_
app_ stringid - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- project_
id string - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- refresh_
token_ booldisabled - Disables the
refreshTokengrant type for this application. - trusted_
apps_ stringaudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- approved
Redirect List<String>Urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - Boolean
- Disables the
authorizationCodegrant type for this application. - backchannel
Logout StringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims List<String>
- A list of supported claims. e.g.
sub,email,exp. - client
Credentials BooleanDisabled - Disables the
clientCredentialsgrant type for this application. - client
Id String - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client
Secret String - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client
Type String - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom
Idp StringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default
Audience String - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion
Protection Boolean - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description String
- A description for the OIDC application.
- device
Code BooleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled Boolean
- Whether the application should be enabled or disabled.
- force
Authentication Boolean - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force
Pkce Boolean - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt
Bearer BooleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login
Page StringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo String
- A logo for the OIDC application. Should be a hosted image URL.
- name String
- A name for the OIDC application.
- oidc
App StringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- project
Id String - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- refresh
Token BooleanDisabled - Disables the
refreshTokengrant type for this application. - trusted
Apps StringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- approved
Redirect string[]Urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - boolean
- Disables the
authorizationCodegrant type for this application. - backchannel
Logout stringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims string[]
- A list of supported claims. e.g.
sub,email,exp. - client
Credentials booleanDisabled - Disables the
clientCredentialsgrant type for this application. - client
Id string - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client
Secret string - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client
Type string - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom
Idp stringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default
Audience string - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion
Protection boolean - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description string
- A description for the OIDC application.
- device
Code booleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled boolean
- Whether the application should be enabled or disabled.
- force
Authentication boolean - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force
Pkce boolean - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt
Bearer booleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login
Page stringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo string
- A logo for the OIDC application. Should be a hosted image URL.
- name string
- A name for the OIDC application.
- oidc
App stringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- project
Id string - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- refresh
Token booleanDisabled - Disables the
refreshTokengrant type for this application. - trusted
Apps stringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- approved_
redirect_ Sequence[str]urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - bool
- Disables the
authorizationCodegrant type for this application. - backchannel_
logout_ strurl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims Sequence[str]
- A list of supported claims. e.g.
sub,email,exp. - client_
credentials_ booldisabled - Disables the
clientCredentialsgrant type for this application. - client_
id str - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client_
secret str - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client_
type str - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom_
idp_ strinitiated_ login_ page_ url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default_
audience str - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion_
protection bool - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description str
- A description for the OIDC application.
- device_
code_ booldisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled bool
- Whether the application should be enabled or disabled.
- force_
authentication bool - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force_
pkce bool - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt_
bearer_ booldisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login_
page_ strurl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo str
- A logo for the OIDC application. Should be a hosted image URL.
- name str
- A name for the OIDC application.
- oidc_
app_ strid - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- project_
id str - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- refresh_
token_ booldisabled - Disables the
refreshTokengrant type for this application. - trusted_
apps_ straudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
- approved
Redirect List<String>Urls - A list of approved redirect URLs for this application (supports
*wildcards). When set, redirect URIs are validated against this per-app list; when empty, validation falls back to the project's approved/trusted domains. - Boolean
- Disables the
authorizationCodegrant type for this application. - backchannel
Logout StringUrl - The URL that Descope notifies with a logout token when the user's session ends, as per the OIDC Back-Channel Logout specification. Leave empty to disable back-channel logout notifications for this application.
- claims List<String>
- A list of supported claims. e.g.
sub,email,exp. - client
Credentials BooleanDisabled - Disables the
clientCredentialsgrant type for this application. - client
Id String - A dedicated OIDC
clientIdto import for this application. When omitted, theclientIdis generated by the server and is not returned on reads. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated. - client
Secret String - A dedicated OIDC
clientSecretto import for this application. When omitted, a secret is generated server-side only for applications with aconfidentialclient type, either on creation or when the application is later switched toconfidential, and fetched into the Terraform state. Applications with other client types don't use a client secret and the value stays empty. The value in the state is never overwritten afterwards, so a secret rotated via the API or the Descope console is not reflected until the resource is replaced. Changing this value will require the resource to be deleted and recreated. - client
Type String - OAuth client confidentiality. One of
""(default — legacy access-key authentication),"confidential"(a dedicated client secret is generated for the app), or"public"(PKCE only, no client secret). Changing this value on an existing application changes how its clients must authenticate, so coordinate the change with the application's developers. - custom
Idp StringInitiated Login Page Url - A custom login page URL to redirect users to on IdP-initiated login flows, instead of the default login page.
- default
Audience String - Controls the default
audclaim of tokens issued for this application. One of"projectId"(the project ID only),"clientId"(the dedicated client ID only),"appId"(the application ID only),"empty"(noaudclaim at all), or""(default — both the project ID and the client ID). Only applies to modern apps that set aclientType; legacy apps always use the project ID, so the empty default leaves their behavior unchanged. - deletion
Protection Boolean - Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration and invalidates its client credentials, so these applications are protected by default. To allow the resource to be destroyed or replaced, for example in ephemeral test environments, set this attribute to
falseand apply the change first. - description String
- A description for the OIDC application.
- device
Code BooleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:device_codegrant type for this application. - disabled Boolean
- Whether the application should be enabled or disabled.
- force
Authentication Boolean - This configuration overrides the default behavior of the SSO application and forces the user to authenticate via the Descope flow, regardless of the SP's request.
- force
Pkce Boolean - When enabled, the authorization code flow requires PKCE in addition to the normal client authentication. A confidential client must then present both its client secret and a valid PKCE
codeVerifier. Public clients always use PKCE regardless of this setting. - jwt
Bearer BooleanDisabled - Disables the
urn:ietf:params:oauth:grant-type:jwt-bearergrant type for this application. - login
Page StringUrl - The Flow Hosting URL. When left empty the project's default login page URL is used, and the computed value is reflected in this attribute. Read more about using this parameter with custom domain here.
- logo String
- A logo for the OIDC application. Should be a hosted image URL.
- name String
- A name for the OIDC application.
- oidc
App StringId - An optional identifier for the application. When omitted, an identifier is generated by the server. Can only be set when the application is created, and changing it will require the resource to be deleted and recreated.
- project
Id String - The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
- refresh
Token BooleanDisabled - Disables the
refreshTokengrant type for this application. - trusted
Apps StringAudience - Controls the audience values appended to the issued token's
audclaim for trusted sibling applications. One of"projectId","clientId","appId","empty"(add none), or""(default — both the project ID and the client ID). Independent ofdefaultAudience.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope