1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. OutboundApp
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope
descope logo Descope
Viewing docs for Descope v1.0.1
published on Sunday, Oct 11, 2026 by Descope

    Manages a custom outbound application in a Descope project. Outbound applications let Descope hold and refresh a third party OAuth token on behalf of a user or a tenant, so an application can call that provider’s API without implementing the OAuth flow itself.

    Create OutboundApp Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OutboundApp(name: string, args: OutboundAppArgs, opts?: CustomResourceOptions);
    @overload
    def OutboundApp(resource_name: str,
                    args: OutboundAppArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def OutboundApp(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    project_id: Optional[str] = None,
                    default_scopes: Optional[Sequence[str]] = None,
                    logo: Optional[str] = None,
                    authorization_url_params: Optional[Mapping[str, str]] = None,
                    callback_domain: Optional[str] = None,
                    client_id: Optional[str] = None,
                    client_secret: Optional[str] = None,
                    default_redirect_url: Optional[str] = None,
                    access_type: Optional[str] = None,
                    authorization_url: Optional[str] = None,
                    description: Optional[str] = None,
                    discovery_url: Optional[str] = None,
                    name: Optional[str] = None,
                    pkce: Optional[bool] = None,
                    app_type: Optional[str] = None,
                    prompts: Optional[Sequence[str]] = None,
                    revocation_url: Optional[str] = None,
                    token_url: Optional[str] = None,
                    token_url_params: Optional[Mapping[str, str]] = None)
    func NewOutboundApp(ctx *Context, name string, args OutboundAppArgs, opts ...ResourceOption) (*OutboundApp, error)
    public OutboundApp(string name, OutboundAppArgs args, CustomResourceOptions? opts = null)
    public OutboundApp(String name, OutboundAppArgs args)
    public OutboundApp(String name, OutboundAppArgs args, CustomResourceOptions options)
    
    type: descope:OutboundApp
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_outbound_app" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args OutboundAppArgs
    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 OutboundAppArgs
    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 OutboundAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OutboundAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OutboundAppArgs
    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 outboundAppResource = new Descope.OutboundApp("outboundAppResource", new()
    {
        ProjectId = "string",
        DefaultScopes = new[]
        {
            "string",
        },
        Logo = "string",
        AuthorizationUrlParams = 
        {
            { "string", "string" },
        },
        CallbackDomain = "string",
        ClientId = "string",
        ClientSecret = "string",
        DefaultRedirectUrl = "string",
        AccessType = "string",
        AuthorizationUrl = "string",
        Description = "string",
        DiscoveryUrl = "string",
        Name = "string",
        Pkce = false,
        AppType = "string",
        Prompts = new[]
        {
            "string",
        },
        RevocationUrl = "string",
        TokenUrl = "string",
        TokenUrlParams = 
        {
            { "string", "string" },
        },
    });
    
    example, err := descope.NewOutboundApp(ctx, "outboundAppResource", &descope.OutboundAppArgs{
    	ProjectId: pulumi.String("string"),
    	DefaultScopes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Logo: pulumi.String("string"),
    	AuthorizationUrlParams: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	CallbackDomain:     pulumi.String("string"),
    	ClientId:           pulumi.String("string"),
    	ClientSecret:       pulumi.String("string"),
    	DefaultRedirectUrl: pulumi.String("string"),
    	AccessType:         pulumi.String("string"),
    	AuthorizationUrl:   pulumi.String("string"),
    	Description:        pulumi.String("string"),
    	DiscoveryUrl:       pulumi.String("string"),
    	Name:               pulumi.String("string"),
    	Pkce:               pulumi.Bool(false),
    	AppType:            pulumi.String("string"),
    	Prompts: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	RevocationUrl: pulumi.String("string"),
    	TokenUrl:      pulumi.String("string"),
    	TokenUrlParams: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    resource "descope_outbound_app" "outboundAppResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id     = "string"
      default_scopes = ["string"]
      logo           = "string"
      authorization_url_params = {
        "string" = "string"
      }
      callback_domain      = "string"
      client_id            = "string"
      client_secret        = "string"
      default_redirect_url = "string"
      access_type          = "string"
      authorization_url    = "string"
      description          = "string"
      discovery_url        = "string"
      name                 = "string"
      pkce                 = false
      app_type             = "string"
      prompts              = ["string"]
      revocation_url       = "string"
      token_url            = "string"
      token_url_params = {
        "string" = "string"
      }
    }
    
    var outboundAppResource = new OutboundApp("outboundAppResource", OutboundAppArgs.builder()
        .projectId("string")
        .defaultScopes("string")
        .logo("string")
        .authorizationUrlParams(Map.of("string", "string"))
        .callbackDomain("string")
        .clientId("string")
        .clientSecret("string")
        .defaultRedirectUrl("string")
        .accessType("string")
        .authorizationUrl("string")
        .description("string")
        .discoveryUrl("string")
        .name("string")
        .pkce(false)
        .appType("string")
        .prompts("string")
        .revocationUrl("string")
        .tokenUrl("string")
        .tokenUrlParams(Map.of("string", "string"))
        .build());
    
    outbound_app_resource = descope.OutboundApp("outboundAppResource",
        project_id="string",
        default_scopes=["string"],
        logo="string",
        authorization_url_params={
            "string": "string",
        },
        callback_domain="string",
        client_id="string",
        client_secret="string",
        default_redirect_url="string",
        access_type="string",
        authorization_url="string",
        description="string",
        discovery_url="string",
        name="string",
        pkce=False,
        app_type="string",
        prompts=["string"],
        revocation_url="string",
        token_url="string",
        token_url_params={
            "string": "string",
        })
    
    const outboundAppResource = new descope.OutboundApp("outboundAppResource", {
        projectId: "string",
        defaultScopes: ["string"],
        logo: "string",
        authorizationUrlParams: {
            string: "string",
        },
        callbackDomain: "string",
        clientId: "string",
        clientSecret: "string",
        defaultRedirectUrl: "string",
        accessType: "string",
        authorizationUrl: "string",
        description: "string",
        discoveryUrl: "string",
        name: "string",
        pkce: false,
        appType: "string",
        prompts: ["string"],
        revocationUrl: "string",
        tokenUrl: "string",
        tokenUrlParams: {
            string: "string",
        },
    });
    
    type: descope:OutboundApp
    properties:
        accessType: string
        appType: string
        authorizationUrl: string
        authorizationUrlParams:
            string: string
        callbackDomain: string
        clientId: string
        clientSecret: string
        defaultRedirectUrl: string
        defaultScopes:
            - string
        description: string
        discoveryUrl: string
        logo: string
        name: string
        pkce: false
        projectId: string
        prompts:
            - string
        revocationUrl: string
        tokenUrl: string
        tokenUrlParams:
            string: string
    

    OutboundApp 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 OutboundApp resource accepts the following input properties:

    ProjectId string
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    AccessType string
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    AppType string
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    AuthorizationUrl string
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    AuthorizationUrlParams Dictionary<string, string>
    Additional query parameters to append to the authorization request, for providers that require them.
    CallbackDomain string
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    ClientId string
    The OAuth client ID issued by the third party provider.
    ClientSecret string
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    DefaultRedirectUrl string
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    DefaultScopes List<string>
    The scopes requested from the provider when no scopes are given for a specific connection.
    Description string
    A description for the outbound application.
    DiscoveryUrl string
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    Logo string
    A URL for an image to display as the outbound application's logo.
    Name string
    A name for the outbound application.
    Pkce bool
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    Prompts List<string>
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    RevocationUrl string
    The provider's token revocation endpoint.
    TokenUrl string
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    TokenUrlParams Dictionary<string, string>
    Additional query parameters to append to the token request, for providers that require them.
    ProjectId string
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    AccessType string
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    AppType string
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    AuthorizationUrl string
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    AuthorizationUrlParams map[string]string
    Additional query parameters to append to the authorization request, for providers that require them.
    CallbackDomain string
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    ClientId string
    The OAuth client ID issued by the third party provider.
    ClientSecret string
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    DefaultRedirectUrl string
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    DefaultScopes []string
    The scopes requested from the provider when no scopes are given for a specific connection.
    Description string
    A description for the outbound application.
    DiscoveryUrl string
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    Logo string
    A URL for an image to display as the outbound application's logo.
    Name string
    A name for the outbound application.
    Pkce bool
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    Prompts []string
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    RevocationUrl string
    The provider's token revocation endpoint.
    TokenUrl string
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    TokenUrlParams map[string]string
    Additional query parameters to append to the token request, for providers that require them.
    project_id string
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    access_type string
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    app_type string
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorization_url string
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorization_url_params map(string)
    Additional query parameters to append to the authorization request, for providers that require them.
    callback_domain string
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    client_id string
    The OAuth client ID issued by the third party provider.
    client_secret string
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    default_redirect_url string
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    default_scopes list(string)
    The scopes requested from the provider when no scopes are given for a specific connection.
    description string
    A description for the outbound application.
    discovery_url string
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo string
    A URL for an image to display as the outbound application's logo.
    name string
    A name for the outbound application.
    pkce bool
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    prompts list(string)
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocation_url string
    The provider's token revocation endpoint.
    token_url string
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    token_url_params map(string)
    Additional query parameters to append to the token request, for providers that require them.
    projectId String
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    accessType String
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    appType String
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorizationUrl String
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorizationUrlParams Map<String,String>
    Additional query parameters to append to the authorization request, for providers that require them.
    callbackDomain String
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    clientId String
    The OAuth client ID issued by the third party provider.
    clientSecret String
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    defaultRedirectUrl String
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    defaultScopes List<String>
    The scopes requested from the provider when no scopes are given for a specific connection.
    description String
    A description for the outbound application.
    discoveryUrl String
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo String
    A URL for an image to display as the outbound application's logo.
    name String
    A name for the outbound application.
    pkce Boolean
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    prompts List<String>
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocationUrl String
    The provider's token revocation endpoint.
    tokenUrl String
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    tokenUrlParams Map<String,String>
    Additional query parameters to append to the token request, for providers that require them.
    projectId string
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    accessType string
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    appType string
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorizationUrl string
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorizationUrlParams {[key: string]: string}
    Additional query parameters to append to the authorization request, for providers that require them.
    callbackDomain string
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    clientId string
    The OAuth client ID issued by the third party provider.
    clientSecret string
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    defaultRedirectUrl string
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    defaultScopes string[]
    The scopes requested from the provider when no scopes are given for a specific connection.
    description string
    A description for the outbound application.
    discoveryUrl string
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo string
    A URL for an image to display as the outbound application's logo.
    name string
    A name for the outbound application.
    pkce boolean
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    prompts string[]
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocationUrl string
    The provider's token revocation endpoint.
    tokenUrl string
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    tokenUrlParams {[key: string]: string}
    Additional query parameters to append to the token request, for providers that require them.
    project_id str
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    access_type str
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    app_type str
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorization_url str
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorization_url_params Mapping[str, str]
    Additional query parameters to append to the authorization request, for providers that require them.
    callback_domain str
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    client_id str
    The OAuth client ID issued by the third party provider.
    client_secret str
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    default_redirect_url str
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    default_scopes Sequence[str]
    The scopes requested from the provider when no scopes are given for a specific connection.
    description str
    A description for the outbound application.
    discovery_url str
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo str
    A URL for an image to display as the outbound application's logo.
    name str
    A name for the outbound application.
    pkce bool
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    prompts Sequence[str]
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocation_url str
    The provider's token revocation endpoint.
    token_url str
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    token_url_params Mapping[str, str]
    Additional query parameters to append to the token request, for providers that require them.
    projectId String
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    accessType String
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    appType String
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorizationUrl String
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorizationUrlParams Map<String>
    Additional query parameters to append to the authorization request, for providers that require them.
    callbackDomain String
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    clientId String
    The OAuth client ID issued by the third party provider.
    clientSecret String
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    defaultRedirectUrl String
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    defaultScopes List<String>
    The scopes requested from the provider when no scopes are given for a specific connection.
    description String
    A description for the outbound application.
    discoveryUrl String
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo String
    A URL for an image to display as the outbound application's logo.
    name String
    A name for the outbound application.
    pkce Boolean
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    prompts List<String>
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocationUrl String
    The provider's token revocation endpoint.
    tokenUrl String
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    tokenUrlParams Map<String>
    Additional query parameters to append to the token request, for providers that require them.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OutboundApp 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 OutboundApp Resource

    Get an existing OutboundApp 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?: OutboundAppState, opts?: CustomResourceOptions): OutboundApp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_type: Optional[str] = None,
            app_type: Optional[str] = None,
            authorization_url: Optional[str] = None,
            authorization_url_params: Optional[Mapping[str, str]] = None,
            callback_domain: Optional[str] = None,
            client_id: Optional[str] = None,
            client_secret: Optional[str] = None,
            default_redirect_url: Optional[str] = None,
            default_scopes: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            discovery_url: Optional[str] = None,
            logo: Optional[str] = None,
            name: Optional[str] = None,
            pkce: Optional[bool] = None,
            project_id: Optional[str] = None,
            prompts: Optional[Sequence[str]] = None,
            revocation_url: Optional[str] = None,
            token_url: Optional[str] = None,
            token_url_params: Optional[Mapping[str, str]] = None) -> OutboundApp
    func GetOutboundApp(ctx *Context, name string, id IDInput, state *OutboundAppState, opts ...ResourceOption) (*OutboundApp, error)
    public static OutboundApp Get(string name, Input<string> id, OutboundAppState? state, CustomResourceOptions? opts = null)
    public static OutboundApp get(String name, Output<String> id, OutboundAppState state, CustomResourceOptions options)
    resources:  existingOutboundApp:    type: descope:OutboundApp    get:      id: ${id}
    import {
      to = descope_outbound_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 OutboundAppState
    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 OutboundAppState
    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 OutboundAppState
    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 OutboundAppState
    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.
    The following state arguments are supported:
    AccessType string
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    AppType string
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    AuthorizationUrl string
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    AuthorizationUrlParams Dictionary<string, string>
    Additional query parameters to append to the authorization request, for providers that require them.
    CallbackDomain string
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    ClientId string
    The OAuth client ID issued by the third party provider.
    ClientSecret string
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    DefaultRedirectUrl string
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    DefaultScopes List<string>
    The scopes requested from the provider when no scopes are given for a specific connection.
    Description string
    A description for the outbound application.
    DiscoveryUrl string
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    Logo string
    A URL for an image to display as the outbound application's logo.
    Name string
    A name for the outbound application.
    Pkce bool
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    ProjectId string
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    Prompts List<string>
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    RevocationUrl string
    The provider's token revocation endpoint.
    TokenUrl string
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    TokenUrlParams Dictionary<string, string>
    Additional query parameters to append to the token request, for providers that require them.
    AccessType string
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    AppType string
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    AuthorizationUrl string
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    AuthorizationUrlParams map[string]string
    Additional query parameters to append to the authorization request, for providers that require them.
    CallbackDomain string
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    ClientId string
    The OAuth client ID issued by the third party provider.
    ClientSecret string
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    DefaultRedirectUrl string
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    DefaultScopes []string
    The scopes requested from the provider when no scopes are given for a specific connection.
    Description string
    A description for the outbound application.
    DiscoveryUrl string
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    Logo string
    A URL for an image to display as the outbound application's logo.
    Name string
    A name for the outbound application.
    Pkce bool
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    ProjectId string
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    Prompts []string
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    RevocationUrl string
    The provider's token revocation endpoint.
    TokenUrl string
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    TokenUrlParams map[string]string
    Additional query parameters to append to the token request, for providers that require them.
    access_type string
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    app_type string
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorization_url string
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorization_url_params map(string)
    Additional query parameters to append to the authorization request, for providers that require them.
    callback_domain string
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    client_id string
    The OAuth client ID issued by the third party provider.
    client_secret string
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    default_redirect_url string
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    default_scopes list(string)
    The scopes requested from the provider when no scopes are given for a specific connection.
    description string
    A description for the outbound application.
    discovery_url string
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo string
    A URL for an image to display as the outbound application's logo.
    name string
    A name for the outbound application.
    pkce bool
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    project_id string
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    prompts list(string)
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocation_url string
    The provider's token revocation endpoint.
    token_url string
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    token_url_params map(string)
    Additional query parameters to append to the token request, for providers that require them.
    accessType String
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    appType String
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorizationUrl String
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorizationUrlParams Map<String,String>
    Additional query parameters to append to the authorization request, for providers that require them.
    callbackDomain String
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    clientId String
    The OAuth client ID issued by the third party provider.
    clientSecret String
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    defaultRedirectUrl String
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    defaultScopes List<String>
    The scopes requested from the provider when no scopes are given for a specific connection.
    description String
    A description for the outbound application.
    discoveryUrl String
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo String
    A URL for an image to display as the outbound application's logo.
    name String
    A name for the outbound application.
    pkce Boolean
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    projectId String
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    prompts List<String>
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocationUrl String
    The provider's token revocation endpoint.
    tokenUrl String
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    tokenUrlParams Map<String,String>
    Additional query parameters to append to the token request, for providers that require them.
    accessType string
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    appType string
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorizationUrl string
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorizationUrlParams {[key: string]: string}
    Additional query parameters to append to the authorization request, for providers that require them.
    callbackDomain string
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    clientId string
    The OAuth client ID issued by the third party provider.
    clientSecret string
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    defaultRedirectUrl string
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    defaultScopes string[]
    The scopes requested from the provider when no scopes are given for a specific connection.
    description string
    A description for the outbound application.
    discoveryUrl string
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo string
    A URL for an image to display as the outbound application's logo.
    name string
    A name for the outbound application.
    pkce boolean
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    projectId string
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    prompts string[]
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocationUrl string
    The provider's token revocation endpoint.
    tokenUrl string
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    tokenUrlParams {[key: string]: string}
    Additional query parameters to append to the token request, for providers that require them.
    access_type str
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    app_type str
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorization_url str
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorization_url_params Mapping[str, str]
    Additional query parameters to append to the authorization request, for providers that require them.
    callback_domain str
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    client_id str
    The OAuth client ID issued by the third party provider.
    client_secret str
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    default_redirect_url str
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    default_scopes Sequence[str]
    The scopes requested from the provider when no scopes are given for a specific connection.
    description str
    A description for the outbound application.
    discovery_url str
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo str
    A URL for an image to display as the outbound application's logo.
    name str
    A name for the outbound application.
    pkce bool
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    project_id str
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    prompts Sequence[str]
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocation_url str
    The provider's token revocation endpoint.
    token_url str
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    token_url_params Mapping[str, str]
    Additional query parameters to append to the token request, for providers that require them.
    accessType String
    Whether the provider should issue a refresh token alongside the access token. Use offline to request one, so that Descope can keep the connection alive without the user present, or online for an access token only.
    appType String
    The kind of credential this application holds. Use oauth for an application that runs the OAuth flow, so that Descope obtains and refreshes tokens on the user's behalf, or apikey for an application whose tokens are uploaded directly and never refreshed.
    authorizationUrl String
    The provider's authorization endpoint, which users are redirected to in order to grant consent.
    authorizationUrlParams Map<String>
    Additional query parameters to append to the authorization request, for providers that require them.
    callbackDomain String
    The domain that the provider redirects back to after consent. Leave this empty to use the project's configured domain.
    clientId String
    The OAuth client ID issued by the third party provider.
    clientSecret String
    The OAuth client secret issued by the third party provider. The Descope API never returns this value, so it cannot be read back and is not verified against the server. Omitting the field leaves any previously stored secret in place, while setting it to a new value replaces it. An empty string is not accepted.
    defaultRedirectUrl String
    The URL that users are returned to once they have finished granting or denying consent at the provider. This can be overridden per connection.
    defaultScopes List<String>
    The scopes requested from the provider when no scopes are given for a specific connection.
    description String
    A description for the outbound application.
    discoveryUrl String
    The provider's OpenID Connect discovery endpoint, used to look up its other endpoints.
    logo String
    A URL for an image to display as the outbound application's logo.
    name String
    A name for the outbound application.
    pkce Boolean
    Whether to use PKCE when exchanging the authorization code, which is required by some providers and recommended by all of them.
    projectId String
    The ID of the Descope project this outbound application belongs to. Changing this value will require the resource to be deleted and recreated.
    prompts List<String>
    How the provider should behave when the user is already signed in. Common values are none, login, consent and selectAccount.
    revocationUrl String
    The provider's token revocation endpoint.
    tokenUrl String
    The provider's token endpoint, used to exchange an authorization code and to refresh tokens.
    tokenUrlParams Map<String>
    Additional query parameters to append to the token request, for providers that require them.

    Package Details

    Repository
    descope descope/pulumi-descope
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the descope Terraform Provider.
    descope logo Descope
    Viewing docs for Descope v1.0.1
    published on Sunday, Oct 11, 2026 by Descope

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial