1. Packages
  2. Mongodbatlas Provider
  3. API Docs
  4. getFederatedSettingsIdentityProvider
MongoDB Atlas v3.30.0 published on Friday, Mar 21, 2025 by Pulumi

mongodbatlas.getFederatedSettingsIdentityProvider

Explore with Pulumi AI

# Data Source: mongodbatlas.FederatedSettingsIdentityProvider

mongodbatlas.FederatedSettingsIdentityProvider provides a federated settings identity provider data source. Atlas federated settings identity provider provides federated settings outputs for the configured identity provider.

Example Usage

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

const identityProvider = new mongodbatlas.FederatedSettingsIdentityProvider("identity_provider", {
    federationSettingsId: "627a9687f7f7f7f774de306f14",
    name: "mongodb_federation_test",
    associatedDomains: ["yourdomain.com"],
    ssoDebugEnabled: true,
    status: "ACTIVE",
    ssoUrl: "https://mysso.oktapreview.com/app/mysso_terraformtest_1/exk177f7f7f70h8/sso/saml",
    issuerUri: "http://www.okta.com/exk17f7f7f7f7p50h8",
    requestBinding: "HTTP-POST",
    responseSignatureAlgorithm: "SHA-256",
});
const identityProviderDs = mongodbatlas.getFederatedSettingsIdentityProviderOutput({
    federationSettingsId: identityProvider.id,
    identityProviderId: "0oad4fas87jL5Xnk12971234",
});
Copy
import pulumi
import pulumi_mongodbatlas as mongodbatlas

identity_provider = mongodbatlas.FederatedSettingsIdentityProvider("identity_provider",
    federation_settings_id="627a9687f7f7f7f774de306f14",
    name="mongodb_federation_test",
    associated_domains=["yourdomain.com"],
    sso_debug_enabled=True,
    status="ACTIVE",
    sso_url="https://mysso.oktapreview.com/app/mysso_terraformtest_1/exk177f7f7f70h8/sso/saml",
    issuer_uri="http://www.okta.com/exk17f7f7f7f7p50h8",
    request_binding="HTTP-POST",
    response_signature_algorithm="SHA-256")
identity_provider_ds = mongodbatlas.get_federated_settings_identity_provider_output(federation_settings_id=identity_provider.id,
    identity_provider_id="0oad4fas87jL5Xnk12971234")
