1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getFederatedSettingsOrgConfig
MongoDB Atlas v3.14.2 published on Monday, Mar 18, 2024 by Pulumi

mongodbatlas.getFederatedSettingsOrgConfig

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.2 published on Monday, Mar 18, 2024 by Pulumi

    mongodbatlas.FederatedSettingsOrgConfig provides an Federated Settings Identity Providers datasource. Atlas Cloud Federated Settings Organizational configuration provides federated settings outputs for the configured Organizational configuration.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as mongodbatlas from "@pulumi/mongodbatlas";
    
    const orgConnections = new mongodbatlas.FederatedSettingsOrgConfig("orgConnections", {
        federationSettingsId: "627a9687f7f7f7f774de306f14",
        orgId: "627a9683ea7ff7f74de306f14",
        domainRestrictionEnabled: false,
        domainAllowLists: ["mydomain.com"],
        postAuthRoleGrants: ["ORG_MEMBER"],
    });
    const orgConfigsDs = mongodbatlas.getFederatedSettingsOrgConfigOutput({
        federationSettingsId: orgConnections.id,
        orgId: "627a9683ea7ff7f74de306f14",
    });
    
    import pulumi
    import pulumi_mongodbatlas as mongodbatlas
    
    org_connections = mongodbatlas.FederatedSettingsOrgConfig("orgConnections",
        federation_settings_id="627a9687f7f7f7f774de306f14",
        org_id="627a9683ea7ff7f74de306f14",
        domain_restriction_enabled=False,
        domain_allow_lists=["mydomain.com"],
        post_auth_role_grants=["ORG_MEMBER"])
    org_configs_ds = mongodbatlas.get_federated_settings_org_config_output(federation_settings_id=org_connections.id,
        org_id="627a9683ea7ff7f74de306f14")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-mongodbatlas/sdk/v3/go/mongodbatlas"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		orgConnections, err := mongodbatlas.NewFederatedSettingsOrgConfig(ctx, "orgConnections", &mongodbatlas.FederatedSettingsOrgConfigArgs{
    			FederationSettingsId:     pulumi.String("627a9687f7f7f7f774de306f14"),
    			OrgId:                    pulumi.String("627a9683ea7ff7f74de306f14"),
    			DomainRestrictionEnabled: pulumi.Bool(false),
    			DomainAllowLists: pulumi.StringArray{
    				pulumi.String("mydomain.com"),
    			},
    			PostAuthRoleGrants: pulumi.StringArray{
    				pulumi.String("ORG_MEMBER"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_ = mongodbatlas.LookupFederatedSettingsOrgConfigOutput(ctx, mongodbatlas.GetFederatedSettingsOrgConfigOutputArgs{
    			FederationSettingsId: orgConnections.ID(),
    			OrgId:                pulumi.String("627a9683ea7ff7f74de306f14"),
    		}, nil)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Mongodbatlas = Pulumi.Mongodbatlas;
    
    return await Deployment.RunAsync(() => 
    {
        var orgConnections = new Mongodbatlas.FederatedSettingsOrgConfig("orgConnections", new()
        {
            FederationSettingsId = "627a9687f7f7f7f774de306f14",
            OrgId = "627a9683ea7ff7f74de306f14",
            DomainRestrictionEnabled = false,
            DomainAllowLists = new[]
            {
                "mydomain.com",
            },
            PostAuthRoleGrants = new[]
            {
                "ORG_MEMBER",
            },
        });
    
        var orgConfigsDs = Mongodbatlas.GetFederatedSettingsOrgConfig.Invoke(new()
        {
            FederationSettingsId = orgConnections.Id,
            OrgId = "627a9683ea7ff7f74de306f14",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mongodbatlas.FederatedSettingsOrgConfig;
    import com.pulumi.mongodbatlas.FederatedSettingsOrgConfigArgs;
    import com.pulumi.mongodbatlas.MongodbatlasFunctions;
    import com.pulumi.mongodbatlas.inputs.GetFederatedSettingsOrgConfigArgs;
    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) {
            var orgConnections = new FederatedSettingsOrgConfig("orgConnections", FederatedSettingsOrgConfigArgs.builder()        
                .federationSettingsId("627a9687f7f7f7f774de306f14")
                .orgId("627a9683ea7ff7f74de306f14")
                .domainRestrictionEnabled(false)
                .domainAllowLists("mydomain.com")
                .postAuthRoleGrants("ORG_MEMBER")
                .build());
    
            final var orgConfigsDs = MongodbatlasFunctions.getFederatedSettingsOrgConfig(GetFederatedSettingsOrgConfigArgs.builder()
                .federationSettingsId(orgConnections.id())
                .orgId("627a9683ea7ff7f74de306f14")
                .build());
    
        }
    }
    
    resources:
      orgConnections:
        type: mongodbatlas:FederatedSettingsOrgConfig
        properties:
          federationSettingsId: 627a9687f7f7f7f774de306f14
          orgId: 627a9683ea7ff7f74de306f14
          domainRestrictionEnabled: false
          domainAllowLists:
            - mydomain.com
          postAuthRoleGrants:
            - ORG_MEMBER
    variables:
      orgConfigsDs:
        fn::invoke:
          Function: mongodbatlas:getFederatedSettingsOrgConfig
          Arguments:
            federationSettingsId: ${orgConnections.id}
            orgId: 627a9683ea7ff7f74de306f14
    

    Using getFederatedSettingsOrgConfig

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFederatedSettingsOrgConfig(args: GetFederatedSettingsOrgConfigArgs, opts?: InvokeOptions): Promise<GetFederatedSettingsOrgConfigResult>
    function getFederatedSettingsOrgConfigOutput(args: GetFederatedSettingsOrgConfigOutputArgs, opts?: InvokeOptions): Output<GetFederatedSettingsOrgConfigResult>
    def get_federated_settings_org_config(federation_settings_id: Optional[str] = None,
                                          org_id: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetFederatedSettingsOrgConfigResult
    def get_federated_settings_org_config_output(federation_settings_id: Optional[pulumi.Input[str]] = None,
                                          org_id: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetFederatedSettingsOrgConfigResult]
    func LookupFederatedSettingsOrgConfig(ctx *Context, args *LookupFederatedSettingsOrgConfigArgs, opts ...InvokeOption) (*LookupFederatedSettingsOrgConfigResult, error)
    func LookupFederatedSettingsOrgConfigOutput(ctx *Context, args *LookupFederatedSettingsOrgConfigOutputArgs, opts ...InvokeOption) LookupFederatedSettingsOrgConfigResultOutput

    > Note: This function is named LookupFederatedSettingsOrgConfig in the Go SDK.

    public static class GetFederatedSettingsOrgConfig 
    {
        public static Task<GetFederatedSettingsOrgConfigResult> InvokeAsync(GetFederatedSettingsOrgConfigArgs args, InvokeOptions? opts = null)
        public static Output<GetFederatedSettingsOrgConfigResult> Invoke(GetFederatedSettingsOrgConfigInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFederatedSettingsOrgConfigResult> getFederatedSettingsOrgConfig(GetFederatedSettingsOrgConfigArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: mongodbatlas:index/getFederatedSettingsOrgConfig:getFederatedSettingsOrgConfig
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    federationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    orgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    federation_settings_id str
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    org_id str
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

    getFederatedSettingsOrgConfig Result

    The following output properties are available:

    DomainAllowLists List<string>
    List that contains the approved domains from which organization users can log in. Note: If the organization uses an identity provider, domain_allow_list includes: any SSO domains associated with organization's identity provider and any custom domains associated with the specific organization.
    DomainRestrictionEnabled bool
    Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when domain_restriction_enabled is false.
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    OrgId string
    PostAuthRoleGrants List<string>
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    RoleMappings List<GetFederatedSettingsOrgConfigRoleMapping>
    UserConflicts List<GetFederatedSettingsOrgConfigUserConflict>
    DomainAllowLists []string
    List that contains the approved domains from which organization users can log in. Note: If the organization uses an identity provider, domain_allow_list includes: any SSO domains associated with organization's identity provider and any custom domains associated with the specific organization.
    DomainRestrictionEnabled bool
    Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when domain_restriction_enabled is false.
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    OrgId string
    PostAuthRoleGrants []string
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    RoleMappings []GetFederatedSettingsOrgConfigRoleMapping
    UserConflicts []GetFederatedSettingsOrgConfigUserConflict
    domainAllowLists List<String>
    List that contains the approved domains from which organization users can log in. Note: If the organization uses an identity provider, domain_allow_list includes: any SSO domains associated with organization's identity provider and any custom domains associated with the specific organization.
    domainRestrictionEnabled Boolean
    Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when domain_restriction_enabled is false.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    orgId String
    postAuthRoleGrants List<String>
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    roleMappings List<GetFederatedSettingsOrgConfigRoleMapping>
    userConflicts List<GetFederatedSettingsOrgConfigUserConflict>
    domainAllowLists string[]
    List that contains the approved domains from which organization users can log in. Note: If the organization uses an identity provider, domain_allow_list includes: any SSO domains associated with organization's identity provider and any custom domains associated with the specific organization.
    domainRestrictionEnabled boolean
    Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when domain_restriction_enabled is false.
    federationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    id string
    The provider-assigned unique ID for this managed resource.
    identityProviderId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    orgId string
    postAuthRoleGrants string[]
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    roleMappings GetFederatedSettingsOrgConfigRoleMapping[]
    userConflicts GetFederatedSettingsOrgConfigUserConflict[]
    domain_allow_lists Sequence[str]
    List that contains the approved domains from which organization users can log in. Note: If the organization uses an identity provider, domain_allow_list includes: any SSO domains associated with organization's identity provider and any custom domains associated with the specific organization.
    domain_restriction_enabled bool
    Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when domain_restriction_enabled is false.
    federation_settings_id str
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    id str
    The provider-assigned unique ID for this managed resource.
    identity_provider_id str
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    org_id str
    post_auth_role_grants Sequence[str]
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    role_mappings Sequence[GetFederatedSettingsOrgConfigRoleMapping]
    user_conflicts Sequence[GetFederatedSettingsOrgConfigUserConflict]
    domainAllowLists List<String>
    List that contains the approved domains from which organization users can log in. Note: If the organization uses an identity provider, domain_allow_list includes: any SSO domains associated with organization's identity provider and any custom domains associated with the specific organization.
    domainRestrictionEnabled Boolean
    Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when domain_restriction_enabled is false.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    orgId String
    postAuthRoleGrants List<String>
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    roleMappings List<Property Map>
    userConflicts List<Property Map>

    Supporting Types

    GetFederatedSettingsOrgConfigRoleMapping

    ExternalGroupName string
    Unique human-readable label that identifies the identity provider group to which this role mapping applies.
    Id string
    Unique 24-hexadecimal digit string that identifies this role mapping.
    RoleAssignments List<GetFederatedSettingsOrgConfigRoleMappingRoleAssignment>
    Atlas roles and the unique identifiers of the groups and organizations associated with each role.
    ExternalGroupName string
    Unique human-readable label that identifies the identity provider group to which this role mapping applies.
    Id string
    Unique 24-hexadecimal digit string that identifies this role mapping.
    RoleAssignments []GetFederatedSettingsOrgConfigRoleMappingRoleAssignment
    Atlas roles and the unique identifiers of the groups and organizations associated with each role.
    externalGroupName String
    Unique human-readable label that identifies the identity provider group to which this role mapping applies.
    id String
    Unique 24-hexadecimal digit string that identifies this role mapping.
    roleAssignments List<GetFederatedSettingsOrgConfigRoleMappingRoleAssignment>
    Atlas roles and the unique identifiers of the groups and organizations associated with each role.
    externalGroupName string
    Unique human-readable label that identifies the identity provider group to which this role mapping applies.
    id string
    Unique 24-hexadecimal digit string that identifies this role mapping.
    roleAssignments GetFederatedSettingsOrgConfigRoleMappingRoleAssignment[]
    Atlas roles and the unique identifiers of the groups and organizations associated with each role.
    external_group_name str
    Unique human-readable label that identifies the identity provider group to which this role mapping applies.
    id str
    Unique 24-hexadecimal digit string that identifies this role mapping.
    role_assignments Sequence[GetFederatedSettingsOrgConfigRoleMappingRoleAssignment]
    Atlas roles and the unique identifiers of the groups and organizations associated with each role.
    externalGroupName String
    Unique human-readable label that identifies the identity provider group to which this role mapping applies.
    id String
    Unique 24-hexadecimal digit string that identifies this role mapping.
    roleAssignments List<Property Map>
    Atlas roles and the unique identifiers of the groups and organizations associated with each role.

    GetFederatedSettingsOrgConfigRoleMappingRoleAssignment

    GroupId string
    Unique identifier of the project to which you want the role mapping to apply.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    Role string
    Specifies the Role that is attached to the Role Mapping.
    GroupId string
    Unique identifier of the project to which you want the role mapping to apply.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    Role string
    Specifies the Role that is attached to the Role Mapping.
    groupId String
    Unique identifier of the project to which you want the role mapping to apply.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    role String
    Specifies the Role that is attached to the Role Mapping.
    groupId string
    Unique identifier of the project to which you want the role mapping to apply.
    orgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    role string
    Specifies the Role that is attached to the Role Mapping.
    group_id str
    Unique identifier of the project to which you want the role mapping to apply.
    org_id str
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    role str
    Specifies the Role that is attached to the Role Mapping.
    groupId String
    Unique identifier of the project to which you want the role mapping to apply.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    role String
    Specifies the Role that is attached to the Role Mapping.

    GetFederatedSettingsOrgConfigUserConflict

    EmailAddress string
    Email address of the the user that conflicts with selected domains.
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    FirstName string
    First name of the the user that conflicts with selected domains.
    LastName string
    Last name of the the user that conflicts with selected domains.
    UserId string
    Name of the Atlas user that conflicts with selected domains.
    EmailAddress string
    Email address of the the user that conflicts with selected domains.
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    FirstName string
    First name of the the user that conflicts with selected domains.
    LastName string
    Last name of the the user that conflicts with selected domains.
    UserId string
    Name of the Atlas user that conflicts with selected domains.
    emailAddress String
    Email address of the the user that conflicts with selected domains.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    firstName String
    First name of the the user that conflicts with selected domains.
    lastName String
    Last name of the the user that conflicts with selected domains.
    userId String
    Name of the Atlas user that conflicts with selected domains.
    emailAddress string
    Email address of the the user that conflicts with selected domains.
    federationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    firstName string
    First name of the the user that conflicts with selected domains.
    lastName string
    Last name of the the user that conflicts with selected domains.
    userId string
    Name of the Atlas user that conflicts with selected domains.
    email_address str
    Email address of the the user that conflicts with selected domains.
    federation_settings_id str
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    first_name str
    First name of the the user that conflicts with selected domains.
    last_name str
    Last name of the the user that conflicts with selected domains.
    user_id str
    Name of the Atlas user that conflicts with selected domains.
    emailAddress String
    Email address of the the user that conflicts with selected domains.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    firstName String
    First name of the the user that conflicts with selected domains.
    lastName String
    Last name of the the user that conflicts with selected domains.
    userId String
    Name of the Atlas user that conflicts with selected domains.

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.14.2 published on Monday, Mar 18, 2024 by Pulumi