1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. WsfedApp
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 single WS-Federation federated application where Descope acts as the identity provider.

    Create WsfedApp Resource

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

    Constructor syntax

    new WsfedApp(name: string, args: WsfedAppArgs, opts?: CustomResourceOptions);
    @overload
    def WsfedApp(resource_name: str,
                 args: WsfedAppArgs,
                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def WsfedApp(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 project_id: Optional[str] = None,
                 logo: Optional[str] = None,
                 deletion_protection: Optional[bool] = None,
                 disabled: Optional[bool] = None,
                 error_redirect_url: Optional[str] = None,
                 force_authentication: Optional[bool] = None,
                 groups_mappings: Optional[Sequence[WsfedAppGroupsMappingArgs]] = None,
                 description: Optional[str] = None,
                 logout_redirect_url: Optional[str] = None,
                 login_page_url: Optional[str] = None,
                 name: Optional[str] = None,
                 attribute_mappings: Optional[Sequence[WsfedAppAttributeMappingArgs]] = None,
                 realm: Optional[str] = None,
                 reply_allowed_callback_urls: Optional[Sequence[str]] = None,
                 reply_url: Optional[str] = None,
                 wsfed_app_id: Optional[str] = None)
    func NewWsfedApp(ctx *Context, name string, args WsfedAppArgs, opts ...ResourceOption) (*WsfedApp, error)
    public WsfedApp(string name, WsfedAppArgs args, CustomResourceOptions? opts = null)
    public WsfedApp(String name, WsfedAppArgs args)
    public WsfedApp(String name, WsfedAppArgs args, CustomResourceOptions options)
    
    type: descope:WsfedApp
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_wsfed_app" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args WsfedAppArgs
    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 WsfedAppArgs
    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 WsfedAppArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WsfedAppArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WsfedAppArgs
    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 wsfedAppResource = new Descope.WsfedApp("wsfedAppResource", new()
    {
        ProjectId = "string",
        Logo = "string",
        DeletionProtection = false,
        Disabled = false,
        ErrorRedirectUrl = "string",
        ForceAuthentication = false,
        GroupsMappings = new[]
        {
            new Descope.Inputs.WsfedAppGroupsMappingArgs
            {
                FilterType = "string",
                Name = "string",
                Type = "string",
                Value = "string",
                Roles = new[]
                {
                    new Descope.Inputs.WsfedAppGroupsMappingRoleArgs
                    {
                        Id = "string",
                        Name = "string",
                    },
                },
            },
        },
        Description = "string",
        LogoutRedirectUrl = "string",
        LoginPageUrl = "string",
        Name = "string",
        AttributeMappings = new[]
        {
            new Descope.Inputs.WsfedAppAttributeMappingArgs
            {
                Name = "string",
                Value = "string",
            },
        },
        Realm = "string",
        ReplyAllowedCallbackUrls = new[]
        {
            "string",
        },
        ReplyUrl = "string",
        WsfedAppId = "string",
    });
    
    example, err := descope.NewWsfedApp(ctx, "wsfedAppResource", &descope.WsfedAppArgs{
    	ProjectId:           pulumi.String("string"),
    	Logo:                pulumi.String("string"),
    	DeletionProtection:  pulumi.Bool(false),
    	Disabled:            pulumi.Bool(false),
    	ErrorRedirectUrl:    pulumi.String("string"),
    	ForceAuthentication: pulumi.Bool(false),
    	GroupsMappings: descope.WsfedAppGroupsMappingArray{
    		&descope.WsfedAppGroupsMappingArgs{
    			FilterType: pulumi.String("string"),
    			Name:       pulumi.String("string"),
    			Type:       pulumi.String("string"),
    			Value:      pulumi.String("string"),
    			Roles: descope.WsfedAppGroupsMappingRoleArray{
    				&descope.WsfedAppGroupsMappingRoleArgs{
    					Id:   pulumi.String("string"),
    					Name: pulumi.String("string"),
    				},
    			},
    		},
    	},
    	Description:       pulumi.String("string"),
    	LogoutRedirectUrl: pulumi.String("string"),
    	LoginPageUrl:      pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	AttributeMappings: descope.WsfedAppAttributeMappingArray{
    		&descope.WsfedAppAttributeMappingArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	Realm: pulumi.String("string"),
    	ReplyAllowedCallbackUrls: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ReplyUrl:   pulumi.String("string"),
    	WsfedAppId: pulumi.String("string"),
    })
    
    resource "descope_wsfed_app" "wsfedAppResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id           = "string"
      logo                 = "string"
      deletion_protection  = false
      disabled             = false
      error_redirect_url   = "string"
      force_authentication = false
      groups_mappings {
        filter_type = "string"
        name        = "string"
        type        = "string"
        value       = "string"
        roles {
          id   = "string"
          name = "string"
        }
      }
      description         = "string"
      logout_redirect_url = "string"
      login_page_url      = "string"
      name                = "string"
      attribute_mappings {
        name  = "string"
        value = "string"
      }
      realm                       = "string"
      reply_allowed_callback_urls = ["string"]
      reply_url                   = "string"
      wsfed_app_id                = "string"
    }
    
    var wsfedAppResource = new WsfedApp("wsfedAppResource", WsfedAppArgs.builder()
        .projectId("string")
        .logo("string")
        .deletionProtection(false)
        .disabled(false)
        .errorRedirectUrl("string")
        .forceAuthentication(false)
        .groupsMappings(WsfedAppGroupsMappingArgs.builder()
            .filterType("string")
            .name("string")
            .type("string")
            .value("string")
            .roles(WsfedAppGroupsMappingRoleArgs.builder()
                .id("string")
                .name("string")
                .build())
            .build())
        .description("string")
        .logoutRedirectUrl("string")
        .loginPageUrl("string")
        .name("string")
        .attributeMappings(WsfedAppAttributeMappingArgs.builder()
            .name("string")
            .value("string")
            .build())
        .realm("string")
        .replyAllowedCallbackUrls("string")
        .replyUrl("string")
        .wsfedAppId("string")
        .build());
    
    wsfed_app_resource = descope.WsfedApp("wsfedAppResource",
        project_id="string",
        logo="string",
        deletion_protection=False,
        disabled=False,
        error_redirect_url="string",
        force_authentication=False,
        groups_mappings=[{
            "filter_type": "string",
            "name": "string",
            "type": "string",
            "value": "string",
            "roles": [{
                "id": "string",
                "name": "string",
            }],
        }],
        description="string",
        logout_redirect_url="string",
        login_page_url="string",
        name="string",
        attribute_mappings=[{
            "name": "string",
            "value": "string",
        }],
        realm="string",
        reply_allowed_callback_urls=["string"],
        reply_url="string",
        wsfed_app_id="string")
    
    const wsfedAppResource = new descope.WsfedApp("wsfedAppResource", {
        projectId: "string",
        logo: "string",
        deletionProtection: false,
        disabled: false,
        errorRedirectUrl: "string",
        forceAuthentication: false,
        groupsMappings: [{
            filterType: "string",
            name: "string",
            type: "string",
            value: "string",
            roles: [{
                id: "string",
                name: "string",
            }],
        }],
        description: "string",
        logoutRedirectUrl: "string",
        loginPageUrl: "string",
        name: "string",
        attributeMappings: [{
            name: "string",
            value: "string",
        }],
        realm: "string",
        replyAllowedCallbackUrls: ["string"],
        replyUrl: "string",
        wsfedAppId: "string",
    });
    
    type: descope:WsfedApp
    properties:
        attributeMappings:
            - name: string
              value: string
        deletionProtection: false
        description: string
        disabled: false
        errorRedirectUrl: string
        forceAuthentication: false
        groupsMappings:
            - filterType: string
              name: string
              roles:
                - id: string
                  name: string
              type: string
              value: string
        loginPageUrl: string
        logo: string
        logoutRedirectUrl: string
        name: string
        projectId: string
        realm: string
        replyAllowedCallbackUrls:
            - string
        replyUrl: string
        wsfedAppId: string
    

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

    ProjectId string
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    AttributeMappings List<Descope.WsfedAppAttributeMapping>
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    DeletionProtection bool
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    Description string
    A description for the WS-Federation application.
    Disabled bool
    Whether the application should be enabled or disabled.
    ErrorRedirectUrl string
    The URL to redirect to when an error occurs.
    ForceAuthentication 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.
    GroupsMappings List<Descope.WsfedAppGroupsMapping>
    A list of group mappings from Descope roles to WS-Fed groups.
    LoginPageUrl string
    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 WS-Federation application. Should be a hosted image URL.
    LogoutRedirectUrl string
    The URL to redirect to after logout.
    Name string
    A name for the WS-Federation application.
    Realm string
    The WS-Fed realm identifier for the application.
    ReplyAllowedCallbackUrls List<string>
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    ReplyUrl string
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    WsfedAppId string
    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.
    ProjectId string
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    AttributeMappings []WsfedAppAttributeMappingArgs
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    DeletionProtection bool
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    Description string
    A description for the WS-Federation application.
    Disabled bool
    Whether the application should be enabled or disabled.
    ErrorRedirectUrl string
    The URL to redirect to when an error occurs.
    ForceAuthentication 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.
    GroupsMappings []WsfedAppGroupsMappingArgs
    A list of group mappings from Descope roles to WS-Fed groups.
    LoginPageUrl string
    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 WS-Federation application. Should be a hosted image URL.
    LogoutRedirectUrl string
    The URL to redirect to after logout.
    Name string
    A name for the WS-Federation application.
    Realm string
    The WS-Fed realm identifier for the application.
    ReplyAllowedCallbackUrls []string
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    ReplyUrl string
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    WsfedAppId string
    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.
    attribute_mappings list(object)
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    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, 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 false and apply the change first.
    description string
    A description for the WS-Federation application.
    disabled bool
    Whether the application should be enabled or disabled.
    error_redirect_url string
    The URL to redirect to when an error occurs.
    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.
    groups_mappings list(object)
    A list of group mappings from Descope roles to WS-Fed groups.
    login_page_url string
    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 WS-Federation application. Should be a hosted image URL.
    logout_redirect_url string
    The URL to redirect to after logout.
    name string
    A name for the WS-Federation application.
    realm string
    The WS-Fed realm identifier for the application.
    reply_allowed_callback_urls list(string)
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    reply_url string
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfed_app_id string
    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.
    projectId String
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    attributeMappings List<WsfedAppAttributeMapping>
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    deletionProtection Boolean
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    description String
    A description for the WS-Federation application.
    disabled Boolean
    Whether the application should be enabled or disabled.
    errorRedirectUrl String
    The URL to redirect to when an error occurs.
    forceAuthentication 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.
    groupsMappings List<WsfedAppGroupsMapping>
    A list of group mappings from Descope roles to WS-Fed groups.
    loginPageUrl String
    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 WS-Federation application. Should be a hosted image URL.
    logoutRedirectUrl String
    The URL to redirect to after logout.
    name String
    A name for the WS-Federation application.
    realm String
    The WS-Fed realm identifier for the application.
    replyAllowedCallbackUrls List<String>
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    replyUrl String
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfedAppId String
    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.
    projectId string
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    attributeMappings WsfedAppAttributeMapping[]
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    deletionProtection boolean
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    description string
    A description for the WS-Federation application.
    disabled boolean
    Whether the application should be enabled or disabled.
    errorRedirectUrl string
    The URL to redirect to when an error occurs.
    forceAuthentication 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.
    groupsMappings WsfedAppGroupsMapping[]
    A list of group mappings from Descope roles to WS-Fed groups.
    loginPageUrl string
    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 WS-Federation application. Should be a hosted image URL.
    logoutRedirectUrl string
    The URL to redirect to after logout.
    name string
    A name for the WS-Federation application.
    realm string
    The WS-Fed realm identifier for the application.
    replyAllowedCallbackUrls string[]
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    replyUrl string
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfedAppId string
    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.
    attribute_mappings Sequence[WsfedAppAttributeMappingArgs]
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    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, 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 false and apply the change first.
    description str
    A description for the WS-Federation application.
    disabled bool
    Whether the application should be enabled or disabled.
    error_redirect_url str
    The URL to redirect to when an error occurs.
    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.
    groups_mappings Sequence[WsfedAppGroupsMappingArgs]
    A list of group mappings from Descope roles to WS-Fed groups.
    login_page_url str
    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 WS-Federation application. Should be a hosted image URL.
    logout_redirect_url str
    The URL to redirect to after logout.
    name str
    A name for the WS-Federation application.
    realm str
    The WS-Fed realm identifier for the application.
    reply_allowed_callback_urls Sequence[str]
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    reply_url str
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfed_app_id str
    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.
    projectId String
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    attributeMappings List<Property Map>
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    deletionProtection Boolean
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    description String
    A description for the WS-Federation application.
    disabled Boolean
    Whether the application should be enabled or disabled.
    errorRedirectUrl String
    The URL to redirect to when an error occurs.
    forceAuthentication 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.
    groupsMappings List<Property Map>
    A list of group mappings from Descope roles to WS-Fed groups.
    loginPageUrl String
    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 WS-Federation application. Should be a hosted image URL.
    logoutRedirectUrl String
    The URL to redirect to after logout.
    name String
    A name for the WS-Federation application.
    realm String
    The WS-Fed realm identifier for the application.
    replyAllowedCallbackUrls List<String>
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    replyUrl String
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfedAppId String
    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.

    Outputs

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

    Get an existing WsfedApp 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?: WsfedAppState, opts?: CustomResourceOptions): WsfedApp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            attribute_mappings: Optional[Sequence[WsfedAppAttributeMappingArgs]] = None,
            deletion_protection: Optional[bool] = None,
            description: Optional[str] = None,
            disabled: Optional[bool] = None,
            error_redirect_url: Optional[str] = None,
            force_authentication: Optional[bool] = None,
            groups_mappings: Optional[Sequence[WsfedAppGroupsMappingArgs]] = None,
            login_page_url: Optional[str] = None,
            logo: Optional[str] = None,
            logout_redirect_url: Optional[str] = None,
            name: Optional[str] = None,
            project_id: Optional[str] = None,
            realm: Optional[str] = None,
            reply_allowed_callback_urls: Optional[Sequence[str]] = None,
            reply_url: Optional[str] = None,
            wsfed_app_id: Optional[str] = None) -> WsfedApp
    func GetWsfedApp(ctx *Context, name string, id IDInput, state *WsfedAppState, opts ...ResourceOption) (*WsfedApp, error)
    public static WsfedApp Get(string name, Input<string> id, WsfedAppState? state, CustomResourceOptions? opts = null)
    public static WsfedApp get(String name, Output<String> id, WsfedAppState state, CustomResourceOptions options)
    resources:  existingWsfedApp:    type: descope:WsfedApp    get:      id: ${id}
    import {
      to = descope_wsfed_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 WsfedAppState
    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 WsfedAppState
    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 WsfedAppState
    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 WsfedAppState
    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:
    AttributeMappings List<Descope.WsfedAppAttributeMapping>
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    DeletionProtection bool
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    Description string
    A description for the WS-Federation application.
    Disabled bool
    Whether the application should be enabled or disabled.
    ErrorRedirectUrl string
    The URL to redirect to when an error occurs.
    ForceAuthentication 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.
    GroupsMappings List<Descope.WsfedAppGroupsMapping>
    A list of group mappings from Descope roles to WS-Fed groups.
    LoginPageUrl string
    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 WS-Federation application. Should be a hosted image URL.
    LogoutRedirectUrl string
    The URL to redirect to after logout.
    Name string
    A name for the WS-Federation application.
    ProjectId string
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    Realm string
    The WS-Fed realm identifier for the application.
    ReplyAllowedCallbackUrls List<string>
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    ReplyUrl string
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    WsfedAppId string
    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.
    AttributeMappings []WsfedAppAttributeMappingArgs
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    DeletionProtection bool
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    Description string
    A description for the WS-Federation application.
    Disabled bool
    Whether the application should be enabled or disabled.
    ErrorRedirectUrl string
    The URL to redirect to when an error occurs.
    ForceAuthentication 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.
    GroupsMappings []WsfedAppGroupsMappingArgs
    A list of group mappings from Descope roles to WS-Fed groups.
    LoginPageUrl string
    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 WS-Federation application. Should be a hosted image URL.
    LogoutRedirectUrl string
    The URL to redirect to after logout.
    Name string
    A name for the WS-Federation application.
    ProjectId string
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    Realm string
    The WS-Fed realm identifier for the application.
    ReplyAllowedCallbackUrls []string
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    ReplyUrl string
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    WsfedAppId string
    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.
    attribute_mappings list(object)
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    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, 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 false and apply the change first.
    description string
    A description for the WS-Federation application.
    disabled bool
    Whether the application should be enabled or disabled.
    error_redirect_url string
    The URL to redirect to when an error occurs.
    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.
    groups_mappings list(object)
    A list of group mappings from Descope roles to WS-Fed groups.
    login_page_url string
    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 WS-Federation application. Should be a hosted image URL.
    logout_redirect_url string
    The URL to redirect to after logout.
    name string
    A name for the WS-Federation application.
    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.
    realm string
    The WS-Fed realm identifier for the application.
    reply_allowed_callback_urls list(string)
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    reply_url string
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfed_app_id string
    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.
    attributeMappings List<WsfedAppAttributeMapping>
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    deletionProtection Boolean
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    description String
    A description for the WS-Federation application.
    disabled Boolean
    Whether the application should be enabled or disabled.
    errorRedirectUrl String
    The URL to redirect to when an error occurs.
    forceAuthentication 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.
    groupsMappings List<WsfedAppGroupsMapping>
    A list of group mappings from Descope roles to WS-Fed groups.
    loginPageUrl String
    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 WS-Federation application. Should be a hosted image URL.
    logoutRedirectUrl String
    The URL to redirect to after logout.
    name String
    A name for the WS-Federation application.
    projectId String
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    realm String
    The WS-Fed realm identifier for the application.
    replyAllowedCallbackUrls List<String>
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    replyUrl String
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfedAppId String
    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.
    attributeMappings WsfedAppAttributeMapping[]
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    deletionProtection boolean
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    description string
    A description for the WS-Federation application.
    disabled boolean
    Whether the application should be enabled or disabled.
    errorRedirectUrl string
    The URL to redirect to when an error occurs.
    forceAuthentication 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.
    groupsMappings WsfedAppGroupsMapping[]
    A list of group mappings from Descope roles to WS-Fed groups.
    loginPageUrl string
    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 WS-Federation application. Should be a hosted image URL.
    logoutRedirectUrl string
    The URL to redirect to after logout.
    name string
    A name for the WS-Federation application.
    projectId string
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    realm string
    The WS-Fed realm identifier for the application.
    replyAllowedCallbackUrls string[]
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    replyUrl string
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfedAppId string
    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.
    attribute_mappings Sequence[WsfedAppAttributeMappingArgs]
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    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, 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 false and apply the change first.
    description str
    A description for the WS-Federation application.
    disabled bool
    Whether the application should be enabled or disabled.
    error_redirect_url str
    The URL to redirect to when an error occurs.
    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.
    groups_mappings Sequence[WsfedAppGroupsMappingArgs]
    A list of group mappings from Descope roles to WS-Fed groups.
    login_page_url str
    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 WS-Federation application. Should be a hosted image URL.
    logout_redirect_url str
    The URL to redirect to after logout.
    name str
    A name for the WS-Federation application.
    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.
    realm str
    The WS-Fed realm identifier for the application.
    reply_allowed_callback_urls Sequence[str]
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    reply_url str
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfed_app_id str
    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.
    attributeMappings List<Property Map>
    A list of attribute mappings from Descope user attributes to WS-Fed assertion attributes.
    deletionProtection Boolean
    Protects the application from being accidentally destroyed or replaced. Destroying or replacing a federated application breaks the service provider's configured integration, 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 false and apply the change first.
    description String
    A description for the WS-Federation application.
    disabled Boolean
    Whether the application should be enabled or disabled.
    errorRedirectUrl String
    The URL to redirect to when an error occurs.
    forceAuthentication 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.
    groupsMappings List<Property Map>
    A list of group mappings from Descope roles to WS-Fed groups.
    loginPageUrl String
    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 WS-Federation application. Should be a hosted image URL.
    logoutRedirectUrl String
    The URL to redirect to after logout.
    name String
    A name for the WS-Federation application.
    projectId String
    The ID of the project that this application belongs to. Changing this value will require the resource to be deleted and recreated.
    realm String
    The WS-Fed realm identifier for the application.
    replyAllowedCallbackUrls List<String>
    Additional allowed wreply callback URLs beyond replyUrl. Each entry may include the * wildcard. When the RP supplies a wreply parameter, it must match either the default replyUrl or one of these patterns.
    replyUrl String
    The default reply URL where WS-Fed responses are sent. Used for IdP-initiated flows and when no wreply is supplied by the RP.
    wsfedAppId String
    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.

    Supporting Types

    WsfedAppAttributeMapping, WsfedAppAttributeMappingArgs

    Name string
    The name of the attribute.
    Value string
    The value of the attribute.
    Name string
    The name of the attribute.
    Value string
    The value of the attribute.
    name string
    The name of the attribute.
    value string
    The value of the attribute.
    name String
    The name of the attribute.
    value String
    The value of the attribute.
    name string
    The name of the attribute.
    value string
    The value of the attribute.
    name str
    The name of the attribute.
    value str
    The value of the attribute.
    name String
    The name of the attribute.
    value String
    The value of the attribute.

    WsfedAppGroupsMapping, WsfedAppGroupsMappingArgs

    FilterType string
    The filter type for the groups mapping.
    Name string
    The name of the groups mapping.
    Type string
    The type of the groups mapping.
    Value string
    The value of the groups mapping.
    Roles List<Descope.WsfedAppGroupsMappingRole>
    The Descope roles that are included in the groups mapping.
    FilterType string
    The filter type for the groups mapping.
    Name string
    The name of the groups mapping.
    Type string
    The type of the groups mapping.
    Value string
    The value of the groups mapping.
    Roles []WsfedAppGroupsMappingRole
    The Descope roles that are included in the groups mapping.
    filter_type string
    The filter type for the groups mapping.
    name string
    The name of the groups mapping.
    type string
    The type of the groups mapping.
    value string
    The value of the groups mapping.
    roles list(object)
    The Descope roles that are included in the groups mapping.
    filterType String
    The filter type for the groups mapping.
    name String
    The name of the groups mapping.
    type String
    The type of the groups mapping.
    value String
    The value of the groups mapping.
    roles List<WsfedAppGroupsMappingRole>
    The Descope roles that are included in the groups mapping.
    filterType string
    The filter type for the groups mapping.
    name string
    The name of the groups mapping.
    type string
    The type of the groups mapping.
    value string
    The value of the groups mapping.
    roles WsfedAppGroupsMappingRole[]
    The Descope roles that are included in the groups mapping.
    filter_type str
    The filter type for the groups mapping.
    name str
    The name of the groups mapping.
    type str
    The type of the groups mapping.
    value str
    The value of the groups mapping.
    roles Sequence[WsfedAppGroupsMappingRole]
    The Descope roles that are included in the groups mapping.
    filterType String
    The filter type for the groups mapping.
    name String
    The name of the groups mapping.
    type String
    The type of the groups mapping.
    value String
    The value of the groups mapping.
    roles List<Property Map>
    The Descope roles that are included in the groups mapping.

    WsfedAppGroupsMappingRole, WsfedAppGroupsMappingRoleArgs

    Id string
    The ID of the role.
    Name string
    The name of the role.
    Id string
    The ID of the role.
    Name string
    The name of the role.
    id string
    The ID of the role.
    name string
    The name of the role.
    id String
    The ID of the role.
    name String
    The name of the role.
    id string
    The ID of the role.
    name string
    The name of the role.
    id str
    The ID of the role.
    name str
    The name of the role.
    id String
    The ID of the role.
    name String
    The name of the role.

    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