1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getFederatedSettingsOrgConfigs
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi

mongodbatlas.getFederatedSettingsOrgConfigs

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.14.3 published on Monday, Apr 1, 2024 by Pulumi

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

    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.getFederatedSettingsOrgConfigsOutput({
        federationSettingsId: orgConnections.id,
    });
    
    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_configs_output(federation_settings_id=org_connections.id)
    
    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.LookupFederatedSettingsOrgConfigsOutput(ctx, mongodbatlas.GetFederatedSettingsOrgConfigsOutputArgs{
    			FederationSettingsId: orgConnections.ID(),
    		}, 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.GetFederatedSettingsOrgConfigs.Invoke(new()
        {
            FederationSettingsId = orgConnections.Id,
        });
    
    });
    
    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.GetFederatedSettingsOrgConfigsArgs;
    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.getFederatedSettingsOrgConfigs(GetFederatedSettingsOrgConfigsArgs.builder()
                .federationSettingsId(orgConnections.id())
                .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:getFederatedSettingsOrgConfigs
          Arguments:
            federationSettingsId: ${orgConnections.id}
    

    Using getFederatedSettingsOrgConfigs

    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 getFederatedSettingsOrgConfigs(args: GetFederatedSettingsOrgConfigsArgs, opts?: InvokeOptions): Promise<GetFederatedSettingsOrgConfigsResult>
    function getFederatedSettingsOrgConfigsOutput(args: GetFederatedSettingsOrgConfigsOutputArgs, opts?: InvokeOptions): Output<GetFederatedSettingsOrgConfigsResult>
    def get_federated_settings_org_configs(federation_settings_id: Optional[str] = None,
                                           items_per_page: Optional[int] = None,
                                           page_num: Optional[int] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetFederatedSettingsOrgConfigsResult
    def get_federated_settings_org_configs_output(federation_settings_id: Optional[pulumi.Input[str]] = None,
                                           items_per_page: Optional[pulumi.Input[int]] = None,
                                           page_num: Optional[pulumi.Input[int]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetFederatedSettingsOrgConfigsResult]
    func LookupFederatedSettingsOrgConfigs(ctx *Context, args *LookupFederatedSettingsOrgConfigsArgs, opts ...InvokeOption) (*LookupFederatedSettingsOrgConfigsResult, error)
    func LookupFederatedSettingsOrgConfigsOutput(ctx *Context, args *LookupFederatedSettingsOrgConfigsOutputArgs, opts ...InvokeOption) LookupFederatedSettingsOrgConfigsResultOutput

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

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

    The following arguments are supported:

    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    ItemsPerPage int
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    PageNum int
    The page to return. Defaults to 1.
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    ItemsPerPage int
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    PageNum int
    The page to return. Defaults to 1.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    itemsPerPage Integer
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    pageNum Integer
    The page to return. Defaults to 1.
    federationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    itemsPerPage number
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    pageNum number
    The page to return. Defaults to 1.
    federation_settings_id str
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    items_per_page int
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    page_num int
    The page to return. Defaults to 1.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    itemsPerPage Number
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    pageNum Number
    The page to return. Defaults to 1.

    getFederatedSettingsOrgConfigs Result

    The following output properties are available:

    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetFederatedSettingsOrgConfigsResult>
    Includes cloudProviderSnapshot object for each item detailed in the results array section.
    ItemsPerPage int
    PageNum int
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetFederatedSettingsOrgConfigsResult
    Includes cloudProviderSnapshot object for each item detailed in the results array section.
    ItemsPerPage int
    PageNum int
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetFederatedSettingsOrgConfigsResult>
    Includes cloudProviderSnapshot object for each item detailed in the results array section.
    itemsPerPage Integer
    pageNum Integer
    federationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    id string
    The provider-assigned unique ID for this managed resource.
    results GetFederatedSettingsOrgConfigsResult[]
    Includes cloudProviderSnapshot object for each item detailed in the results array section.
    itemsPerPage number
    pageNum number
    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.
    results Sequence[GetFederatedSettingsOrgConfigsResult]
    Includes cloudProviderSnapshot object for each item detailed in the results array section.
    items_per_page int
    page_num int
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    Includes cloudProviderSnapshot object for each item detailed in the results array section.
    itemsPerPage Number
    pageNum Number

    Supporting Types

    GetFederatedSettingsOrgConfigsResult

    DomainAllowLists List<string>
    List that contains the approved domains from which organization users can log in.
    DomainRestrictionEnabled bool
    Flag that indicates whether domain restriction is enabled for the connected organization.
    IdentityProviderId 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.
    PostAuthRoleGrants List<string>
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    RoleMappings List<GetFederatedSettingsOrgConfigsResultRoleMapping>
    UserConflicts List<GetFederatedSettingsOrgConfigsResultUserConflict>
    DomainAllowLists []string
    List that contains the approved domains from which organization users can log in.
    DomainRestrictionEnabled bool
    Flag that indicates whether domain restriction is enabled for the connected organization.
    IdentityProviderId 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.
    PostAuthRoleGrants []string
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    RoleMappings []GetFederatedSettingsOrgConfigsResultRoleMapping
    UserConflicts []GetFederatedSettingsOrgConfigsResultUserConflict
    domainAllowLists List<String>
    List that contains the approved domains from which organization users can log in.
    domainRestrictionEnabled Boolean
    Flag that indicates whether domain restriction is enabled for the connected organization.
    identityProviderId 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.
    postAuthRoleGrants List<String>
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    roleMappings List<GetFederatedSettingsOrgConfigsResultRoleMapping>
    userConflicts List<GetFederatedSettingsOrgConfigsResultUserConflict>
    domainAllowLists string[]
    List that contains the approved domains from which organization users can log in.
    domainRestrictionEnabled boolean
    Flag that indicates whether domain restriction is enabled for the connected organization.
    identityProviderId 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.
    postAuthRoleGrants string[]
    List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
    roleMappings GetFederatedSettingsOrgConfigsResultRoleMapping[]
    userConflicts GetFederatedSettingsOrgConfigsResultUserConflict[]
    domain_allow_lists Sequence[str]
    List that contains the approved domains from which organization users can log in.
    domain_restriction_enabled bool
    Flag that indicates whether domain restriction is enabled for the connected organization.
    identity_provider_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.
    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[GetFederatedSettingsOrgConfigsResultRoleMapping]
    user_conflicts Sequence[GetFederatedSettingsOrgConfigsResultUserConflict]
    domainAllowLists List<String>
    List that contains the approved domains from which organization users can log in.
    domainRestrictionEnabled Boolean
    Flag that indicates whether domain restriction is enabled for the connected organization.
    identityProviderId 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.
    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>

    GetFederatedSettingsOrgConfigsResultRoleMapping

    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<GetFederatedSettingsOrgConfigsResultRoleMappingRoleAssignment>
    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 []GetFederatedSettingsOrgConfigsResultRoleMappingRoleAssignment
    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<GetFederatedSettingsOrgConfigsResultRoleMappingRoleAssignment>
    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 GetFederatedSettingsOrgConfigsResultRoleMappingRoleAssignment[]
    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[GetFederatedSettingsOrgConfigsResultRoleMappingRoleAssignment]
    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.

    GetFederatedSettingsOrgConfigsResultRoleMappingRoleAssignment

    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.

    GetFederatedSettingsOrgConfigsResultUserConflict

    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.3 published on Monday, Apr 1, 2024 by Pulumi