MongoDB Atlas

Pulumi Official
Package maintained by Pulumi
v3.5.0 published on Wednesday, Jul 20, 2022 by Pulumi

FederatedSettingsIdentityProvider

mongodbatlas.FederatedSettingsIdentityProvider provides an Atlas federated settings identity provider resource provides a subset of settings to be maintained post import of the existing resource.

Example Usage

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var identityProvider = new Mongodbatlas.FederatedSettingsIdentityProvider("identityProvider", new Mongodbatlas.FederatedSettingsIdentityProviderArgs
        {
            AssociatedDomains = 
            {
                "yourdomain.com",
            },
            FederationSettingsId = "627a9687f7f7f7f774de306f14",
            IssuerUri = "http://www.okta.com/exk17q7f7f7f7fp50h8",
            RequestBinding = "HTTP-POST",
            ResponseSignatureAlgorithm = "SHA-256",
            SsoDebugEnabled = true,
            SsoUrl = "https://mysso.oktapreview.com/app/mysso_terraformtestsso/exk17q7f7f7f7f50h8/sso/saml",
            Status = "ACTIVE",
        });
    }

}
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 {
		_, err := mongodbatlas.NewFederatedSettingsIdentityProvider(ctx, "identityProvider", &mongodbatlas.FederatedSettingsIdentityProviderArgs{
			AssociatedDomains: pulumi.StringArray{
				pulumi.String("yourdomain.com"),
			},
			FederationSettingsId:       pulumi.String("627a9687f7f7f7f774de306f14"),
			IssuerUri:                  pulumi.String("http://www.okta.com/exk17q7f7f7f7fp50h8"),
			RequestBinding:             pulumi.String("HTTP-POST"),
			ResponseSignatureAlgorithm: pulumi.String("SHA-256"),
			SsoDebugEnabled:            pulumi.Bool(true),
			SsoUrl:                     pulumi.String("https://mysso.oktapreview.com/app/mysso_terraformtestsso/exk17q7f7f7f7f50h8/sso/saml"),
			Status:                     pulumi.String("ACTIVE"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_mongodbatlas as mongodbatlas

identity_provider = mongodbatlas.FederatedSettingsIdentityProvider("identityProvider",
    associated_domains=["yourdomain.com"],
    federation_settings_id="627a9687f7f7f7f774de306f14",
    issuer_uri="http://www.okta.com/exk17q7f7f7f7fp50h8",
    request_binding="HTTP-POST",
    response_signature_algorithm="SHA-256",
    sso_debug_enabled=True,
    sso_url="https://mysso.oktapreview.com/app/mysso_terraformtestsso/exk17q7f7f7f7f50h8/sso/saml",
    status="ACTIVE")
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const identityProvider = new mongodbatlas.FederatedSettingsIdentityProvider("identity_provider", {
    associatedDomains: ["yourdomain.com"],
    federationSettingsId: "627a9687f7f7f7f774de306f14",
    issuerUri: "http://www.okta.com/exk17q7f7f7f7fp50h8",
    requestBinding: "HTTP-POST",
    responseSignatureAlgorithm: "SHA-256",
    ssoDebugEnabled: true,
    ssoUrl: "https://mysso.oktapreview.com/app/mysso_terraformtestsso/exk17q7f7f7f7f50h8/sso/saml",
    status: "ACTIVE",
});

Coming soon!

Create a FederatedSettingsIdentityProvider Resource

new FederatedSettingsIdentityProvider(name: string, args: FederatedSettingsIdentityProviderArgs, opts?: CustomResourceOptions);
@overload
def FederatedSettingsIdentityProvider(resource_name: str,
                                      opts: Optional[ResourceOptions] = None,
                                      associated_domains: Optional[Sequence[str]] = None,
                                      federation_settings_id: Optional[str] = None,
                                      issuer_uri: Optional[str] = None,
                                      name: Optional[str] = None,
                                      request_binding: Optional[str] = None,
                                      response_signature_algorithm: Optional[str] = None,
                                      sso_debug_enabled: Optional[bool] = None,
                                      sso_url: Optional[str] = None,
                                      status: Optional[str] = None)
@overload
def FederatedSettingsIdentityProvider(resource_name: str,
                                      args: FederatedSettingsIdentityProviderArgs,
                                      opts: Optional[ResourceOptions] = None)
func NewFederatedSettingsIdentityProvider(ctx *Context, name string, args FederatedSettingsIdentityProviderArgs, opts ...ResourceOption) (*FederatedSettingsIdentityProvider, error)
public FederatedSettingsIdentityProvider(string name, FederatedSettingsIdentityProviderArgs args, CustomResourceOptions? opts = null)
public FederatedSettingsIdentityProvider(String name, FederatedSettingsIdentityProviderArgs args)
public FederatedSettingsIdentityProvider(String name, FederatedSettingsIdentityProviderArgs args, CustomResourceOptions options)
type: mongodbatlas:FederatedSettingsIdentityProvider
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args FederatedSettingsIdentityProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args FederatedSettingsIdentityProviderArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args FederatedSettingsIdentityProviderArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FederatedSettingsIdentityProviderArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FederatedSettingsIdentityProviderArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

FederatedSettingsIdentityProvider Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The FederatedSettingsIdentityProvider resource accepts the following input properties:

FederationSettingsId string

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

IssuerUri string

Unique string that identifies the issuer of the SAML

RequestBinding string

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
ResponseSignatureAlgorithm string

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

SsoDebugEnabled bool

Flag that indicates whether the identity provider has SSO debug enabled.

SsoUrl string

Unique string that identifies the intended audience of the SAML assertion.

Status string

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

AssociatedDomains List<string>

List that contains the domains associated with the identity provider.

Name string

Human-readable label that identifies the identity provider.

FederationSettingsId string

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

IssuerUri string

Unique string that identifies the issuer of the SAML

RequestBinding string

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
ResponseSignatureAlgorithm string

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

SsoDebugEnabled bool

Flag that indicates whether the identity provider has SSO debug enabled.

SsoUrl string

Unique string that identifies the intended audience of the SAML assertion.

Status string

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

AssociatedDomains []string

List that contains the domains associated with the identity provider.

Name string

Human-readable label that identifies the identity provider.

federationSettingsId String

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

issuerUri String

Unique string that identifies the issuer of the SAML

requestBinding String

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
responseSignatureAlgorithm String

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

ssoDebugEnabled Boolean

Flag that indicates whether the identity provider has SSO debug enabled.

ssoUrl String

Unique string that identifies the intended audience of the SAML assertion.

status String

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

associatedDomains List<String>

List that contains the domains associated with the identity provider.

name String

Human-readable label that identifies the identity provider.

federationSettingsId string

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

issuerUri string

Unique string that identifies the issuer of the SAML

requestBinding string

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
responseSignatureAlgorithm string

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

ssoDebugEnabled boolean

Flag that indicates whether the identity provider has SSO debug enabled.

ssoUrl string

Unique string that identifies the intended audience of the SAML assertion.

status string

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

associatedDomains string[]

List that contains the domains associated with the identity provider.

name string

Human-readable label that identifies the identity provider.

federation_settings_id str

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

issuer_uri str

Unique string that identifies the issuer of the SAML

request_binding str

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
response_signature_algorithm str

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

sso_debug_enabled bool

Flag that indicates whether the identity provider has SSO debug enabled.

sso_url str

Unique string that identifies the intended audience of the SAML assertion.

status str

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

associated_domains Sequence[str]

List that contains the domains associated with the identity provider.

name str

Human-readable label that identifies the identity provider.

federationSettingsId String

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

issuerUri String

Unique string that identifies the issuer of the SAML

requestBinding String

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
responseSignatureAlgorithm String

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

ssoDebugEnabled Boolean

Flag that indicates whether the identity provider has SSO debug enabled.

ssoUrl String

Unique string that identifies the intended audience of the SAML assertion.

status String

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

associatedDomains List<String>

List that contains the domains associated with the identity provider.

name String

Human-readable label that identifies the identity provider.

Outputs

All input properties are implicitly available as output properties. Additionally, the FederatedSettingsIdentityProvider resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

OktaIdpId string
Id string

The provider-assigned unique ID for this managed resource.

OktaIdpId string
id String

The provider-assigned unique ID for this managed resource.

oktaIdpId String
id string

The provider-assigned unique ID for this managed resource.

oktaIdpId string
id str

The provider-assigned unique ID for this managed resource.

okta_idp_id str
id String

The provider-assigned unique ID for this managed resource.

oktaIdpId String

Look up an Existing FederatedSettingsIdentityProvider Resource

Get an existing FederatedSettingsIdentityProvider resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FederatedSettingsIdentityProviderState, opts?: CustomResourceOptions): FederatedSettingsIdentityProvider
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        associated_domains: Optional[Sequence[str]] = None,
        federation_settings_id: Optional[str] = None,
        issuer_uri: Optional[str] = None,
        name: Optional[str] = None,
        okta_idp_id: Optional[str] = None,
        request_binding: Optional[str] = None,
        response_signature_algorithm: Optional[str] = None,
        sso_debug_enabled: Optional[bool] = None,
        sso_url: Optional[str] = None,
        status: Optional[str] = None) -> FederatedSettingsIdentityProvider
func GetFederatedSettingsIdentityProvider(ctx *Context, name string, id IDInput, state *FederatedSettingsIdentityProviderState, opts ...ResourceOption) (*FederatedSettingsIdentityProvider, error)
public static FederatedSettingsIdentityProvider Get(string name, Input<string> id, FederatedSettingsIdentityProviderState? state, CustomResourceOptions? opts = null)
public static FederatedSettingsIdentityProvider get(String name, Output<String> id, FederatedSettingsIdentityProviderState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AssociatedDomains List<string>

List that contains the domains associated with the identity provider.

FederationSettingsId string

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

IssuerUri string

Unique string that identifies the issuer of the SAML

Name string

Human-readable label that identifies the identity provider.

OktaIdpId string
RequestBinding string

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
ResponseSignatureAlgorithm string

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

SsoDebugEnabled bool

Flag that indicates whether the identity provider has SSO debug enabled.

SsoUrl string

Unique string that identifies the intended audience of the SAML assertion.

Status string

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

AssociatedDomains []string

List that contains the domains associated with the identity provider.

FederationSettingsId string

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

IssuerUri string

Unique string that identifies the issuer of the SAML

Name string

Human-readable label that identifies the identity provider.

OktaIdpId string
RequestBinding string

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
ResponseSignatureAlgorithm string

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

SsoDebugEnabled bool

Flag that indicates whether the identity provider has SSO debug enabled.

SsoUrl string

Unique string that identifies the intended audience of the SAML assertion.

Status string

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

associatedDomains List<String>

List that contains the domains associated with the identity provider.

federationSettingsId String

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

issuerUri String

Unique string that identifies the issuer of the SAML

name String

Human-readable label that identifies the identity provider.

oktaIdpId String
requestBinding String

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
responseSignatureAlgorithm String

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

ssoDebugEnabled Boolean

Flag that indicates whether the identity provider has SSO debug enabled.

ssoUrl String

Unique string that identifies the intended audience of the SAML assertion.

status String

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

associatedDomains string[]

List that contains the domains associated with the identity provider.

federationSettingsId string

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

issuerUri string

Unique string that identifies the issuer of the SAML

name string

Human-readable label that identifies the identity provider.

oktaIdpId string
requestBinding string

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
responseSignatureAlgorithm string

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

ssoDebugEnabled boolean

Flag that indicates whether the identity provider has SSO debug enabled.

ssoUrl string

Unique string that identifies the intended audience of the SAML assertion.

status string

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

associated_domains Sequence[str]

List that contains the domains associated with the identity provider.

federation_settings_id str

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

issuer_uri str

Unique string that identifies the issuer of the SAML

name str

Human-readable label that identifies the identity provider.

okta_idp_id str
request_binding str

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
response_signature_algorithm str

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

sso_debug_enabled bool

Flag that indicates whether the identity provider has SSO debug enabled.

sso_url str

Unique string that identifies the intended audience of the SAML assertion.

status str

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

associatedDomains List<String>

List that contains the domains associated with the identity provider.

federationSettingsId String

Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

issuerUri String

Unique string that identifies the issuer of the SAML

name String

Human-readable label that identifies the identity provider.

oktaIdpId String
requestBinding String

SAML Authentication Request Protocol HTTP method binding (POST or REDIRECT) that Federated Authentication uses to send the authentication request. Atlas supports the following binding values:

  • HTTP POST
  • HTTP REDIRECT
responseSignatureAlgorithm String

Signature algorithm that Federated Authentication uses to encrypt the identity provider signature. Valid values include SHA-1 and SHA-256.

ssoDebugEnabled Boolean

Flag that indicates whether the identity provider has SSO debug enabled.

ssoUrl String

Unique string that identifies the intended audience of the SAML assertion.

status String

String enum that indicates whether the identity provider is active or not. Accepted values are ACTIVE or INACTIVE.

Import

Identity Provider must be imported before using federation_settings_id-idp_id, e.g.

 $ pulumi import mongodbatlas:index/federatedSettingsIdentityProvider:FederatedSettingsIdentityProvider identity_provider 6287a663c660f52b1c441c6c-0oad4fas87jL5Xnk1297

For more information seeMongoDB Atlas API Reference.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes

This Pulumi package is based on the mongodbatlas Terraform Provider.