Copy
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 {
		identityProvider, err := mongodbatlas.NewFederatedSettingsIdentityProvider(ctx, "identity_provider", &mongodbatlas.FederatedSettingsIdentityProviderArgs{
			FederationSettingsId: pulumi.String("627a9687f7f7f7f774de306f14"),
			Name:                 pulumi.String("mongodb_federation_test"),
			AssociatedDomains: pulumi.StringArray{
				pulumi.String("yourdomain.com"),
			},
			SsoDebugEnabled:            pulumi.Bool(true),
			Status:                     pulumi.String("ACTIVE"),
			SsoUrl:                     pulumi.String("https://mysso.oktapreview.com/app/mysso_terraformtest_1/exk177f7f7f70h8/sso/saml"),
			IssuerUri:                  pulumi.String("http://www.okta.com/exk17f7f7f7f7p50h8"),
			RequestBinding:             pulumi.String("HTTP-POST"),
			ResponseSignatureAlgorithm: pulumi.String("SHA-256"),
		})
		if err != nil {
			return err
		}
		_ = mongodbatlas.LookupFederatedSettingsIdentityProviderOutput(ctx, mongodbatlas.GetFederatedSettingsIdentityProviderOutputArgs{
			FederationSettingsId: identityProvider.ID(),
			IdentityProviderId:   pulumi.String("0oad4fas87jL5Xnk12971234"),
		}, nil)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

return await Deployment.RunAsync(() => 
{
    var identityProvider = new Mongodbatlas.FederatedSettingsIdentityProvider("identity_provider", new()
    {
        FederationSettingsId = "627a9687f7f7f7f774de306f14",
        Name = "mongodb_federation_test",
        AssociatedDomains = new[]
        {
            "yourdomain.com",
        },
        SsoDebugEnabled = true,
        Status = "ACTIVE",
        SsoUrl = "https://mysso.oktapreview.com/app/mysso_terraformtest_1/exk177f7f7f70h8/sso/saml",
        IssuerUri = "http://www.okta.com/exk17f7f7f7f7p50h8",
        RequestBinding = "HTTP-POST",
        ResponseSignatureAlgorithm = "SHA-256",
    });

    var identityProviderDs = Mongodbatlas.GetFederatedSettingsIdentityProvider.Invoke(new()
    {
        FederationSettingsId = identityProvider.Id,
        IdentityProviderId = "0oad4fas87jL5Xnk12971234",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mongodbatlas.FederatedSettingsIdentityProvider;
import com.pulumi.mongodbatlas.FederatedSettingsIdentityProviderArgs;
import com.pulumi.mongodbatlas.MongodbatlasFunctions;
import com.pulumi.mongodbatlas.inputs.GetFederatedSettingsIdentityProviderArgs;
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 identityProvider = new FederatedSettingsIdentityProvider("identityProvider", FederatedSettingsIdentityProviderArgs.builder()
            .federationSettingsId("627a9687f7f7f7f774de306f14")
            .name("mongodb_federation_test")
            .associatedDomains("yourdomain.com")
            .ssoDebugEnabled(true)
            .status("ACTIVE")
            .ssoUrl("https://mysso.oktapreview.com/app/mysso_terraformtest_1/exk177f7f7f70h8/sso/saml")
            .issuerUri("http://www.okta.com/exk17f7f7f7f7p50h8")
            .requestBinding("HTTP-POST")
            .responseSignatureAlgorithm("SHA-256")
            .build());

        final var identityProviderDs = MongodbatlasFunctions.getFederatedSettingsIdentityProvider(GetFederatedSettingsIdentityProviderArgs.builder()
            .federationSettingsId(identityProvider.id())
            .identityProviderId("0oad4fas87jL5Xnk12971234")
            .build());

    }
}
Copy
resources:
  identityProvider:
    type: mongodbatlas:FederatedSettingsIdentityProvider
    name: identity_provider
    properties:
      federationSettingsId: 627a9687f7f7f7f774de306f14
      name: mongodb_federation_test
      associatedDomains:
        - yourdomain.com
      ssoDebugEnabled: true
      status: ACTIVE
      ssoUrl: https://mysso.oktapreview.com/app/mysso_terraformtest_1/exk177f7f7f70h8/sso/saml
      issuerUri: http://www.okta.com/exk17f7f7f7f7p50h8
      requestBinding: HTTP-POST
      responseSignatureAlgorithm: SHA-256
variables:
  identityProviderDs:
    fn::invoke:
      function: mongodbatlas:getFederatedSettingsIdentityProvider
      arguments:
        federationSettingsId: ${identityProvider.id}
        identityProviderId: 0oad4fas87jL5Xnk12971234
Copy

Using getFederatedSettingsIdentityProvider

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 getFederatedSettingsIdentityProvider(args: GetFederatedSettingsIdentityProviderArgs, opts?: InvokeOptions): Promise<GetFederatedSettingsIdentityProviderResult>
function getFederatedSettingsIdentityProviderOutput(args: GetFederatedSettingsIdentityProviderOutputArgs, opts?: InvokeOptions): Output<GetFederatedSettingsIdentityProviderResult>
Copy
def get_federated_settings_identity_provider(federation_settings_id: Optional[str] = None,
                                             identity_provider_id: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetFederatedSettingsIdentityProviderResult
def get_federated_settings_identity_provider_output(federation_settings_id: Optional[pulumi.Input[str]] = None,
                                             identity_provider_id: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetFederatedSettingsIdentityProviderResult]
Copy
func LookupFederatedSettingsIdentityProvider(ctx *Context, args *LookupFederatedSettingsIdentityProviderArgs, opts ...InvokeOption) (*LookupFederatedSettingsIdentityProviderResult, error)
func LookupFederatedSettingsIdentityProviderOutput(ctx *Context, args *LookupFederatedSettingsIdentityProviderOutputArgs, opts ...InvokeOption) LookupFederatedSettingsIdentityProviderResultOutput
Copy

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

public static class GetFederatedSettingsIdentityProvider 
{
    public static Task<GetFederatedSettingsIdentityProviderResult> InvokeAsync(GetFederatedSettingsIdentityProviderArgs args, InvokeOptions? opts = null)
    public static Output<GetFederatedSettingsIdentityProviderResult> Invoke(GetFederatedSettingsIdentityProviderInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetFederatedSettingsIdentityProviderResult> getFederatedSettingsIdentityProvider(GetFederatedSettingsIdentityProviderArgs args, InvokeOptions options)
public static Output<GetFederatedSettingsIdentityProviderResult> getFederatedSettingsIdentityProvider(GetFederatedSettingsIdentityProviderArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mongodbatlas:index/getFederatedSettingsIdentityProvider:getFederatedSettingsIdentityProvider
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

FederationSettingsId This property is required. string
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
IdentityProviderId This property is required. string
Unique 24-hexadecimal digit string that identifies the IdP.
FederationSettingsId This property is required. string
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
IdentityProviderId This property is required. string
Unique 24-hexadecimal digit string that identifies the IdP.
federationSettingsId This property is required. String
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
identityProviderId This property is required. String
Unique 24-hexadecimal digit string that identifies the IdP.
federationSettingsId This property is required. string
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
identityProviderId This property is required. string
Unique 24-hexadecimal digit string that identifies the IdP.
federation_settings_id This property is required. str
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
identity_provider_id This property is required. str
Unique 24-hexadecimal digit string that identifies the IdP.
federationSettingsId This property is required. String
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
identityProviderId This property is required. String
Unique 24-hexadecimal digit string that identifies the IdP.

getFederatedSettingsIdentityProvider Result

The following output properties are available:

AcsUrl string
Assertion consumer service URL to which the IdP sends the SAML response.
AssociatedDomains List<string>
List that contains the configured domains from which users can log in for this IdP.
AssociatedOrgs List<GetFederatedSettingsIdentityProviderAssociatedOrg>
List that contains the organizations from which users can log in for this IdP.
Audience string
Identifier of the intended recipient of the token.
AudienceUri string
Identifier for the intended audience of the SAML Assertion.
AuthorizationType string
Indicates whether authorization is granted based on group membership or user ID. Valid values are GROUP or USER.
ClientId string
Client identifier that is assigned to an application by the Identity Provider.
Description string
The description of the identity provider.
DisplayName string
Human-readable label that identifies the IdP.
FederationSettingsId string
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
GroupsClaim string
Identifier of the claim which contains IdP Group IDs in the token.
Id string
The provider-assigned unique ID for this managed resource.
IdentityProviderId string
IdpId string
Unique 24-hexadecimal digit string that identifies the IdP
IdpType string
Type of the identity provider. Valid values are WORKFORCE or WORKLOAD.
IssuerUri string
Identifier for the issuer of the SAML Assertion.
OktaIdpId string
Unique 20-hexadecimal digit string that identifies the IdP.
PemFileInfos List<GetFederatedSettingsIdentityProviderPemFileInfo>
Protocol string
The protocol of the identity provider. Valid values are SAML or OIDC.
RequestBinding string
SAML Authentication Request Protocol binding used to send the AuthNRequest. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
RequestedScopes List<string>
Scopes that MongoDB applications will request from the authorization endpoint.
ResponseSignatureAlgorithm string
Algorithm used to encrypt the IdP signature. Atlas supports the following signature algorithm values:

  • SHA-1
  • SHA-256
SsoDebugEnabled bool
Flag that indicates whether the IdP has enabled Bypass SAML Mode. Enabling this mode generates a URL that allows you bypass SAML and login to your organizations at any point. You can authenticate with this special URL only when Bypass Mode is enabled. Set this parameter to true during testing. This keeps you from getting locked out of MongoDB.
SsoUrl string
URL of the receiver of the SAML AuthNRequest.
Status string
Label that indicates whether the identity provider is active. The IdP is Inactive until you map at least one domain to the IdP.
UserClaim string
Identifier of the claim which contains the user ID in the token.
AcsUrl string
Assertion consumer service URL to which the IdP sends the SAML response.
AssociatedDomains []string
List that contains the configured domains from which users can log in for this IdP.
AssociatedOrgs []GetFederatedSettingsIdentityProviderAssociatedOrg
List that contains the organizations from which users can log in for this IdP.
Audience string
Identifier of the intended recipient of the token.
AudienceUri string
Identifier for the intended audience of the SAML Assertion.
AuthorizationType string
Indicates whether authorization is granted based on group membership or user ID. Valid values are GROUP or USER.
ClientId string
Client identifier that is assigned to an application by the Identity Provider.
Description string
The description of the identity provider.
DisplayName string
Human-readable label that identifies the IdP.
FederationSettingsId string
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
GroupsClaim string
Identifier of the claim which contains IdP Group IDs in the token.
Id string
The provider-assigned unique ID for this managed resource.
IdentityProviderId string
IdpId string
Unique 24-hexadecimal digit string that identifies the IdP
IdpType string
Type of the identity provider. Valid values are WORKFORCE or WORKLOAD.
IssuerUri string
Identifier for the issuer of the SAML Assertion.
OktaIdpId string
Unique 20-hexadecimal digit string that identifies the IdP.
PemFileInfos []GetFederatedSettingsIdentityProviderPemFileInfo
Protocol string
The protocol of the identity provider. Valid values are SAML or OIDC.
RequestBinding string
SAML Authentication Request Protocol binding used to send the AuthNRequest. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
RequestedScopes []string
Scopes that MongoDB applications will request from the authorization endpoint.
ResponseSignatureAlgorithm string
Algorithm used to encrypt the IdP signature. Atlas supports the following signature algorithm values:

  • SHA-1
  • SHA-256
SsoDebugEnabled bool
Flag that indicates whether the IdP has enabled Bypass SAML Mode. Enabling this mode generates a URL that allows you bypass SAML and login to your organizations at any point. You can authenticate with this special URL only when Bypass Mode is enabled. Set this parameter to true during testing. This keeps you from getting locked out of MongoDB.
SsoUrl string
URL of the receiver of the SAML AuthNRequest.
Status string
Label that indicates whether the identity provider is active. The IdP is Inactive until you map at least one domain to the IdP.
UserClaim string
Identifier of the claim which contains the user ID in the token.
acsUrl String
Assertion consumer service URL to which the IdP sends the SAML response.
associatedDomains List<String>
List that contains the configured domains from which users can log in for this IdP.
associatedOrgs List<GetFederatedSettingsIdentityProviderAssociatedOrg>
List that contains the organizations from which users can log in for this IdP.
audience String
Identifier of the intended recipient of the token.
audienceUri String
Identifier for the intended audience of the SAML Assertion.
authorizationType String
Indicates whether authorization is granted based on group membership or user ID. Valid values are GROUP or USER.
clientId String
Client identifier that is assigned to an application by the Identity Provider.
description String
The description of the identity provider.
displayName String
Human-readable label that identifies the IdP.
federationSettingsId String
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
groupsClaim String
Identifier of the claim which contains IdP Group IDs in the token.
id String
The provider-assigned unique ID for this managed resource.
identityProviderId String
idpId String
Unique 24-hexadecimal digit string that identifies the IdP
idpType String
Type of the identity provider. Valid values are WORKFORCE or WORKLOAD.
issuerUri String
Identifier for the issuer of the SAML Assertion.
oktaIdpId String
Unique 20-hexadecimal digit string that identifies the IdP.
pemFileInfos List<GetFederatedSettingsIdentityProviderPemFileInfo>
protocol String
The protocol of the identity provider. Valid values are SAML or OIDC.
requestBinding String
SAML Authentication Request Protocol binding used to send the AuthNRequest. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
requestedScopes List<String>
Scopes that MongoDB applications will request from the authorization endpoint.
responseSignatureAlgorithm String
Algorithm used to encrypt the IdP signature. Atlas supports the following signature algorithm values:

  • SHA-1
  • SHA-256
ssoDebugEnabled Boolean
Flag that indicates whether the IdP has enabled Bypass SAML Mode. Enabling this mode generates a URL that allows you bypass SAML and login to your organizations at any point. You can authenticate with this special URL only when Bypass Mode is enabled. Set this parameter to true during testing. This keeps you from getting locked out of MongoDB.
ssoUrl String
URL of the receiver of the SAML AuthNRequest.
status String
Label that indicates whether the identity provider is active. The IdP is Inactive until you map at least one domain to the IdP.
userClaim String
Identifier of the claim which contains the user ID in the token.
acsUrl string
Assertion consumer service URL to which the IdP sends the SAML response.
associatedDomains string[]
List that contains the configured domains from which users can log in for this IdP.
associatedOrgs GetFederatedSettingsIdentityProviderAssociatedOrg[]
List that contains the organizations from which users can log in for this IdP.
audience string
Identifier of the intended recipient of the token.
audienceUri string
Identifier for the intended audience of the SAML Assertion.
authorizationType string
Indicates whether authorization is granted based on group membership or user ID. Valid values are GROUP or USER.
clientId string
Client identifier that is assigned to an application by the Identity Provider.
description string
The description of the identity provider.
displayName string
Human-readable label that identifies the IdP.
federationSettingsId string
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
groupsClaim string
Identifier of the claim which contains IdP Group IDs in the token.
id string
The provider-assigned unique ID for this managed resource.
identityProviderId string
idpId string
Unique 24-hexadecimal digit string that identifies the IdP
idpType string
Type of the identity provider. Valid values are WORKFORCE or WORKLOAD.
issuerUri string
Identifier for the issuer of the SAML Assertion.
oktaIdpId string
Unique 20-hexadecimal digit string that identifies the IdP.
pemFileInfos GetFederatedSettingsIdentityProviderPemFileInfo[]
protocol string
The protocol of the identity provider. Valid values are SAML or OIDC.
requestBinding string
SAML Authentication Request Protocol binding used to send the AuthNRequest. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
requestedScopes string[]
Scopes that MongoDB applications will request from the authorization endpoint.
responseSignatureAlgorithm string
Algorithm used to encrypt the IdP signature. Atlas supports the following signature algorithm values:

  • SHA-1
  • SHA-256
ssoDebugEnabled boolean
Flag that indicates whether the IdP has enabled Bypass SAML Mode. Enabling this mode generates a URL that allows you bypass SAML and login to your organizations at any point. You can authenticate with this special URL only when Bypass Mode is enabled. Set this parameter to true during testing. This keeps you from getting locked out of MongoDB.
ssoUrl string
URL of the receiver of the SAML AuthNRequest.
status string
Label that indicates whether the identity provider is active. The IdP is Inactive until you map at least one domain to the IdP.
userClaim string
Identifier of the claim which contains the user ID in the token.
acs_url str
Assertion consumer service URL to which the IdP sends the SAML response.
associated_domains Sequence[str]
List that contains the configured domains from which users can log in for this IdP.
associated_orgs Sequence[GetFederatedSettingsIdentityProviderAssociatedOrg]
List that contains the organizations from which users can log in for this IdP.
audience str
Identifier of the intended recipient of the token.
audience_uri str
Identifier for the intended audience of the SAML Assertion.
authorization_type str
Indicates whether authorization is granted based on group membership or user ID. Valid values are GROUP or USER.
client_id str
Client identifier that is assigned to an application by the Identity Provider.
description str
The description of the identity provider.
display_name str
Human-readable label that identifies the IdP.
federation_settings_id str
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
groups_claim str
Identifier of the claim which contains IdP Group IDs in the token.
id str
The provider-assigned unique ID for this managed resource.
identity_provider_id str
idp_id str
Unique 24-hexadecimal digit string that identifies the IdP
idp_type str
Type of the identity provider. Valid values are WORKFORCE or WORKLOAD.
issuer_uri str
Identifier for the issuer of the SAML Assertion.
okta_idp_id str
Unique 20-hexadecimal digit string that identifies the IdP.
pem_file_infos Sequence[GetFederatedSettingsIdentityProviderPemFileInfo]
protocol str
The protocol of the identity provider. Valid values are SAML or OIDC.
request_binding str
SAML Authentication Request Protocol binding used to send the AuthNRequest. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
requested_scopes Sequence[str]
Scopes that MongoDB applications will request from the authorization endpoint.
response_signature_algorithm str
Algorithm used to encrypt the IdP signature. Atlas supports the following signature algorithm values:

  • SHA-1
  • SHA-256
sso_debug_enabled bool
Flag that indicates whether the IdP has enabled Bypass SAML Mode. Enabling this mode generates a URL that allows you bypass SAML and login to your organizations at any point. You can authenticate with this special URL only when Bypass Mode is enabled. Set this parameter to true during testing. This keeps you from getting locked out of MongoDB.
sso_url str
URL of the receiver of the SAML AuthNRequest.
status str
Label that indicates whether the identity provider is active. The IdP is Inactive until you map at least one domain to the IdP.
user_claim str
Identifier of the claim which contains the user ID in the token.
acsUrl String
Assertion consumer service URL to which the IdP sends the SAML response.
associatedDomains List<String>
List that contains the configured domains from which users can log in for this IdP.
associatedOrgs List<Property Map>
List that contains the organizations from which users can log in for this IdP.
audience String
Identifier of the intended recipient of the token.
audienceUri String
Identifier for the intended audience of the SAML Assertion.
authorizationType String
Indicates whether authorization is granted based on group membership or user ID. Valid values are GROUP or USER.
clientId String
Client identifier that is assigned to an application by the Identity Provider.
description String
The description of the identity provider.
displayName String
Human-readable label that identifies the IdP.
federationSettingsId String
Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
groupsClaim String
Identifier of the claim which contains IdP Group IDs in the token.
id String
The provider-assigned unique ID for this managed resource.
identityProviderId String
idpId String
Unique 24-hexadecimal digit string that identifies the IdP
idpType String
Type of the identity provider. Valid values are WORKFORCE or WORKLOAD.
issuerUri String
Identifier for the issuer of the SAML Assertion.
oktaIdpId String
Unique 20-hexadecimal digit string that identifies the IdP.
pemFileInfos List<Property Map>
protocol String
The protocol of the identity provider. Valid values are SAML or OIDC.
requestBinding String
SAML Authentication Request Protocol binding used to send the AuthNRequest. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
requestedScopes List<String>
Scopes that MongoDB applications will request from the authorization endpoint.
responseSignatureAlgorithm String
Algorithm used to encrypt the IdP signature. Atlas supports the following signature algorithm values:

  • SHA-1
  • SHA-256
ssoDebugEnabled Boolean
Flag that indicates whether the IdP has enabled Bypass SAML Mode. Enabling this mode generates a URL that allows you bypass SAML and login to your organizations at any point. You can authenticate with this special URL only when Bypass Mode is enabled. Set this parameter to true during testing. This keeps you from getting locked out of MongoDB.
ssoUrl String
URL of the receiver of the SAML AuthNRequest.
status String
Label that indicates whether the identity provider is active. The IdP is Inactive until you map at least one domain to the IdP.
userClaim String
Identifier of the claim which contains the user ID in the token.

Supporting Types

GetFederatedSettingsIdentityProviderAssociatedOrg

DomainAllowLists This property is required. List<string>
List that contains the approved domains from which organization users can log in.
DomainRestrictionEnabled This property is required. bool
Flag that indicates whether domain restriction is enabled for the connected organization.
IdentityProviderId This property is required. string
Unique 24-hexadecimal digit string that identifies the IdP.
OrgId This property is required. string
Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
PostAuthRoleGrants This property is required. List<string>
List that contains the default roles granted to users who authenticate through the IdP in a connected organization. If you provide a postAuthRoleGrants field in the request, the array that you provide replaces the current postAuthRoleGrants.
RoleMappings This property is required. List<GetFederatedSettingsIdentityProviderAssociatedOrgRoleMapping>
UserConflicts This property is required. List<GetFederatedSettingsIdentityProviderAssociatedOrgUserConflict>
DomainAllowLists This property is required. []string
List that contains the approved domains from which organization users can log in.
DomainRestrictionEnabled This property is required. bool
Flag that indicates whether domain restriction is enabled for the connected organization.
IdentityProviderId This property is required. string
Unique 24-hexadecimal digit string that identifies the IdP.
OrgId This property is required. string
Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
PostAuthRoleGrants This property is required. []string
List that contains the default roles granted to users who authenticate through the IdP in a connected organization. If you provide a postAuthRoleGrants field in the request, the array that you provide replaces the current postAuthRoleGrants.
RoleMappings This property is required. []GetFederatedSettingsIdentityProviderAssociatedOrgRoleMapping
UserConflicts This property is required. []GetFederatedSettingsIdentityProviderAssociatedOrgUserConflict
domainAllowLists This property is required. List<String>
List that contains the approved domains from which organization users can log in.
domainRestrictionEnabled This property is required. Boolean
Flag that indicates whether domain restriction is enabled for the connected organization.
identityProviderId This property is required. String
Unique 24-hexadecimal digit string that identifies the IdP.
orgId This property is required. String
Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
postAuthRoleGrants This property is required. List<String>
List that contains the default roles granted to users who authenticate through the IdP in a connected organization. If you provide a postAuthRoleGrants field in the request, the array that you provide replaces the current postAuthRoleGrants.
roleMappings This property is required. List<GetFederatedSettingsIdentityProviderAssociatedOrgRoleMapping>
userConflicts This property is required. List<GetFederatedSettingsIdentityProviderAssociatedOrgUserConflict>
domainAllowLists This property is required. string[]
List that contains the approved domains from which organization users can log in.
domainRestrictionEnabled This property is required. boolean
Flag that indicates whether domain restriction is enabled for the connected organization.
identityProviderId This property is required. string
Unique 24-hexadecimal digit string that identifies the IdP.
orgId This property is required. string
Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
postAuthRoleGrants This property is required. string[]
List that contains the default roles granted to users who authenticate through the IdP in a connected organization. If you provide a postAuthRoleGrants field in the request, the array that you provide replaces the current postAuthRoleGrants.
roleMappings This property is required. GetFederatedSettingsIdentityProviderAssociatedOrgRoleMapping[]
userConflicts This property is required. GetFederatedSettingsIdentityProviderAssociatedOrgUserConflict[]
domain_allow_lists This property is required. Sequence[str]
List that contains the approved domains from which organization users can log in.
domain_restriction_enabled This property is required. bool
Flag that indicates whether domain restriction is enabled for the connected organization.
identity_provider_id This property is required. str
Unique 24-hexadecimal digit string that identifies the IdP.
org_id This property is required. str
Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
post_auth_role_grants This property is required. Sequence[str]
List that contains the default roles granted to users who authenticate through the IdP in a connected organization. If you provide a postAuthRoleGrants field in the request, the array that you provide replaces the current postAuthRoleGrants.
role_mappings This property is required. Sequence[GetFederatedSettingsIdentityProviderAssociatedOrgRoleMapping]
user_conflicts This property is required. Sequence[GetFederatedSettingsIdentityProviderAssociatedOrgUserConflict]
domainAllowLists This property is required. List<String>
List that contains the approved domains from which organization users can log in.
domainRestrictionEnabled This property is required. Boolean
Flag that indicates whether domain restriction is enabled for the connected organization.
identityProviderId This property is required. String
Unique 24-hexadecimal digit string that identifies the IdP.
orgId This property is required. String
Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
postAuthRoleGrants This property is required. List<String>
List that contains the default roles granted to users who authenticate through the IdP in a connected organization. If you provide a postAuthRoleGrants field in the request, the array that you provide replaces the current postAuthRoleGrants.
roleMappings This property is required. List<Property Map>
userConflicts This property is required. List<Property Map>

GetFederatedSettingsIdentityProviderAssociatedOrgRoleMapping

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

GetFederatedSettingsIdentityProviderAssociatedOrgRoleMappingRoleAssignment

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

GetFederatedSettingsIdentityProviderAssociatedOrgUserConflict

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

GetFederatedSettingsIdentityProviderPemFileInfo

Certificates This property is required. List<GetFederatedSettingsIdentityProviderPemFileInfoCertificate>
FileName This property is required. string
Filename of certificate
Certificates This property is required. []GetFederatedSettingsIdentityProviderPemFileInfoCertificate
FileName This property is required. string
Filename of certificate
certificates This property is required. List<GetFederatedSettingsIdentityProviderPemFileInfoCertificate>
fileName This property is required. String
Filename of certificate
certificates This property is required. GetFederatedSettingsIdentityProviderPemFileInfoCertificate[]
fileName This property is required. string
Filename of certificate
certificates This property is required. Sequence[GetFederatedSettingsIdentityProviderPemFileInfoCertificate]
file_name This property is required. str
Filename of certificate
certificates This property is required. List<Property Map>
fileName This property is required. String
Filename of certificate

GetFederatedSettingsIdentityProviderPemFileInfoCertificate

NotAfter This property is required. string
Expiration Date.
NotBefore This property is required. string
Start Date.
NotAfter This property is required. string
Expiration Date.
NotBefore This property is required. string
Start Date.
notAfter This property is required. String
Expiration Date.
notBefore This property is required. String
Start Date.
notAfter This property is required. string
Expiration Date.
notBefore This property is required. string
Start Date.
not_after This property is required. str
Expiration Date.
not_before This property is required. str
Start Date.
notAfter This property is required. String
Expiration Date.
notBefore This property is required. String
Start Date.

Package Details

Repository
MongoDB Atlas pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.