published on Sunday, Oct 11, 2026 by Descope
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:
- 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 boolDomains - Whether to allow duplicate SSO domains across tenants.
- Allow
Merge boolUsers With Multiple Tenants - 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 boolRoles - Whether to allow overriding user's roles with SSO related roles.
- Block
If boolEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- Disabled bool
- Setting this to
truewill 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 stringId - 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 stringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - Groups
Priority bool - Whether to enable groups priority.
- Limit
Mapping boolTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - Mandatory
User List<Descope.Attributes Sso Settings Mandatory User Attribute> - Define the required Descope attributes that must be populated when receiving SSO information.
- Mark
Email boolAs Unverified - 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 boolAttribute Name - When configuring SSO the groups attribute name must be specified.
- Require
Sso boolDomains - When configuring SSO an SSO domain must be specified.
- Sso
Suite Descope.Settings Sso Settings Sso Suite Settings - 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 boolDomains - Whether to allow duplicate SSO domains across tenants.
- Allow
Merge boolUsers With Multiple Tenants - 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 boolRoles - Whether to allow overriding user's roles with SSO related roles.
- Block
If boolEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- Disabled bool
- Setting this to
truewill 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 stringId - 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 stringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - Groups
Priority bool - Whether to enable groups priority.
- Limit
Mapping boolTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - Mandatory
User []SsoAttributes Settings Mandatory User Attribute Args - Define the required Descope attributes that must be populated when receiving SSO information.
- Mark
Email boolAs Unverified - 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 boolAttribute Name - When configuring SSO the groups attribute name must be specified.
- Require
Sso boolDomains - When configuring SSO an SSO domain must be specified.
- Sso
Suite SsoSettings Settings Sso Suite Settings Args - 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_ booldomains - Whether to allow duplicate SSO domains across tenants.
- allow_
merge_ boolusers_ with_ multiple_ tenants - 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_ boolroles - Whether to allow overriding user's roles with SSO related roles.
- block_
if_ boolemail_ domain_ mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled bool
- Setting this to
truewill 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_ stringid - 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_ stringid - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups_
priority bool - Whether to enable groups priority.
- limit_
mapping_ boolto_ mandatory_ attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory_
user_ list(object)attributes - Define the required Descope attributes that must be populated when receiving SSO information.
- mark_
email_ boolas_ unverified - 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_ boolattribute_ name - When configuring SSO the groups attribute name must be specified.
- require_
sso_ booldomains - When configuring SSO an SSO domain must be specified.
- sso_
suite_ objectsettings - 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 BooleanDomains - Whether to allow duplicate SSO domains across tenants.
- allow
Merge BooleanUsers With Multiple Tenants - 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 BooleanRoles - Whether to allow overriding user's roles with SSO related roles.
- block
If BooleanEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled Boolean
- Setting this to
truewill 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 StringId - 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 StringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups
Priority Boolean - Whether to enable groups priority.
- limit
Mapping BooleanTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory
User List<SsoAttributes Settings Mandatory User Attribute> - Define the required Descope attributes that must be populated when receiving SSO information.
- mark
Email BooleanAs Unverified - Whether to mark the user's email as unverified when logging in via SSO.
- merge
Users Boolean - 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 BooleanAttribute Name - When configuring SSO the groups attribute name must be specified.
- require
Sso BooleanDomains - When configuring SSO an SSO domain must be specified.
- sso
Suite SsoSettings Settings Sso Suite Settings - 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 booleanDomains - Whether to allow duplicate SSO domains across tenants.
- allow
Merge booleanUsers With Multiple Tenants - 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 booleanRoles - Whether to allow overriding user's roles with SSO related roles.
- block
If booleanEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled boolean
- Setting this to
truewill 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 stringId - 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 stringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups
Priority boolean - Whether to enable groups priority.
- limit
Mapping booleanTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory
User SsoAttributes Settings Mandatory User Attribute[] - Define the required Descope attributes that must be populated when receiving SSO information.
- mark
Email booleanAs Unverified - Whether to mark the user's email as unverified when logging in via SSO.
- merge
Users boolean - 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 booleanAttribute Name - When configuring SSO the groups attribute name must be specified.
- require
Sso booleanDomains - When configuring SSO an SSO domain must be specified.
- sso
Suite SsoSettings Settings Sso Suite Settings - 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_ booldomains - Whether to allow duplicate SSO domains across tenants.
- allow_
merge_ boolusers_ with_ multiple_ tenants - 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_ boolroles - Whether to allow overriding user's roles with SSO related roles.
- block_
if_ boolemail_ domain_ mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled bool
- Setting this to
truewill 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_ strid - 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_ strid - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups_
priority bool - Whether to enable groups priority.
- limit_
mapping_ boolto_ mandatory_ attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory_
user_ Sequence[Ssoattributes Settings Mandatory User Attribute Args] - Define the required Descope attributes that must be populated when receiving SSO information.
- mark_
email_ boolas_ unverified - 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_ boolattribute_ name - When configuring SSO the groups attribute name must be specified.
- require_
sso_ booldomains - When configuring SSO an SSO domain must be specified.
- sso_
suite_ Ssosettings Settings Sso Suite Settings Args - 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 BooleanDomains - Whether to allow duplicate SSO domains across tenants.
- allow
Merge BooleanUsers With Multiple Tenants - 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 BooleanRoles - Whether to allow overriding user's roles with SSO related roles.
- block
If BooleanEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled Boolean
- Setting this to
truewill 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 StringId - 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 StringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups
Priority Boolean - Whether to enable groups priority.
- limit
Mapping BooleanTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory
User List<Property Map>Attributes - Define the required Descope attributes that must be populated when receiving SSO information.
- mark
Email BooleanAs Unverified - Whether to mark the user's email as unverified when logging in via SSO.
- merge
Users Boolean - 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 BooleanAttribute Name - When configuring SSO the groups attribute name must be specified.
- require
Sso BooleanDomains - When configuring SSO an SSO domain must be specified.
- sso
Suite Property MapSettings - 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) -> SsoSettingsfunc 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.
- Allow
Duplicate boolDomains - Whether to allow duplicate SSO domains across tenants.
- Allow
Merge boolUsers With Multiple Tenants - 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 boolRoles - Whether to allow overriding user's roles with SSO related roles.
- Block
If boolEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- Disabled bool
- Setting this to
truewill 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 stringId - 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 stringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - Groups
Priority bool - Whether to enable groups priority.
- Limit
Mapping boolTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - Mandatory
User List<Descope.Attributes Sso Settings Mandatory User Attribute> - Define the required Descope attributes that must be populated when receiving SSO information.
- Mark
Email boolAs Unverified - 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 boolAttribute Name - When configuring SSO the groups attribute name must be specified.
- Require
Sso boolDomains - When configuring SSO an SSO domain must be specified.
- Sso
Suite Descope.Settings Sso Settings Sso Suite Settings - Configuration block for the SSO Suite.
- Allow
Duplicate boolDomains - Whether to allow duplicate SSO domains across tenants.
- Allow
Merge boolUsers With Multiple Tenants - 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 boolRoles - Whether to allow overriding user's roles with SSO related roles.
- Block
If boolEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- Disabled bool
- Setting this to
truewill 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 stringId - 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 stringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - Groups
Priority bool - Whether to enable groups priority.
- Limit
Mapping boolTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - Mandatory
User []SsoAttributes Settings Mandatory User Attribute Args - Define the required Descope attributes that must be populated when receiving SSO information.
- Mark
Email boolAs Unverified - 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 boolAttribute Name - When configuring SSO the groups attribute name must be specified.
- Require
Sso boolDomains - When configuring SSO an SSO domain must be specified.
- Sso
Suite SsoSettings Settings Sso Suite Settings Args - Configuration block for the SSO Suite.
- allow_
duplicate_ booldomains - Whether to allow duplicate SSO domains across tenants.
- allow_
merge_ boolusers_ with_ multiple_ tenants - 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_ boolroles - Whether to allow overriding user's roles with SSO related roles.
- block_
if_ boolemail_ domain_ mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled bool
- Setting this to
truewill 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_ stringid - 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_ stringid - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups_
priority bool - Whether to enable groups priority.
- limit_
mapping_ boolto_ mandatory_ attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory_
user_ list(object)attributes - Define the required Descope attributes that must be populated when receiving SSO information.
- mark_
email_ boolas_ unverified - 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_ boolattribute_ name - When configuring SSO the groups attribute name must be specified.
- require_
sso_ booldomains - When configuring SSO an SSO domain must be specified.
- sso_
suite_ objectsettings - Configuration block for the SSO Suite.
- allow
Duplicate BooleanDomains - Whether to allow duplicate SSO domains across tenants.
- allow
Merge BooleanUsers With Multiple Tenants - 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 BooleanRoles - Whether to allow overriding user's roles with SSO related roles.
- block
If BooleanEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled Boolean
- Setting this to
truewill 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 StringId - 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 StringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups
Priority Boolean - Whether to enable groups priority.
- limit
Mapping BooleanTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory
User List<SsoAttributes Settings Mandatory User Attribute> - Define the required Descope attributes that must be populated when receiving SSO information.
- mark
Email BooleanAs Unverified - Whether to mark the user's email as unverified when logging in via SSO.
- merge
Users Boolean - 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 BooleanAttribute Name - When configuring SSO the groups attribute name must be specified.
- require
Sso BooleanDomains - When configuring SSO an SSO domain must be specified.
- sso
Suite SsoSettings Settings Sso Suite Settings - Configuration block for the SSO Suite.
- allow
Duplicate booleanDomains - Whether to allow duplicate SSO domains across tenants.
- allow
Merge booleanUsers With Multiple Tenants - 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 booleanRoles - Whether to allow overriding user's roles with SSO related roles.
- block
If booleanEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled boolean
- Setting this to
truewill 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 stringId - 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 stringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups
Priority boolean - Whether to enable groups priority.
- limit
Mapping booleanTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory
User SsoAttributes Settings Mandatory User Attribute[] - Define the required Descope attributes that must be populated when receiving SSO information.
- mark
Email booleanAs Unverified - Whether to mark the user's email as unverified when logging in via SSO.
- merge
Users boolean - 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 booleanAttribute Name - When configuring SSO the groups attribute name must be specified.
- require
Sso booleanDomains - When configuring SSO an SSO domain must be specified.
- sso
Suite SsoSettings Settings Sso Suite Settings - Configuration block for the SSO Suite.
- allow_
duplicate_ booldomains - Whether to allow duplicate SSO domains across tenants.
- allow_
merge_ boolusers_ with_ multiple_ tenants - 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_ boolroles - Whether to allow overriding user's roles with SSO related roles.
- block_
if_ boolemail_ domain_ mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled bool
- Setting this to
truewill 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_ strid - 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_ strid - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups_
priority bool - Whether to enable groups priority.
- limit_
mapping_ boolto_ mandatory_ attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory_
user_ Sequence[Ssoattributes Settings Mandatory User Attribute Args] - Define the required Descope attributes that must be populated when receiving SSO information.
- mark_
email_ boolas_ unverified - 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_ boolattribute_ name - When configuring SSO the groups attribute name must be specified.
- require_
sso_ booldomains - When configuring SSO an SSO domain must be specified.
- sso_
suite_ Ssosettings Settings Sso Suite Settings Args - Configuration block for the SSO Suite.
- allow
Duplicate BooleanDomains - Whether to allow duplicate SSO domains across tenants.
- allow
Merge BooleanUsers With Multiple Tenants - 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 BooleanRoles - Whether to allow overriding user's roles with SSO related roles.
- block
If BooleanEmail Domain Mismatch - Whether to block SSO login if the user's email domain doesn't match the configured SSO domains.
- disabled Boolean
- Setting this to
truewill 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 StringId - 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 StringId - The ID of the email template for SSO configuration invitation emails, taken from a
descope.EmailTemplateresource with itsmethodset tosso. An empty value (the default) selects the built-in System template. - groups
Priority Boolean - Whether to enable groups priority.
- limit
Mapping BooleanTo Mandatory Attributes - Mapping to attributes not specified in
mandatoryUserAttributesis not allowed. - mandatory
User List<Property Map>Attributes - Define the required Descope attributes that must be populated when receiving SSO information.
- mark
Email BooleanAs Unverified - Whether to mark the user's email as unverified when logging in via SSO.
- merge
Users Boolean - 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 BooleanAttribute Name - When configuring SSO the groups attribute name must be specified.
- require
Sso BooleanDomains - When configuring SSO an SSO domain must be specified.
- sso
Suite Property MapSettings - Configuration block for the SSO Suite.
Supporting Types
SsoSettingsMandatoryUserAttribute, SsoSettingsMandatoryUserAttributeArgs
SsoSettingsSsoSuiteSettings, SsoSettingsSsoSuiteSettingsArgs
- Force
Domain boolVerification - Setting this to
truewill allow only verified domains to be used. - Hide
Domains bool - Setting this to
truewill hide the domains configuration section in the SSO Suite interface. - Hide
Fga boolMapping - Setting this to
truewill hide the FGA mapping configuration section in the SSO Suite interface. - Hide
Groups boolMapping - Setting this to
truewill hide the groups mapping configuration section in the SSO Suite interface. - Hide
Jit boolGuide - Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
- Hide
Oidc bool - Setting this to
truewill hide the OIDC configuration option. - Hide
Role boolMapping - Setting this to
truewill hide the role mapping configuration section in the SSO Suite interface. - Hide
Saml bool - Setting this to
truewill hide the SAML configuration option. - Hide
Scim bool - Setting this to
truewill hide the SCIM configuration in the SSO Suite interface. - Hide
Sso bool - Setting this to
truewill hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning. - Oidc
Login stringId Attribute - 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
subclaim. SAML configurations are unaffected. - Show
Help boolContact - 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.
- Force
Domain boolVerification - Setting this to
truewill allow only verified domains to be used. - Hide
Domains bool - Setting this to
truewill hide the domains configuration section in the SSO Suite interface. - Hide
Fga boolMapping - Setting this to
truewill hide the FGA mapping configuration section in the SSO Suite interface. - Hide
Groups boolMapping - Setting this to
truewill hide the groups mapping configuration section in the SSO Suite interface. - Hide
Jit boolGuide - Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
- Hide
Oidc bool - Setting this to
truewill hide the OIDC configuration option. - Hide
Role boolMapping - Setting this to
truewill hide the role mapping configuration section in the SSO Suite interface. - Hide
Saml bool - Setting this to
truewill hide the SAML configuration option. - Hide
Scim bool - Setting this to
truewill hide the SCIM configuration in the SSO Suite interface. - Hide
Sso bool - Setting this to
truewill hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning. - Oidc
Login stringId Attribute - 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
subclaim. SAML configurations are unaffected. - Show
Help boolContact - 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.
- force_
domain_ boolverification - Setting this to
truewill allow only verified domains to be used. - hide_
domains bool - Setting this to
truewill hide the domains configuration section in the SSO Suite interface. - hide_
fga_ boolmapping - Setting this to
truewill hide the FGA mapping configuration section in the SSO Suite interface. - hide_
groups_ boolmapping - Setting this to
truewill hide the groups mapping configuration section in the SSO Suite interface. - hide_
jit_ boolguide - Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
- hide_
oidc bool - Setting this to
truewill hide the OIDC configuration option. - hide_
role_ boolmapping - Setting this to
truewill hide the role mapping configuration section in the SSO Suite interface. - hide_
saml bool - Setting this to
truewill hide the SAML configuration option. - hide_
scim bool - Setting this to
truewill hide the SCIM configuration in the SSO Suite interface. - hide_
sso bool - Setting this to
truewill hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning. - oidc_
login_ stringid_ attribute - 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
subclaim. SAML configurations are unaffected. - show_
help_ boolcontact - 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.
- force
Domain BooleanVerification - Setting this to
truewill allow only verified domains to be used. - hide
Domains Boolean - Setting this to
truewill hide the domains configuration section in the SSO Suite interface. - hide
Fga BooleanMapping - Setting this to
truewill hide the FGA mapping configuration section in the SSO Suite interface. - hide
Groups BooleanMapping - Setting this to
truewill hide the groups mapping configuration section in the SSO Suite interface. - hide
Jit BooleanGuide - Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
- hide
Oidc Boolean - Setting this to
truewill hide the OIDC configuration option. - hide
Role BooleanMapping - Setting this to
truewill hide the role mapping configuration section in the SSO Suite interface. - hide
Saml Boolean - Setting this to
truewill hide the SAML configuration option. - hide
Scim Boolean - Setting this to
truewill hide the SCIM configuration in the SSO Suite interface. - hide
Sso Boolean - Setting this to
truewill hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning. - oidc
Login StringId Attribute - 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
subclaim. SAML configurations are unaffected. - show
Help BooleanContact - Whether to display the help/support contact link in the SSO Suite UI.
- show
Xaa 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.
- 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.
- force
Domain booleanVerification - Setting this to
truewill allow only verified domains to be used. - hide
Domains boolean - Setting this to
truewill hide the domains configuration section in the SSO Suite interface. - hide
Fga booleanMapping - Setting this to
truewill hide the FGA mapping configuration section in the SSO Suite interface. - hide
Groups booleanMapping - Setting this to
truewill hide the groups mapping configuration section in the SSO Suite interface. - hide
Jit booleanGuide - Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
- hide
Oidc boolean - Setting this to
truewill hide the OIDC configuration option. - hide
Role booleanMapping - Setting this to
truewill hide the role mapping configuration section in the SSO Suite interface. - hide
Saml boolean - Setting this to
truewill hide the SAML configuration option. - hide
Scim boolean - Setting this to
truewill hide the SCIM configuration in the SSO Suite interface. - hide
Sso boolean - Setting this to
truewill hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning. - oidc
Login stringId Attribute - 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
subclaim. SAML configurations are unaffected. - show
Help booleanContact - Whether to display the help/support contact link in the SSO Suite UI.
- show
Xaa 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.
- 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.
- force_
domain_ boolverification - Setting this to
truewill allow only verified domains to be used. - hide_
domains bool - Setting this to
truewill hide the domains configuration section in the SSO Suite interface. - hide_
fga_ boolmapping - Setting this to
truewill hide the FGA mapping configuration section in the SSO Suite interface. - hide_
groups_ boolmapping - Setting this to
truewill hide the groups mapping configuration section in the SSO Suite interface. - hide_
jit_ boolguide - Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
- hide_
oidc bool - Setting this to
truewill hide the OIDC configuration option. - hide_
role_ boolmapping - Setting this to
truewill hide the role mapping configuration section in the SSO Suite interface. - hide_
saml bool - Setting this to
truewill hide the SAML configuration option. - hide_
scim bool - Setting this to
truewill hide the SCIM configuration in the SSO Suite interface. - hide_
sso bool - Setting this to
truewill hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning. - oidc_
login_ strid_ attribute - 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
subclaim. SAML configurations are unaffected. - show_
help_ boolcontact - 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.
- force
Domain BooleanVerification - Setting this to
truewill allow only verified domains to be used. - hide
Domains Boolean - Setting this to
truewill hide the domains configuration section in the SSO Suite interface. - hide
Fga BooleanMapping - Setting this to
truewill hide the FGA mapping configuration section in the SSO Suite interface. - hide
Groups BooleanMapping - Setting this to
truewill hide the groups mapping configuration section in the SSO Suite interface. - hide
Jit BooleanGuide - Whether to hide the JIT provisioning guide section in the SSO Suite hosted UI.
- hide
Oidc Boolean - Setting this to
truewill hide the OIDC configuration option. - hide
Role BooleanMapping - Setting this to
truewill hide the role mapping configuration section in the SSO Suite interface. - hide
Saml Boolean - Setting this to
truewill hide the SAML configuration option. - hide
Scim Boolean - Setting this to
truewill hide the SCIM configuration in the SSO Suite interface. - hide
Sso Boolean - Setting this to
truewill hide the SSO configuration in the SSO Suite interface, for tenants that only need to set up SCIM provisioning. - oidc
Login StringId Attribute - 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
subclaim. SAML configurations are unaffected. - show
Help BooleanContact - Whether to display the help/support contact link in the SSO Suite UI.
- show
Xaa 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.
- 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.
Package Details
- Repository
- descope descope/pulumi-descope
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
descopeTerraform Provider.
published on Sunday, Oct 11, 2026 by Descope