MongoDB Atlas v3.14.2 published on Monday, Mar 18, 2024 by Pulumi
mongodbatlas.getFederatedSettingsOrgConfig
Explore with Pulumi AI
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:
- Federation
Settings stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- Org
Id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- Federation
Settings stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- Org
Id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- federation
Settings StringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- org
Id String - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- federation
Settings stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- org
Id string - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
- federation_
settings_ strid - 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.
- federation
Settings StringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- org
Id String - Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
getFederatedSettingsOrgConfig Result
The following output properties are available:
- Domain
Allow List<string>Lists - 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 boolEnabled - Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when
domain_restriction_enabled
is false. - Federation
Settings stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identity
Provider stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- Org
Id string - Post
Auth List<string>Role Grants - List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
- Role
Mappings List<GetFederated Settings Org Config Role Mapping> - User
Conflicts List<GetFederated Settings Org Config User Conflict>
- Domain
Allow []stringLists - 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 boolEnabled - Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when
domain_restriction_enabled
is false. - Federation
Settings stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- Id string
- The provider-assigned unique ID for this managed resource.
- Identity
Provider stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- Org
Id string - Post
Auth []stringRole Grants - List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
- Role
Mappings []GetFederated Settings Org Config Role Mapping - User
Conflicts []GetFederated Settings Org Config User Conflict
- domain
Allow List<String>Lists - 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 BooleanEnabled - Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when
domain_restriction_enabled
is false. - federation
Settings StringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- id String
- The provider-assigned unique ID for this managed resource.
- identity
Provider StringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- org
Id String - post
Auth List<String>Role Grants - List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
- role
Mappings List<GetFederated Settings Org Config Role Mapping> - user
Conflicts List<GetFederated Settings Org Config User Conflict>
- domain
Allow string[]Lists - 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 booleanEnabled - Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when
domain_restriction_enabled
is false. - federation
Settings stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- id string
- The provider-assigned unique ID for this managed resource.
- identity
Provider stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- org
Id string - post
Auth string[]Role Grants - List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
- role
Mappings GetFederated Settings Org Config Role Mapping[] - user
Conflicts GetFederated Settings Org Config User Conflict[]
- domain_
allow_ Sequence[str]lists - 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_ boolenabled - Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when
domain_restriction_enabled
is false. - federation_
settings_ strid - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- id str
- The provider-assigned unique ID for this managed resource.
- identity_
provider_ strid - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- org_
id str - post_
auth_ Sequence[str]role_ grants - List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
- role_
mappings Sequence[GetFederated Settings Org Config Role Mapping] - user_
conflicts Sequence[GetFederated Settings Org Config User Conflict]
- domain
Allow List<String>Lists - 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 BooleanEnabled - Flag that indicates whether domain restriction is enabled for the connected organization. User Conflicts returns null when
domain_restriction_enabled
is false. - federation
Settings StringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- id String
- The provider-assigned unique ID for this managed resource.
- identity
Provider StringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- org
Id String - post
Auth List<String>Role Grants - List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
- role
Mappings List<Property Map> - user
Conflicts List<Property Map>
Supporting Types
GetFederatedSettingsOrgConfigRoleMapping
- External
Group stringName - 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.
- Role
Assignments List<GetFederated Settings Org Config Role Mapping Role Assignment> - Atlas roles and the unique identifiers of the groups and organizations associated with each role.
- External
Group stringName - 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.
- Role
Assignments []GetFederated Settings Org Config Role Mapping Role Assignment - Atlas roles and the unique identifiers of the groups and organizations associated with each role.
- external
Group StringName - 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.
- role
Assignments List<GetFederated Settings Org Config Role Mapping Role Assignment> - Atlas roles and the unique identifiers of the groups and organizations associated with each role.
- external
Group stringName - 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.
- role
Assignments GetFederated Settings Org Config Role Mapping Role Assignment[] - Atlas roles and the unique identifiers of the groups and organizations associated with each role.
- external_
group_ strname - 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[GetFederated Settings Org Config Role Mapping Role Assignment] - Atlas roles and the unique identifiers of the groups and organizations associated with each role.
- external
Group StringName - 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.
- role
Assignments List<Property Map> - Atlas roles and the unique identifiers of the groups and organizations associated with each role.
GetFederatedSettingsOrgConfigRoleMappingRoleAssignment
GetFederatedSettingsOrgConfigUserConflict
- Email
Address string - Email address of the the user that conflicts with selected domains.
- Federation
Settings stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- First
Name string - First name of the the user that conflicts with selected domains.
- Last
Name string - Last name of the the user that conflicts with selected domains.
- User
Id string - Name of the Atlas user that conflicts with selected domains.
- Email
Address string - Email address of the the user that conflicts with selected domains.
- Federation
Settings stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- First
Name string - First name of the the user that conflicts with selected domains.
- Last
Name string - Last name of the the user that conflicts with selected domains.
- User
Id string - Name of the Atlas user that conflicts with selected domains.
- email
Address String - Email address of the the user that conflicts with selected domains.
- federation
Settings StringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- first
Name String - First name of the the user that conflicts with selected domains.
- last
Name String - Last name of the the user that conflicts with selected domains.
- user
Id String - Name of the Atlas user that conflicts with selected domains.
- email
Address string - Email address of the the user that conflicts with selected domains.
- federation
Settings stringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- first
Name string - First name of the the user that conflicts with selected domains.
- last
Name string - Last name of the the user that conflicts with selected domains.
- user
Id 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_ strid - 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.
- email
Address String - Email address of the the user that conflicts with selected domains.
- federation
Settings StringId - Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
- first
Name String - First name of the the user that conflicts with selected domains.
- last
Name String - Last name of the the user that conflicts with selected domains.
- user
Id 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.