1. Registry
  2. Packages
  3. Descope Provider
  4. API Docs
  5. SsoSettings
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 the project-level SSO authentication settings. This is a singleton resource, and its id is always the project ID.

    Create SsoSettings Resource

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

    Constructor syntax

    new SsoSettings(name: string, args: SsoSettingsArgs, opts?: CustomResourceOptions);
    @overload
    def SsoSettings(resource_name: str,
                    args: SsoSettingsArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def SsoSettings(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    project_id: Optional[str] = None,
                    disabled: Optional[bool] = None,
                    mark_email_as_unverified: Optional[bool] = None,
                    block_if_email_domain_mismatch: Optional[bool] = None,
                    allow_duplicate_domains: Optional[bool] = None,
                    email_connector_id: Optional[str] = None,
                    email_template_id: Optional[str] = None,
                    allow_override_roles: Optional[bool] = None,
                    groups_priority: Optional[bool] = None,
                    mandatory_user_attributes: Optional[Sequence[SsoSettingsMandatoryUserAttributeArgs]] = None,
                    limit_mapping_to_mandatory_attributes: Optional[bool] = None,
                    merge_users: Optional[bool] = None,
                    allow_merge_users_with_multiple_tenants: Optional[bool] = None,
                    redirect_url: Optional[str] = None,
                    require_groups_attribute_name: Optional[bool] = None,
                    require_sso_domains: Optional[bool] = None,
                    sso_suite_settings: Optional[SsoSettingsSsoSuiteSettingsArgs] = None)
    func NewSsoSettings(ctx *Context, name string, args SsoSettingsArgs, opts ...ResourceOption) (*SsoSettings, error)
    public SsoSettings(string name, SsoSettingsArgs args, CustomResourceOptions? opts = null)
    public SsoSettings(String name, SsoSettingsArgs args)
    public SsoSettings(String name, SsoSettingsArgs args, CustomResourceOptions options)
    
    type: descope:SsoSettings
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "descope_sso_settings" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args SsoSettingsArgs
    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 SsoSettingsArgs
    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 SsoSettingsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SsoSettingsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SsoSettingsArgs
    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 ssoSettingsResource = new Descope.SsoSettings("ssoSettingsResource", new()
    {
        ProjectId = "string",
        Disabled = false,
        MarkEmailAsUnverified = false,
        BlockIfEmailDomainMismatch = false,
        AllowDuplicateDomains = false,
        EmailConnectorId = "string",
        EmailTemplateId = "string",
        AllowOverrideRoles = false,
        GroupsPriority = false,
        MandatoryUserAttributes = new[]
        {
            new Descope.Inputs.SsoSettingsMandatoryUserAttributeArgs
            {
                Id = "string",
                Custom = false,
            },
        },
        LimitMappingToMandatoryAttributes = false,
        MergeUsers = false,
        AllowMergeUsersWithMultipleTenants = false,
        RedirectUrl = "string",
        RequireGroupsAttributeName = false,
        RequireSsoDomains = false,
        SsoSuiteSettings = new Descope.Inputs.SsoSettingsSsoSuiteSettingsArgs
        {
            ForceDomainVerification = false,
            HideDomains = false,
            HideFgaMapping = false,
            HideGroupsMapping = false,
            HideJitGuide = false,
            HideOidc = false,
            HideRoleMapping = false,
            HideSaml = false,
            HideScim = false,
            HideSso = false,
            OidcLoginIdAttribute = "string",
            ShowHelpContact = false,
            ShowXaa = false,
            StyleId = "string",
            SupportEmail = "string",
        },
    });
    
    example, err := descope.NewSsoSettings(ctx, "ssoSettingsResource", &descope.SsoSettingsArgs{
    	ProjectId:                  pulumi.String("string"),
    	Disabled:                   pulumi.Bool(false),
    	MarkEmailAsUnverified:      pulumi.Bool(false),
    	BlockIfEmailDomainMismatch: pulumi.Bool(false),
    	AllowDuplicateDomains:      pulumi.Bool(false),
    	EmailConnectorId:           pulumi.String("string"),
    	EmailTemplateId:            pulumi.String("string"),
    	AllowOverrideRoles:         pulumi.Bool(false),
    	GroupsPriority:             pulumi.Bool(false),
    	MandatoryUserAttributes: descope.SsoSettingsMandatoryUserAttributeArray{
    		&descope.SsoSettingsMandatoryUserAttributeArgs{
    			Id:     pulumi.String("string"),
    			Custom: pulumi.Bool(false),
    		},
    	},
    	LimitMappingToMandatoryAttributes:  pulumi.Bool(false),
    	MergeUsers:                         pulumi.Bool(false),
    	AllowMergeUsersWithMultipleTenants: pulumi.Bool(false),
    	RedirectUrl:                        pulumi.String("string"),
    	RequireGroupsAttributeName:         pulumi.Bool(false),
    	RequireSsoDomains:                  pulumi.Bool(false),
    	SsoSuiteSettings: &descope.SsoSettingsSsoSuiteSettingsArgs{
    		ForceDomainVerification: pulumi.Bool(false),
    		HideDomains:             pulumi.Bool(false),
    		HideFgaMapping:          pulumi.Bool(false),
    		HideGroupsMapping:       pulumi.Bool(false),
    		HideJitGuide:            pulumi.Bool(false),
    		HideOidc:                pulumi.Bool(false),
    		HideRoleMapping:         pulumi.Bool(false),
    		HideSaml:                pulumi.Bool(false),
    		HideScim:                pulumi.Bool(false),
    		HideSso:                 pulumi.Bool(false),
    		OidcLoginIdAttribute:    pulumi.String("string"),
    		ShowHelpContact:         pulumi.Bool(false),
    		ShowXaa:                 pulumi.Bool(false),
    		StyleId:                 pulumi.String("string"),
    		SupportEmail:            pulumi.String("string"),
    	},
    })
    
    resource "descope_sso_settings" "ssoSettingsResource" {
      lifecycle {
        create_before_destroy = true
      }
      project_id                     = "string"
      disabled                       = false
      mark_email_as_unverified       = false
      block_if_email_domain_mismatch = false
      allow_duplicate_domains        = false
      email_connector_id             = "string"
      email_template_id              = "string"
      allow_override_roles           = false
      groups_priority                = false
      mandatory_user_attributes {
        id     = "string"
        custom = false
      }
      limit_mapping_to_mandatory_attributes   = false
      merge_users                             = false
      allow_merge_users_with_multiple_tenants = false
      redirect_url                            = "string"
      require_groups_attribute_name           = false
      require_sso_domains                     = false
      sso_suite_settings = {
        force_domain_verification = false
        hide_domains              = false
        hide_fga_mapping          = false
        hide_groups_mapping       = false
        hide_jit_guide            = false
        hide_oidc                 = false
        hide_role_mapping         = false
        hide_saml                 = false
        hide_scim                 = false
        hide_sso                  = false
        oidc_login_id_attribute   = "string"
        show_help_contact         = false
        show_xaa                  = false
        style_id                  = "string"
        support_email             = "string"
      }
    }
    
    var ssoSettingsResource = new SsoSettings("ssoSettingsResource", SsoSettingsArgs.builder()
        .projectId("string")
        .disabled(false)
        .markEmailAsUnverified(false)
        .blockIfEmailDomainMismatch(false)
        .allowDuplicateDomains(false)
        .emailConnectorId("string")
        .emailTemplateId("string")
        .allowOverrideRoles(false)
        .groupsPriority(false)
        .mandatoryUserAttributes(SsoSettingsMandatoryUserAttributeArgs.builder()
            .id("string")
            .custom(false)
            .build())
        .limitMappingToMandatoryAttributes(false)
        .mergeUsers(false)
        .allowMergeUsersWithMultipleTenants(false)
        .redirectUrl("string")
        .requireGroupsAttributeName(false)
        .requireSsoDomains(false)
        .ssoSuiteSettings(SsoSettingsSsoSuiteSettingsArgs.builder()
            .forceDomainVerification(false)
            .hideDomains(false)
            .hideFgaMapping(false)
            .hideGroupsMapping(false)
            .hideJitGuide(false)
            .hideOidc(false)
            .hideRoleMapping(false)
            .hideSaml(false)
            .hideScim(false)
            .hideSso(false)
            .oidcLoginIdAttribute("string")
            .showHelpContact(false)
            .showXaa(false)
            .styleId("string")
            .supportEmail("string")
            .build())
        .build());
    
    sso_settings_resource = descope.SsoSettings("ssoSettingsResource",
        project_id="string",
        disabled=False,
        mark_email_as_unverified=False,
        block_if_email_domain_mismatch=False,
        allow_duplicate_domains=False,
        email_connector_id="string",
        email_template_id="string",
        allow_override_roles=False,
        groups_priority=False,
        mandatory_user_attributes=[{
            "id": "string",
            "custom": False,
        }],
        limit_mapping_to_mandatory_attributes=False,
        merge_users=False,
        allow_merge_users_with_multiple_tenants=False,
        redirect_url="string",
        require_groups_attribute_name=False,
        require_sso_domains=False,
        sso_suite_settings={
            "force_domain_verification": False,
            "hide_domains": False,
            "hide_fga_mapping": False,
            "hide_groups_mapping": False,
            "hide_jit_guide": False,
            "hide_oidc": False,
            "hide_role_mapping": False,
            "hide_saml": False,
            "hide_scim": False,
            "hide_sso": False,
            "oidc_login_id_attribute": "string",
            "show_help_contact": False,
            "show_xaa": False,
            "style_id": "string",
            "support_email": "string",
        })
    
    const ssoSettingsResource = new descope.SsoSettings("ssoSettingsResource", {
        projectId: "string",
        disabled: false,
        markEmailAsUnverified: false,
        blockIfEmailDomainMismatch: false,
        allowDuplicateDomains: false,
        emailConnectorId: "string",
        emailTemplateId: "string",
        allowOverrideRoles: false,
        groupsPriority: false,
        mandatoryUserAttributes: [{
            id: "string",
            custom: false,
        }],
        limitMappingToMandatoryAttributes: false,
        mergeUsers: false,
        allowMergeUsersWithMultipleTenants: false,
        redirectUrl: "string",
        requireGroupsAttributeName: false,
        requireSsoDomains: false,
        ssoSuiteSettings: {
            forceDomainVerification: false,
            hideDomains: false,
            hideFgaMapping: false,
            hideGroupsMapping: false,
            hideJitGuide: false,
            hideOidc: false,
            hideRoleMapping: false,
            hideSaml: false,
            hideScim: false,
            hideSso: false,
            oidcLoginIdAttribute: "string",
            showHelpContact: false,
            showXaa: false,
            styleId: "string",
            supportEmail: "string",
        },
    });
    
    type: descope:SsoSettings
    properties:
        allowDuplicateDomains: false
        allowMergeUsersWithMultipleTenants: false
        allowOverrideRoles: false
        blockIfEmailDomainMismatch: false
        disabled: false
        emailConnectorId: string
        emailTemplateId: string
        groupsPriority: false
        limitMappingToMandatoryAttributes: false
        mandatoryUserAttributes:
            - custom: false
              id: string
        markEmailAsUnverified: false
        mergeUsers: false
        projectId: string
        redirectUrl: string
        requireGroupsAttributeName: false
        requireSsoDomains: false
        ssoSuiteSettings:
            forceDomainVerification: false
            hideDomains: false
            hideFgaMapping: false
            hideGroupsMapping: false
            hideJitGuide: false
            hideOidc: false
            hideRoleMapping: false
            hideSaml: false
            hideScim: false
            hideSso: false
            oidcLoginIdAttribute: string
            showHelpContact: false
            showXaa: false
            styleId: string
            supportEmail: string
    

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

    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    AllowDuplicateDomains bool
    Whether to allow duplicate SSO domains across tenants.
    AllowMergeUsersWithMultipleTenants bool
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    AllowOverrideRoles bool
    Whether to allow overriding user's roles with SSO related roles.
    BlockIfEmailDomainMismatch bool
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    Disabled bool
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    EmailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    GroupsPriority bool
    Whether to enable groups priority.
    LimitMappingToMandatoryAttributes bool
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    MandatoryUserAttributes List<Descope.SsoSettingsMandatoryUserAttribute>
    Define the required Descope attributes that must be populated when receiving SSO information.
    MarkEmailAsUnverified bool
    Whether to mark the user's email as unverified when logging in via SSO.
    MergeUsers bool
    Whether to merge existing user accounts with new ones created through SSO authentication.
    RedirectUrl string
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    RequireGroupsAttributeName bool
    When configuring SSO the groups attribute name must be specified.
    RequireSsoDomains bool
    When configuring SSO an SSO domain must be specified.
    SsoSuiteSettings Descope.SsoSettingsSsoSuiteSettings
    Configuration block for the SSO Suite.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    AllowDuplicateDomains bool
    Whether to allow duplicate SSO domains across tenants.
    AllowMergeUsersWithMultipleTenants bool
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    AllowOverrideRoles bool
    Whether to allow overriding user's roles with SSO related roles.
    BlockIfEmailDomainMismatch bool
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    Disabled bool
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    EmailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    GroupsPriority bool
    Whether to enable groups priority.
    LimitMappingToMandatoryAttributes bool
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    MandatoryUserAttributes []SsoSettingsMandatoryUserAttributeArgs
    Define the required Descope attributes that must be populated when receiving SSO information.
    MarkEmailAsUnverified bool
    Whether to mark the user's email as unverified when logging in via SSO.
    MergeUsers bool
    Whether to merge existing user accounts with new ones created through SSO authentication.
    RedirectUrl string
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    RequireGroupsAttributeName bool
    When configuring SSO the groups attribute name must be specified.
    RequireSsoDomains bool
    When configuring SSO an SSO domain must be specified.
    SsoSuiteSettings SsoSettingsSsoSuiteSettingsArgs
    Configuration block for the SSO Suite.
    project_id string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    allow_duplicate_domains bool
    Whether to allow duplicate SSO domains across tenants.
    allow_merge_users_with_multiple_tenants bool
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allow_override_roles bool
    Whether to allow overriding user's roles with SSO related roles.
    block_if_email_domain_mismatch bool
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled bool
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    email_connector_id string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    email_template_id string
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groups_priority bool
    Whether to enable groups priority.
    limit_mapping_to_mandatory_attributes bool
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatory_user_attributes list(object)
    Define the required Descope attributes that must be populated when receiving SSO information.
    mark_email_as_unverified bool
    Whether to mark the user's email as unverified when logging in via SSO.
    merge_users bool
    Whether to merge existing user accounts with new ones created through SSO authentication.
    redirect_url string
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    require_groups_attribute_name bool
    When configuring SSO the groups attribute name must be specified.
    require_sso_domains bool
    When configuring SSO an SSO domain must be specified.
    sso_suite_settings object
    Configuration block for the SSO Suite.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    allowDuplicateDomains Boolean
    Whether to allow duplicate SSO domains across tenants.
    allowMergeUsersWithMultipleTenants Boolean
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allowOverrideRoles Boolean
    Whether to allow overriding user's roles with SSO related roles.
    blockIfEmailDomainMismatch Boolean
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled Boolean
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    emailConnectorId String
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groupsPriority Boolean
    Whether to enable groups priority.
    limitMappingToMandatoryAttributes Boolean
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatoryUserAttributes List<SsoSettingsMandatoryUserAttribute>
    Define the required Descope attributes that must be populated when receiving SSO information.
    markEmailAsUnverified Boolean
    Whether to mark the user's email as unverified when logging in via SSO.
    mergeUsers Boolean
    Whether to merge existing user accounts with new ones created through SSO authentication.
    redirectUrl String
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    requireGroupsAttributeName Boolean
    When configuring SSO the groups attribute name must be specified.
    requireSsoDomains Boolean
    When configuring SSO an SSO domain must be specified.
    ssoSuiteSettings SsoSettingsSsoSuiteSettings
    Configuration block for the SSO Suite.
    projectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    allowDuplicateDomains boolean
    Whether to allow duplicate SSO domains across tenants.
    allowMergeUsersWithMultipleTenants boolean
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allowOverrideRoles boolean
    Whether to allow overriding user's roles with SSO related roles.
    blockIfEmailDomainMismatch boolean
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled boolean
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    emailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId string
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groupsPriority boolean
    Whether to enable groups priority.
    limitMappingToMandatoryAttributes boolean
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatoryUserAttributes SsoSettingsMandatoryUserAttribute[]
    Define the required Descope attributes that must be populated when receiving SSO information.
    markEmailAsUnverified boolean
    Whether to mark the user's email as unverified when logging in via SSO.
    mergeUsers boolean
    Whether to merge existing user accounts with new ones created through SSO authentication.
    redirectUrl string
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    requireGroupsAttributeName boolean
    When configuring SSO the groups attribute name must be specified.
    requireSsoDomains boolean
    When configuring SSO an SSO domain must be specified.
    ssoSuiteSettings SsoSettingsSsoSuiteSettings
    Configuration block for the SSO Suite.
    project_id str
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    allow_duplicate_domains bool
    Whether to allow duplicate SSO domains across tenants.
    allow_merge_users_with_multiple_tenants bool
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allow_override_roles bool
    Whether to allow overriding user's roles with SSO related roles.
    block_if_email_domain_mismatch bool
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled bool
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    email_connector_id str
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    email_template_id str
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groups_priority bool
    Whether to enable groups priority.
    limit_mapping_to_mandatory_attributes bool
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatory_user_attributes Sequence[SsoSettingsMandatoryUserAttributeArgs]
    Define the required Descope attributes that must be populated when receiving SSO information.
    mark_email_as_unverified bool
    Whether to mark the user's email as unverified when logging in via SSO.
    merge_users bool
    Whether to merge existing user accounts with new ones created through SSO authentication.
    redirect_url str
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    require_groups_attribute_name bool
    When configuring SSO the groups attribute name must be specified.
    require_sso_domains bool
    When configuring SSO an SSO domain must be specified.
    sso_suite_settings SsoSettingsSsoSuiteSettingsArgs
    Configuration block for the SSO Suite.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    allowDuplicateDomains Boolean
    Whether to allow duplicate SSO domains across tenants.
    allowMergeUsersWithMultipleTenants Boolean
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allowOverrideRoles Boolean
    Whether to allow overriding user's roles with SSO related roles.
    blockIfEmailDomainMismatch Boolean
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled Boolean
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    emailConnectorId String
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groupsPriority Boolean
    Whether to enable groups priority.
    limitMappingToMandatoryAttributes Boolean
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatoryUserAttributes List<Property Map>
    Define the required Descope attributes that must be populated when receiving SSO information.
    markEmailAsUnverified Boolean
    Whether to mark the user's email as unverified when logging in via SSO.
    mergeUsers Boolean
    Whether to merge existing user accounts with new ones created through SSO authentication.
    redirectUrl String
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    requireGroupsAttributeName Boolean
    When configuring SSO the groups attribute name must be specified.
    requireSsoDomains Boolean
    When configuring SSO an SSO domain must be specified.
    ssoSuiteSettings Property Map
    Configuration block for the SSO Suite.

    Outputs

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

    Get an existing SsoSettings 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?: SsoSettingsState, opts?: CustomResourceOptions): SsoSettings
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allow_duplicate_domains: Optional[bool] = None,
            allow_merge_users_with_multiple_tenants: Optional[bool] = None,
            allow_override_roles: Optional[bool] = None,
            block_if_email_domain_mismatch: Optional[bool] = None,
            disabled: Optional[bool] = None,
            email_connector_id: Optional[str] = None,
            email_template_id: Optional[str] = None,
            groups_priority: Optional[bool] = None,
            limit_mapping_to_mandatory_attributes: Optional[bool] = None,
            mandatory_user_attributes: Optional[Sequence[SsoSettingsMandatoryUserAttributeArgs]] = None,
            mark_email_as_unverified: Optional[bool] = None,
            merge_users: Optional[bool] = None,
            project_id: Optional[str] = None,
            redirect_url: Optional[str] = None,
            require_groups_attribute_name: Optional[bool] = None,
            require_sso_domains: Optional[bool] = None,
            sso_suite_settings: Optional[SsoSettingsSsoSuiteSettingsArgs] = None) -> SsoSettings
    func GetSsoSettings(ctx *Context, name string, id IDInput, state *SsoSettingsState, opts ...ResourceOption) (*SsoSettings, error)
    public static SsoSettings Get(string name, Input<string> id, SsoSettingsState? state, CustomResourceOptions? opts = null)
    public static SsoSettings get(String name, Output<String> id, SsoSettingsState state, CustomResourceOptions options)
    resources:  existingSsoSettings:    type: descope:SsoSettings    get:      id: ${id}
    import {
      to = descope_sso_settings.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 SsoSettingsState
    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 SsoSettingsState
    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 SsoSettingsState
    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 SsoSettingsState
    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:
    AllowDuplicateDomains bool
    Whether to allow duplicate SSO domains across tenants.
    AllowMergeUsersWithMultipleTenants bool
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    AllowOverrideRoles bool
    Whether to allow overriding user's roles with SSO related roles.
    BlockIfEmailDomainMismatch bool
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    Disabled bool
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    EmailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    GroupsPriority bool
    Whether to enable groups priority.
    LimitMappingToMandatoryAttributes bool
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    MandatoryUserAttributes List<Descope.SsoSettingsMandatoryUserAttribute>
    Define the required Descope attributes that must be populated when receiving SSO information.
    MarkEmailAsUnverified bool
    Whether to mark the user's email as unverified when logging in via SSO.
    MergeUsers bool
    Whether to merge existing user accounts with new ones created through SSO authentication.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    RedirectUrl string
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    RequireGroupsAttributeName bool
    When configuring SSO the groups attribute name must be specified.
    RequireSsoDomains bool
    When configuring SSO an SSO domain must be specified.
    SsoSuiteSettings Descope.SsoSettingsSsoSuiteSettings
    Configuration block for the SSO Suite.
    AllowDuplicateDomains bool
    Whether to allow duplicate SSO domains across tenants.
    AllowMergeUsersWithMultipleTenants bool
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    AllowOverrideRoles bool
    Whether to allow overriding user's roles with SSO related roles.
    BlockIfEmailDomainMismatch bool
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    Disabled bool
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    EmailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    EmailTemplateId string
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    GroupsPriority bool
    Whether to enable groups priority.
    LimitMappingToMandatoryAttributes bool
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    MandatoryUserAttributes []SsoSettingsMandatoryUserAttributeArgs
    Define the required Descope attributes that must be populated when receiving SSO information.
    MarkEmailAsUnverified bool
    Whether to mark the user's email as unverified when logging in via SSO.
    MergeUsers bool
    Whether to merge existing user accounts with new ones created through SSO authentication.
    ProjectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    RedirectUrl string
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    RequireGroupsAttributeName bool
    When configuring SSO the groups attribute name must be specified.
    RequireSsoDomains bool
    When configuring SSO an SSO domain must be specified.
    SsoSuiteSettings SsoSettingsSsoSuiteSettingsArgs
    Configuration block for the SSO Suite.
    allow_duplicate_domains bool
    Whether to allow duplicate SSO domains across tenants.
    allow_merge_users_with_multiple_tenants bool
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allow_override_roles bool
    Whether to allow overriding user's roles with SSO related roles.
    block_if_email_domain_mismatch bool
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled bool
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    email_connector_id string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    email_template_id string
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groups_priority bool
    Whether to enable groups priority.
    limit_mapping_to_mandatory_attributes bool
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatory_user_attributes list(object)
    Define the required Descope attributes that must be populated when receiving SSO information.
    mark_email_as_unverified bool
    Whether to mark the user's email as unverified when logging in via SSO.
    merge_users bool
    Whether to merge existing user accounts with new ones created through SSO authentication.
    project_id string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    redirect_url string
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    require_groups_attribute_name bool
    When configuring SSO the groups attribute name must be specified.
    require_sso_domains bool
    When configuring SSO an SSO domain must be specified.
    sso_suite_settings object
    Configuration block for the SSO Suite.
    allowDuplicateDomains Boolean
    Whether to allow duplicate SSO domains across tenants.
    allowMergeUsersWithMultipleTenants Boolean
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allowOverrideRoles Boolean
    Whether to allow overriding user's roles with SSO related roles.
    blockIfEmailDomainMismatch Boolean
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled Boolean
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    emailConnectorId String
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groupsPriority Boolean
    Whether to enable groups priority.
    limitMappingToMandatoryAttributes Boolean
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatoryUserAttributes List<SsoSettingsMandatoryUserAttribute>
    Define the required Descope attributes that must be populated when receiving SSO information.
    markEmailAsUnverified Boolean
    Whether to mark the user's email as unverified when logging in via SSO.
    mergeUsers Boolean
    Whether to merge existing user accounts with new ones created through SSO authentication.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    redirectUrl String
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    requireGroupsAttributeName Boolean
    When configuring SSO the groups attribute name must be specified.
    requireSsoDomains Boolean
    When configuring SSO an SSO domain must be specified.
    ssoSuiteSettings SsoSettingsSsoSuiteSettings
    Configuration block for the SSO Suite.
    allowDuplicateDomains boolean
    Whether to allow duplicate SSO domains across tenants.
    allowMergeUsersWithMultipleTenants boolean
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allowOverrideRoles boolean
    Whether to allow overriding user's roles with SSO related roles.
    blockIfEmailDomainMismatch boolean
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled boolean
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    emailConnectorId string
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId string
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groupsPriority boolean
    Whether to enable groups priority.
    limitMappingToMandatoryAttributes boolean
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatoryUserAttributes SsoSettingsMandatoryUserAttribute[]
    Define the required Descope attributes that must be populated when receiving SSO information.
    markEmailAsUnverified boolean
    Whether to mark the user's email as unverified when logging in via SSO.
    mergeUsers boolean
    Whether to merge existing user accounts with new ones created through SSO authentication.
    projectId string
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    redirectUrl string
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    requireGroupsAttributeName boolean
    When configuring SSO the groups attribute name must be specified.
    requireSsoDomains boolean
    When configuring SSO an SSO domain must be specified.
    ssoSuiteSettings SsoSettingsSsoSuiteSettings
    Configuration block for the SSO Suite.
    allow_duplicate_domains bool
    Whether to allow duplicate SSO domains across tenants.
    allow_merge_users_with_multiple_tenants bool
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allow_override_roles bool
    Whether to allow overriding user's roles with SSO related roles.
    block_if_email_domain_mismatch bool
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled bool
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    email_connector_id str
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    email_template_id str
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groups_priority bool
    Whether to enable groups priority.
    limit_mapping_to_mandatory_attributes bool
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatory_user_attributes Sequence[SsoSettingsMandatoryUserAttributeArgs]
    Define the required Descope attributes that must be populated when receiving SSO information.
    mark_email_as_unverified bool
    Whether to mark the user's email as unverified when logging in via SSO.
    merge_users bool
    Whether to merge existing user accounts with new ones created through SSO authentication.
    project_id str
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    redirect_url str
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    require_groups_attribute_name bool
    When configuring SSO the groups attribute name must be specified.
    require_sso_domains bool
    When configuring SSO an SSO domain must be specified.
    sso_suite_settings SsoSettingsSsoSuiteSettingsArgs
    Configuration block for the SSO Suite.
    allowDuplicateDomains Boolean
    Whether to allow duplicate SSO domains across tenants.
    allowMergeUsersWithMultipleTenants Boolean
    Whether to allow converting an existing user who is already a member of this tenant into this SSO connection even when the user also belongs to other tenants. Disabled by default because it increases the risk of cross-tenant account takeover.
    allowOverrideRoles Boolean
    Whether to allow overriding user's roles with SSO related roles.
    blockIfEmailDomainMismatch Boolean
    Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
    disabled Boolean
    Setting this to true will disallow using SSO authentication directly via API and SDK calls. Note that this does not affect authentication flows that are configured to use SSO.
    emailConnectorId String
    The ID of an email connector to use for sending emails. An empty value (the default) selects the built-in Descope delivery service.
    emailTemplateId String
    The ID of the email template for SSO configuration invitation emails, taken from a descope.EmailTemplate resource with its method set to sso. An empty value (the default) selects the built-in System template.
    groupsPriority Boolean
    Whether to enable groups priority.
    limitMappingToMandatoryAttributes Boolean
    Mapping to attributes not specified in mandatoryUserAttributes is not allowed.
    mandatoryUserAttributes List<Property Map>
    Define the required Descope attributes that must be populated when receiving SSO information.
    markEmailAsUnverified Boolean
    Whether to mark the user's email as unverified when logging in via SSO.
    mergeUsers Boolean
    Whether to merge existing user accounts with new ones created through SSO authentication.
    projectId String
    The ID of the project that these settings belong to. Changing this value will require the resource to be deleted and recreated.
    redirectUrl String
    The URL the end user is redirected to after a successful authentication. If one is specified in tenant level settings or SDK/API call, they will override this value.
    requireGroupsAttributeName Boolean
    When configuring SSO the groups attribute name must be specified.
    requireSsoDomains Boolean
    When configuring SSO an SSO domain must be specified.
    ssoSuiteSettings Property Map
    Configuration block for the SSO Suite.

    Supporting Types

    SsoSettingsMandatoryUserAttribute, SsoSettingsMandatoryUserAttributeArgs

    Id string
    The identifier for the attribute. This value is called Machine Name in the Descope console.
    Custom bool
    Whether the attribute is a custom attribute defined in addition to the default Descope user attributes.
    Id string
    The identifier for the attribute. This value is called Machine Name in the Descope console.
    Custom bool
    Whether the attribute is a custom attribute defined in addition to the default Descope user attributes.
    id string
    The identifier for the attribute. This value is called Machine Name in the Descope console.
    custom bool
    Whether the attribute is a custom attribute defined in addition to the default Descope user attributes.
    id String
    The identifier for the attribute. This value is called Machine Name in the Descope console.
    custom Boolean
    Whether the attribute is a custom attribute defined in addition to the default Descope user attributes.
    id string
    The identifier for the attribute. This value is called Machine Name in the Descope console.
    custom boolean
    Whether the attribute is a custom attribute defined in addition to the default Descope user attributes.
    id str
    The identifier for the attribute. This value is called Machine Name in the Descope console.
    custom bool
    Whether the attribute is a custom attribute defined in addition to the default Descope user attributes.
    id String
    The identifier for the attribute. This value is called Machine Name in the Descope console.
    custom Boolean
    Whether the attribute is a custom attribute defined in addition to the default Descope user attributes.

    SsoSettingsSsoSuiteSettings, SsoSettingsSsoSuiteSettingsArgs

    ForceDomainVerification bool
    Setting this to true will allow only verified domains to be used.
    HideDomains bool
    Setting this to true will hide the domains configuration section in the SSO Suite interface.
    HideFgaMapping bool
    Setting this to true will hide the FGA mapping configuration section in the SSO Suite interface.
    HideGroupsMapping bool
    Setting this to true will hide the groups mapping configuration section in the SSO Suite interface.
    HideJitGuide bool
    Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
    HideOidc bool
    Setting this to true will hide the OIDC configuration option.
    HideRoleMapping bool
    Setting this to true will hide the role mapping configuration section in the SSO Suite interface.
    HideSaml bool
    Setting this to true will hide the SAML configuration option.
    HideScim bool
    Setting this to true will hide the SCIM configuration in the SSO Suite interface.
    HideSso bool
    Setting this to true will hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning.
    OidcLoginIdAttribute string
    The identity provider claim the SSO Suite suggests as the Login ID when a tenant configures OIDC. Leave empty to keep the default, which suggests the sub claim. SAML configurations are unaffected.
    ShowHelpContact bool
    Whether to display the help/support contact link in the SSO Suite UI.
    ShowXaa bool
    Whether to show the Cross-App Access (XAA) section in the SSO Suite hosted UI. Cross-App Access is opt-in: it stays hidden unless this is set.
    StyleId string
    Specifies the style ID to apply in the SSO Suite. Ensure a style with this ID exists in the console for it to be used.
    SupportEmail string
    Email address shown to end-users in the SSO Suite UI as a support contact.
    ForceDomainVerification bool
    Setting this to true will allow only verified domains to be used.
    HideDomains bool
    Setting this to true will hide the domains configuration section in the SSO Suite interface.
    HideFgaMapping bool
    Setting this to true will hide the FGA mapping configuration section in the SSO Suite interface.
    HideGroupsMapping bool
    Setting this to true will hide the groups mapping configuration section in the SSO Suite interface.
    HideJitGuide bool
    Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
    HideOidc bool
    Setting this to true will hide the OIDC configuration option.
    HideRoleMapping bool
    Setting this to true will hide the role mapping configuration section in the SSO Suite interface.
    HideSaml bool
    Setting this to true will hide the SAML configuration option.
    HideScim bool
    Setting this to true will hide the SCIM configuration in the SSO Suite interface.
    HideSso bool
    Setting this to true will hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning.
    OidcLoginIdAttribute string
    The identity provider claim the SSO Suite suggests as the Login ID when a tenant configures OIDC. Leave empty to keep the default, which suggests the sub claim. SAML configurations are unaffected.
    ShowHelpContact bool
    Whether to display the help/support contact link in the SSO Suite UI.
    ShowXaa bool
    Whether to show the Cross-App Access (XAA) section in the SSO Suite hosted UI. Cross-App Access is opt-in: it stays hidden unless this is set.
    StyleId string
    Specifies the style ID to apply in the SSO Suite. Ensure a style with this ID exists in the console for it to be used.
    SupportEmail string
    Email address shown to end-users in the SSO Suite UI as a support contact.
    force_domain_verification bool
    Setting this to true will allow only verified domains to be used.
    hide_domains bool
    Setting this to true will hide the domains configuration section in the SSO Suite interface.
    hide_fga_mapping bool
    Setting this to true will hide the FGA mapping configuration section in the SSO Suite interface.
    hide_groups_mapping bool
    Setting this to true will hide the groups mapping configuration section in the SSO Suite interface.
    hide_jit_guide bool
    Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
    hide_oidc bool
    Setting this to true will hide the OIDC configuration option.
    hide_role_mapping bool
    Setting this to true will hide the role mapping configuration section in the SSO Suite interface.
    hide_saml bool
    Setting this to true will hide the SAML configuration option.
    hide_scim bool
    Setting this to true will hide the SCIM configuration in the SSO Suite interface.
    hide_sso bool
    Setting this to true will hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning.
    oidc_login_id_attribute string
    The identity provider claim the SSO Suite suggests as the Login ID when a tenant configures OIDC. Leave empty to keep the default, which suggests the sub claim. SAML configurations are unaffected.
    show_help_contact bool
    Whether to display the help/support contact link in the SSO Suite UI.
    show_xaa bool
    Whether to show the Cross-App Access (XAA) section in the SSO Suite hosted UI. Cross-App Access is opt-in: it stays hidden unless this is set.
    style_id string
    Specifies the style ID to apply in the SSO Suite. Ensure a style with this ID exists in the console for it to be used.
    support_email string
    Email address shown to end-users in the SSO Suite UI as a support contact.
    forceDomainVerification Boolean
    Setting this to true will allow only verified domains to be used.
    hideDomains Boolean
    Setting this to true will hide the domains configuration section in the SSO Suite interface.
    hideFgaMapping Boolean
    Setting this to true will hide the FGA mapping configuration section in the SSO Suite interface.
    hideGroupsMapping Boolean
    Setting this to true will hide the groups mapping configuration section in the SSO Suite interface.
    hideJitGuide Boolean
    Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
    hideOidc Boolean
    Setting this to true will hide the OIDC configuration option.
    hideRoleMapping Boolean
    Setting this to true will hide the role mapping configuration section in the SSO Suite interface.
    hideSaml Boolean
    Setting this to true will hide the SAML configuration option.
    hideScim Boolean
    Setting this to true will hide the SCIM configuration in the SSO Suite interface.
    hideSso Boolean
    Setting this to true will hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning.
    oidcLoginIdAttribute String
    The identity provider claim the SSO Suite suggests as the Login ID when a tenant configures OIDC. Leave empty to keep the default, which suggests the sub claim. SAML configurations are unaffected.
    showHelpContact Boolean
    Whether to display the help/support contact link in the SSO Suite UI.
    showXaa Boolean
    Whether to show the Cross-App Access (XAA) section in the SSO Suite hosted UI. Cross-App Access is opt-in: it stays hidden unless this is set.
    styleId String
    Specifies the style ID to apply in the SSO Suite. Ensure a style with this ID exists in the console for it to be used.
    supportEmail String
    Email address shown to end-users in the SSO Suite UI as a support contact.
    forceDomainVerification boolean
    Setting this to true will allow only verified domains to be used.
    hideDomains boolean
    Setting this to true will hide the domains configuration section in the SSO Suite interface.
    hideFgaMapping boolean
    Setting this to true will hide the FGA mapping configuration section in the SSO Suite interface.
    hideGroupsMapping boolean
    Setting this to true will hide the groups mapping configuration section in the SSO Suite interface.
    hideJitGuide boolean
    Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
    hideOidc boolean
    Setting this to true will hide the OIDC configuration option.
    hideRoleMapping boolean
    Setting this to true will hide the role mapping configuration section in the SSO Suite interface.
    hideSaml boolean
    Setting this to true will hide the SAML configuration option.
    hideScim boolean
    Setting this to true will hide the SCIM configuration in the SSO Suite interface.
    hideSso boolean
    Setting this to true will hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning.
    oidcLoginIdAttribute string
    The identity provider claim the SSO Suite suggests as the Login ID when a tenant configures OIDC. Leave empty to keep the default, which suggests the sub claim. SAML configurations are unaffected.
    showHelpContact boolean
    Whether to display the help/support contact link in the SSO Suite UI.
    showXaa boolean
    Whether to show the Cross-App Access (XAA) section in the SSO Suite hosted UI. Cross-App Access is opt-in: it stays hidden unless this is set.
    styleId string
    Specifies the style ID to apply in the SSO Suite. Ensure a style with this ID exists in the console for it to be used.
    supportEmail string
    Email address shown to end-users in the SSO Suite UI as a support contact.
    force_domain_verification bool
    Setting this to true will allow only verified domains to be used.
    hide_domains bool
    Setting this to true will hide the domains configuration section in the SSO Suite interface.
    hide_fga_mapping bool
    Setting this to true will hide the FGA mapping configuration section in the SSO Suite interface.
    hide_groups_mapping bool
    Setting this to true will hide the groups mapping configuration section in the SSO Suite interface.
    hide_jit_guide bool
    Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
    hide_oidc bool
    Setting this to true will hide the OIDC configuration option.
    hide_role_mapping bool
    Setting this to true will hide the role mapping configuration section in the SSO Suite interface.
    hide_saml bool
    Setting this to true will hide the SAML configuration option.
    hide_scim bool
    Setting this to true will hide the SCIM configuration in the SSO Suite interface.
    hide_sso bool
    Setting this to true will hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning.
    oidc_login_id_attribute str
    The identity provider claim the SSO Suite suggests as the Login ID when a tenant configures OIDC. Leave empty to keep the default, which suggests the sub claim. SAML configurations are unaffected.
    show_help_contact bool
    Whether to display the help/support contact link in the SSO Suite UI.
    show_xaa bool
    Whether to show the Cross-App Access (XAA) section in the SSO Suite hosted UI. Cross-App Access is opt-in: it stays hidden unless this is set.
    style_id str
    Specifies the style ID to apply in the SSO Suite. Ensure a style with this ID exists in the console for it to be used.
    support_email str
    Email address shown to end-users in the SSO Suite UI as a support contact.
    forceDomainVerification Boolean
    Setting this to true will allow only verified domains to be used.
    hideDomains Boolean
    Setting this to true will hide the domains configuration section in the SSO Suite interface.
    hideFgaMapping Boolean
    Setting this to true will hide the FGA mapping configuration section in the SSO Suite interface.
    hideGroupsMapping Boolean
    Setting this to true will hide the groups mapping configuration section in the SSO Suite interface.
    hideJitGuide Boolean
    Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
    hideOidc Boolean
    Setting this to true will hide the OIDC configuration option.
    hideRoleMapping Boolean
    Setting this to true will hide the role mapping configuration section in the SSO Suite interface.
    hideSaml Boolean
    Setting this to true will hide the SAML configuration option.
    hideScim Boolean
    Setting this to true will hide the SCIM configuration in the SSO Suite interface.
    hideSso Boolean
    Setting this to true will hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning.
    oidcLoginIdAttribute String
    The identity provider claim the SSO Suite suggests as the Login ID when a tenant configures OIDC. Leave empty to keep the default, which suggests the sub claim. SAML configurations are unaffected.
    showHelpContact Boolean
    Whether to display the help/support contact link in the SSO Suite UI.
    showXaa Boolean
    Whether to show the Cross-App Access (XAA) section in the SSO Suite hosted UI. Cross-App Access is opt-in: it stays hidden unless this is set.
    styleId String
    Specifies the style ID to apply in the SSO Suite. Ensure a style with this ID exists in the console for it to be used.
    supportEmail String
    Email address shown to end-users in the SSO Suite UI as a support contact.

    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