Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Propelauth Provider
  3. API Docs
  4. OrganizationConfiguration
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

propelauth.OrganizationConfiguration

Explore with Pulumi AI

propelauth logo
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

    Organization Configuration. This is for configuring your global organization settings in PropelAuth. Settings on specific organizations can be managed in the dashboard.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as propelauth from "@pulumi/propelauth";

// Configure how your global organization settings in PropelAuth.
const example = new propelauth.OrganizationConfiguration("example", {
    hasOrgs: true,
    maxNumOrgsUsersCanBeIn: 1,
    orgsCanRequire2fa: true,
    orgsMetaname: "Company",
    usersCanDeleteTheirOwnOrgs: true,
});

    import pulumi
import pulumi_propelauth as propelauth

# Configure how your global organization settings in PropelAuth.
example = propelauth.OrganizationConfiguration("example",
    has_orgs=True,
    max_num_orgs_users_can_be_in=1,
    orgs_can_require2fa=True,
    orgs_metaname="Company",
    users_can_delete_their_own_orgs=True)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/propelauth/propelauth"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Configure how your global organization settings in PropelAuth.
		_, err := propelauth.NewOrganizationConfiguration(ctx, "example", &propelauth.OrganizationConfigurationArgs{
			HasOrgs:                    pulumi.Bool(true),
			MaxNumOrgsUsersCanBeIn:     pulumi.Float64(1),
			OrgsCanRequire2fa:          pulumi.Bool(true),
			OrgsMetaname:               pulumi.String("Company"),
			UsersCanDeleteTheirOwnOrgs: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Propelauth = Pulumi.Propelauth;

return await Deployment.RunAsync(() => 
{
    // Configure how your global organization settings in PropelAuth.
    var example = new Propelauth.OrganizationConfiguration("example", new()
    {
        HasOrgs = true,
        MaxNumOrgsUsersCanBeIn = 1,
        OrgsCanRequire2fa = true,
        OrgsMetaname = "Company",
        UsersCanDeleteTheirOwnOrgs = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.propelauth.OrganizationConfiguration;
import com.pulumi.propelauth.OrganizationConfigurationArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        // Configure how your global organization settings in PropelAuth.
        var example = new OrganizationConfiguration("example", OrganizationConfigurationArgs.builder()
            .hasOrgs(true)
            .maxNumOrgsUsersCanBeIn(1)
            .orgsCanRequire2fa(true)
            .orgsMetaname("Company")
            .usersCanDeleteTheirOwnOrgs(true)
            .build());

    }
}

    resources:
  # Configure how your global organization settings in PropelAuth.
  example:
    type: propelauth:OrganizationConfiguration
    properties:
      hasOrgs: true
      maxNumOrgsUsersCanBeIn: 1
      orgsCanRequire2fa: true
      orgsMetaname: Company
      usersCanDeleteTheirOwnOrgs: true

    Create OrganizationConfiguration Resource

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

    Constructor syntax

    new OrganizationConfiguration(name: string, args?: OrganizationConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def OrganizationConfiguration(resource_name: str,
                              args: Optional[OrganizationConfigurationArgs] = None,
                              opts: Optional[ResourceOptions] = None)

@overload
def OrganizationConfiguration(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              customer_org_audit_log_settings: Optional[OrganizationConfigurationCustomerOrgAuditLogSettingsArgs] = None,
                              default_to_saml_login: Optional[bool] = None,
                              has_orgs: Optional[bool] = None,
                              max_num_orgs_users_can_be_in: Optional[float] = None,
                              orgs_can_require2fa: Optional[bool] = None,
                              orgs_can_setup_saml: Optional[bool] = None,
                              orgs_metaname: Optional[str] = None,
                              skip_saml_role_mapping_step: Optional[bool] = None,
                              use_org_name_for_saml: Optional[bool] = None,
                              users_can_create_orgs: Optional[bool] = None,
                              users_can_delete_their_own_orgs: Optional[bool] = None,
                              users_must_be_in_an_organization: Optional[bool] = None)
    func NewOrganizationConfiguration(ctx *Context, name string, args *OrganizationConfigurationArgs, opts ...ResourceOption) (*OrganizationConfiguration, error)
    public OrganizationConfiguration(string name, OrganizationConfigurationArgs? args = null, CustomResourceOptions? opts = null)
    public OrganizationConfiguration(String name, OrganizationConfigurationArgs args)
public OrganizationConfiguration(String name, OrganizationConfigurationArgs args, CustomResourceOptions options)

    type: propelauth:OrganizationConfiguration
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OrganizationConfigurationArgs
    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 OrganizationConfigurationArgs
    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 OrganizationConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrganizationConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrganizationConfigurationArgs
    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 organizationConfigurationResource = new Propelauth.OrganizationConfiguration("organizationConfigurationResource", new()
{
    CustomerOrgAuditLogSettings = new Propelauth.Inputs.OrganizationConfigurationCustomerOrgAuditLogSettingsArgs
    {
        AllOrgsCanViewTheirAuditLog = false,
        Enabled = false,
        IncludeApiKeyActions = false,
        IncludeEmployeeActions = false,
        IncludeImpersonation = false,
    },
    DefaultToSamlLogin = false,
    HasOrgs = false,
    MaxNumOrgsUsersCanBeIn = 0,
    OrgsCanRequire2fa = false,
    OrgsCanSetupSaml = false,
    OrgsMetaname = "string",
    SkipSamlRoleMappingStep = false,
    UseOrgNameForSaml = false,
    UsersCanCreateOrgs = false,
    UsersCanDeleteTheirOwnOrgs = false,
    UsersMustBeInAnOrganization = false,
});

    example, err := propelauth.NewOrganizationConfiguration(ctx, "organizationConfigurationResource", &propelauth.OrganizationConfigurationArgs{
CustomerOrgAuditLogSettings: &.OrganizationConfigurationCustomerOrgAuditLogSettingsArgs{
AllOrgsCanViewTheirAuditLog: pulumi.Bool(false),
Enabled: pulumi.Bool(false),
IncludeApiKeyActions: pulumi.Bool(false),
IncludeEmployeeActions: pulumi.Bool(false),
IncludeImpersonation: pulumi.Bool(false),
},
DefaultToSamlLogin: pulumi.Bool(false),
HasOrgs: pulumi.Bool(false),
MaxNumOrgsUsersCanBeIn: pulumi.Float64(0),
OrgsCanRequire2fa: pulumi.Bool(false),
OrgsCanSetupSaml: pulumi.Bool(false),
OrgsMetaname: pulumi.String("string"),
SkipSamlRoleMappingStep: pulumi.Bool(false),
UseOrgNameForSaml: pulumi.Bool(false),
UsersCanCreateOrgs: pulumi.Bool(false),
UsersCanDeleteTheirOwnOrgs: pulumi.Bool(false),
UsersMustBeInAnOrganization: pulumi.Bool(false),
})

    var organizationConfigurationResource = new OrganizationConfiguration("organizationConfigurationResource", OrganizationConfigurationArgs.builder()
    .customerOrgAuditLogSettings(OrganizationConfigurationCustomerOrgAuditLogSettingsArgs.builder()
        .allOrgsCanViewTheirAuditLog(false)
        .enabled(false)
        .includeApiKeyActions(false)
        .includeEmployeeActions(false)
        .includeImpersonation(false)
        .build())
    .defaultToSamlLogin(false)
    .hasOrgs(false)
    .maxNumOrgsUsersCanBeIn(0)
    .orgsCanRequire2fa(false)
    .orgsCanSetupSaml(false)
    .orgsMetaname("string")
    .skipSamlRoleMappingStep(false)
    .useOrgNameForSaml(false)
    .usersCanCreateOrgs(false)
    .usersCanDeleteTheirOwnOrgs(false)
    .usersMustBeInAnOrganization(false)
    .build());

    organization_configuration_resource = propelauth.OrganizationConfiguration("organizationConfigurationResource",
    customer_org_audit_log_settings={
        "all_orgs_can_view_their_audit_log": False,
        "enabled": False,
        "include_api_key_actions": False,
        "include_employee_actions": False,
        "include_impersonation": False,
    },
    default_to_saml_login=False,
    has_orgs=False,
    max_num_orgs_users_can_be_in=0,
    orgs_can_require2fa=False,
    orgs_can_setup_saml=False,
    orgs_metaname="string",
    skip_saml_role_mapping_step=False,
    use_org_name_for_saml=False,
    users_can_create_orgs=False,
    users_can_delete_their_own_orgs=False,
    users_must_be_in_an_organization=False)

    const organizationConfigurationResource = new propelauth.OrganizationConfiguration("organizationConfigurationResource", {
    customerOrgAuditLogSettings: {
        allOrgsCanViewTheirAuditLog: false,
        enabled: false,
        includeApiKeyActions: false,
        includeEmployeeActions: false,
        includeImpersonation: false,
    },
    defaultToSamlLogin: false,
    hasOrgs: false,
    maxNumOrgsUsersCanBeIn: 0,
    orgsCanRequire2fa: false,
    orgsCanSetupSaml: false,
    orgsMetaname: "string",
    skipSamlRoleMappingStep: false,
    useOrgNameForSaml: false,
    usersCanCreateOrgs: false,
    usersCanDeleteTheirOwnOrgs: false,
    usersMustBeInAnOrganization: false,
});

    type: propelauth:OrganizationConfiguration
properties:
    customerOrgAuditLogSettings:
        allOrgsCanViewTheirAuditLog: false
        enabled: false
        includeApiKeyActions: false
        includeEmployeeActions: false
        includeImpersonation: false
    defaultToSamlLogin: false
    hasOrgs: false
    maxNumOrgsUsersCanBeIn: 0
    orgsCanRequire2fa: false
    orgsCanSetupSaml: false
    orgsMetaname: string
    skipSamlRoleMappingStep: false
    useOrgNameForSaml: false
    usersCanCreateOrgs: false
    usersCanDeleteTheirOwnOrgs: false
    usersMustBeInAnOrganization: false

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

    CustomerOrgAuditLogSettings OrganizationConfigurationCustomerOrgAuditLogSettings
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    DefaultToSamlLogin bool
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    HasOrgs bool
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    MaxNumOrgsUsersCanBeIn double
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    OrgsCanRequire2fa bool
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    OrgsCanSetupSaml bool
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    OrgsMetaname string
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    SkipSamlRoleMappingStep bool
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    UseOrgNameForSaml bool
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    UsersCanCreateOrgs bool
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    UsersCanDeleteTheirOwnOrgs bool
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    UsersMustBeInAnOrganization bool
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    CustomerOrgAuditLogSettings OrganizationConfigurationCustomerOrgAuditLogSettingsArgs
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    DefaultToSamlLogin bool
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    HasOrgs bool
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    MaxNumOrgsUsersCanBeIn float64
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    OrgsCanRequire2fa bool
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    OrgsCanSetupSaml bool
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    OrgsMetaname string
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    SkipSamlRoleMappingStep bool
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    UseOrgNameForSaml bool
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    UsersCanCreateOrgs bool
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    UsersCanDeleteTheirOwnOrgs bool
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    UsersMustBeInAnOrganization bool
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    customerOrgAuditLogSettings OrganizationConfigurationCustomerOrgAuditLogSettings
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    defaultToSamlLogin Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    hasOrgs Boolean
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    maxNumOrgsUsersCanBeIn Double
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    orgsCanRequire2fa Boolean
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsCanSetupSaml Boolean
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsMetaname String
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    skipSamlRoleMappingStep Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    useOrgNameForSaml Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    usersCanCreateOrgs Boolean
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    usersCanDeleteTheirOwnOrgs Boolean
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    usersMustBeInAnOrganization Boolean
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    customerOrgAuditLogSettings OrganizationConfigurationCustomerOrgAuditLogSettings
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    defaultToSamlLogin boolean
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    hasOrgs boolean
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    maxNumOrgsUsersCanBeIn number
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    orgsCanRequire2fa boolean
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsCanSetupSaml boolean
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsMetaname string
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    skipSamlRoleMappingStep boolean
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    useOrgNameForSaml boolean
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    usersCanCreateOrgs boolean
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    usersCanDeleteTheirOwnOrgs boolean
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    usersMustBeInAnOrganization boolean
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    customer_org_audit_log_settings OrganizationConfigurationCustomerOrgAuditLogSettingsArgs
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    default_to_saml_login bool
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    has_orgs bool
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    max_num_orgs_users_can_be_in float
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    orgs_can_require2fa bool
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    orgs_can_setup_saml bool
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    orgs_metaname str
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    skip_saml_role_mapping_step bool
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    use_org_name_for_saml bool
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    users_can_create_orgs bool
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    users_can_delete_their_own_orgs bool
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    users_must_be_in_an_organization bool
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    customerOrgAuditLogSettings Property Map
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    defaultToSamlLogin Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    hasOrgs Boolean
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    maxNumOrgsUsersCanBeIn Number
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    orgsCanRequire2fa Boolean
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsCanSetupSaml Boolean
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsMetaname String
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    skipSamlRoleMappingStep Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    useOrgNameForSaml Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    usersCanCreateOrgs Boolean
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    usersCanDeleteTheirOwnOrgs Boolean
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    usersMustBeInAnOrganization Boolean
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrganizationConfiguration 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 str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OrganizationConfiguration Resource

    Get an existing OrganizationConfiguration 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?: OrganizationConfigurationState, opts?: CustomResourceOptions): OrganizationConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        customer_org_audit_log_settings: Optional[OrganizationConfigurationCustomerOrgAuditLogSettingsArgs] = None,
        default_to_saml_login: Optional[bool] = None,
        has_orgs: Optional[bool] = None,
        max_num_orgs_users_can_be_in: Optional[float] = None,
        orgs_can_require2fa: Optional[bool] = None,
        orgs_can_setup_saml: Optional[bool] = None,
        orgs_metaname: Optional[str] = None,
        skip_saml_role_mapping_step: Optional[bool] = None,
        use_org_name_for_saml: Optional[bool] = None,
        users_can_create_orgs: Optional[bool] = None,
        users_can_delete_their_own_orgs: Optional[bool] = None,
        users_must_be_in_an_organization: Optional[bool] = None) -> OrganizationConfiguration
    func GetOrganizationConfiguration(ctx *Context, name string, id IDInput, state *OrganizationConfigurationState, opts ...ResourceOption) (*OrganizationConfiguration, error)
    public static OrganizationConfiguration Get(string name, Input<string> id, OrganizationConfigurationState? state, CustomResourceOptions? opts = null)
    public static OrganizationConfiguration get(String name, Output<String> id, OrganizationConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: propelauth:OrganizationConfiguration    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CustomerOrgAuditLogSettings OrganizationConfigurationCustomerOrgAuditLogSettings
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    DefaultToSamlLogin bool
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    HasOrgs bool
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    MaxNumOrgsUsersCanBeIn double
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    OrgsCanRequire2fa bool
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    OrgsCanSetupSaml bool
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    OrgsMetaname string
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    SkipSamlRoleMappingStep bool
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    UseOrgNameForSaml bool
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    UsersCanCreateOrgs bool
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    UsersCanDeleteTheirOwnOrgs bool
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    UsersMustBeInAnOrganization bool
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    CustomerOrgAuditLogSettings OrganizationConfigurationCustomerOrgAuditLogSettingsArgs
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    DefaultToSamlLogin bool
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    HasOrgs bool
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    MaxNumOrgsUsersCanBeIn float64
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    OrgsCanRequire2fa bool
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    OrgsCanSetupSaml bool
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    OrgsMetaname string
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    SkipSamlRoleMappingStep bool
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    UseOrgNameForSaml bool
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    UsersCanCreateOrgs bool
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    UsersCanDeleteTheirOwnOrgs bool
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    UsersMustBeInAnOrganization bool
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    customerOrgAuditLogSettings OrganizationConfigurationCustomerOrgAuditLogSettings
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    defaultToSamlLogin Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    hasOrgs Boolean
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    maxNumOrgsUsersCanBeIn Double
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    orgsCanRequire2fa Boolean
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsCanSetupSaml Boolean
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsMetaname String
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    skipSamlRoleMappingStep Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    useOrgNameForSaml Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    usersCanCreateOrgs Boolean
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    usersCanDeleteTheirOwnOrgs Boolean
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    usersMustBeInAnOrganization Boolean
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    customerOrgAuditLogSettings OrganizationConfigurationCustomerOrgAuditLogSettings
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    defaultToSamlLogin boolean
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    hasOrgs boolean
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    maxNumOrgsUsersCanBeIn number
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    orgsCanRequire2fa boolean
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsCanSetupSaml boolean
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsMetaname string
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    skipSamlRoleMappingStep boolean
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    useOrgNameForSaml boolean
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    usersCanCreateOrgs boolean
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    usersCanDeleteTheirOwnOrgs boolean
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    usersMustBeInAnOrganization boolean
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    customer_org_audit_log_settings OrganizationConfigurationCustomerOrgAuditLogSettingsArgs
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    default_to_saml_login bool
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    has_orgs bool
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    max_num_orgs_users_can_be_in float
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    orgs_can_require2fa bool
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    orgs_can_setup_saml bool
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    orgs_metaname str
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    skip_saml_role_mapping_step bool
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    use_org_name_for_saml bool
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    users_can_create_orgs bool
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    users_can_delete_their_own_orgs bool
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    users_must_be_in_an_organization bool
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.
    customerOrgAuditLogSettings Property Map
    Settings for enabling whether and configuring how your customer organizations will have access to their own audit log.
    defaultToSamlLogin Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, affected users will be directed to SAML by default in the hosted pages.The default setting is false.
    hasOrgs Boolean
    This is the top level setting for whether organizations are in your PropelAuth integration.If false, all other organization settings are ignored. The default setting is true.
    maxNumOrgsUsersCanBeIn Number
    This is the maximum number of organizations a user can be a member of. If a user tries to exceed this number, they will be asked to leave an existing organization. The default setting is 10.
    orgsCanRequire2fa Boolean
    If true, organizations can require their users to use 2FA.The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsCanSetupSaml Boolean
    If true, your users can setup a SAML connection for their organization. This allows them to log into your product using their existing work account managed by an Identity Provider like Okta, Azure/Entra, Google, and more. The default setting is false. Warning: This is only applied in prod for some billing plans
    orgsMetaname String
    What name do you use for organizations? This will update the copy across your hosted pages.The default setting is 'Organization'.
    skipSamlRoleMappingStep Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, end users setting up SAML for their organization will not see the role-mapping step. The default setting is false.
    useOrgNameForSaml Boolean
    This is an advanced setting that only applies if SAML is enabled. If true, users can look up and be redirected to their SSO provider using their organization's name.The default setting is false which means the SAML provider is instead inferred from their email address.
    usersCanCreateOrgs Boolean
    If true, users have access to the 'Create Org' UI, allowing them to create their own organizations.The default setting is true.
    usersCanDeleteTheirOwnOrgs Boolean
    If true, users with the requisite permission will be able to delete their organizations. The default setting is false.
    usersMustBeInAnOrganization Boolean
    If true, users will be required to create or join an organization as part of the signup process. The default setting is false.

    Supporting Types

    OrganizationConfigurationCustomerOrgAuditLogSettings, OrganizationConfigurationCustomerOrgAuditLogSettingsArgs

    AllOrgsCanViewTheirAuditLog bool
    If true, all of your customer organization will automatically have access to this feature. Otherwise, you will need to enable it for each organization individually.
    Enabled bool
    If enabled, your customer organizations will have access to their own audit log.
    IncludeApiKeyActions bool
    If true, the audit log will include actions that were triggered by your BE service utilizing PropelAuth APIs.
    IncludeEmployeeActions bool
    If true, the audit log will include actions that were triggered by a member of your team using the PropelAuth dashboard. The person who triggered the action will be anonymous to your customer.
    IncludeImpersonation bool
    If true, the audit log will include actions that were triggered by a member of your team impersonating one of their organization members. The impersonator will be anonymous to your customer.
    AllOrgsCanViewTheirAuditLog bool
    If true, all of your customer organization will automatically have access to this feature. Otherwise, you will need to enable it for each organization individually.
    Enabled bool
    If enabled, your customer organizations will have access to their own audit log.
    IncludeApiKeyActions bool
    If true, the audit log will include actions that were triggered by your BE service utilizing PropelAuth APIs.
    IncludeEmployeeActions bool
    If true, the audit log will include actions that were triggered by a member of your team using the PropelAuth dashboard. The person who triggered the action will be anonymous to your customer.
    IncludeImpersonation bool
    If true, the audit log will include actions that were triggered by a member of your team impersonating one of their organization members. The impersonator will be anonymous to your customer.
    allOrgsCanViewTheirAuditLog Boolean
    If true, all of your customer organization will automatically have access to this feature. Otherwise, you will need to enable it for each organization individually.
    enabled Boolean
    If enabled, your customer organizations will have access to their own audit log.
    includeApiKeyActions Boolean
    If true, the audit log will include actions that were triggered by your BE service utilizing PropelAuth APIs.
    includeEmployeeActions Boolean
    If true, the audit log will include actions that were triggered by a member of your team using the PropelAuth dashboard. The person who triggered the action will be anonymous to your customer.
    includeImpersonation Boolean
    If true, the audit log will include actions that were triggered by a member of your team impersonating one of their organization members. The impersonator will be anonymous to your customer.
    allOrgsCanViewTheirAuditLog boolean
    If true, all of your customer organization will automatically have access to this feature. Otherwise, you will need to enable it for each organization individually.
    enabled boolean
    If enabled, your customer organizations will have access to their own audit log.
    includeApiKeyActions boolean
    If true, the audit log will include actions that were triggered by your BE service utilizing PropelAuth APIs.
    includeEmployeeActions boolean
    If true, the audit log will include actions that were triggered by a member of your team using the PropelAuth dashboard. The person who triggered the action will be anonymous to your customer.
    includeImpersonation boolean
    If true, the audit log will include actions that were triggered by a member of your team impersonating one of their organization members. The impersonator will be anonymous to your customer.
    all_orgs_can_view_their_audit_log bool
    If true, all of your customer organization will automatically have access to this feature. Otherwise, you will need to enable it for each organization individually.
    enabled bool
    If enabled, your customer organizations will have access to their own audit log.
    include_api_key_actions bool
    If true, the audit log will include actions that were triggered by your BE service utilizing PropelAuth APIs.
    include_employee_actions bool
    If true, the audit log will include actions that were triggered by a member of your team using the PropelAuth dashboard. The person who triggered the action will be anonymous to your customer.
    include_impersonation bool
    If true, the audit log will include actions that were triggered by a member of your team impersonating one of their organization members. The impersonator will be anonymous to your customer.
    allOrgsCanViewTheirAuditLog Boolean
    If true, all of your customer organization will automatically have access to this feature. Otherwise, you will need to enable it for each organization individually.
    enabled Boolean
    If enabled, your customer organizations will have access to their own audit log.
    includeApiKeyActions Boolean
    If true, the audit log will include actions that were triggered by your BE service utilizing PropelAuth APIs.
    includeEmployeeActions Boolean
    If true, the audit log will include actions that were triggered by a member of your team using the PropelAuth dashboard. The person who triggered the action will be anonymous to your customer.
    includeImpersonation Boolean
    If true, the audit log will include actions that were triggered by a member of your team impersonating one of their organization members. The impersonator will be anonymous to your customer.

    Import

    As there is only one organization_configuration per project there’s no need to specify the id,

    $ pulumi import propelauth:index/organizationConfiguration:OrganizationConfiguration but requires an id to be specified, so we can use an arbitrary string here.

    $ pulumi import propelauth:index/organizationConfiguration:OrganizationConfiguration example arbitrary_string_here

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    propelauth propelauth/terraform-provider-propelauth
    License
    Notes
    This Pulumi package is based on the propelauth Terraform Provider.
    propelauth logo
    propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
    propelauth/terraform-provider-propelauth