MongoDB Atlas

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

FederatedSettingsOrgRoleMapping

mongodbatlas.FederatedSettingsOrgRoleMapping provides an Role Mapping resource. This allows organization role mapping to be created.

Example Usage

using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;

class MyStack : Stack
{
    public MyStack()
    {
        var orgGroupRoleMappingImport = new Mongodbatlas.FederatedSettingsOrgRoleMapping("orgGroupRoleMappingImport", new Mongodbatlas.FederatedSettingsOrgRoleMappingArgs
        {
            ExternalGroupName = "myGrouptest",
            FederationSettingsId = "627a9687f7f7f7f774de306f14",
            OrgId = "627a9683e7f7f7ff7fe306f14",
            RoleAssignments = 
            {
                new Mongodbatlas.Inputs.FederatedSettingsOrgRoleMappingRoleAssignmentArgs
                {
                    OrgId = "627a9683e7f7f7ff7fe306f14",
                    Roles = 
                    {
                        "ORG_MEMBER",
                        "ORG_GROUP_CREATOR",
                        "ORG_BILLING_ADMIN",
                    },
                },
                new Mongodbatlas.Inputs.FederatedSettingsOrgRoleMappingRoleAssignmentArgs
                {
                    GroupId = "628aa20d7f7f7f7f7098b81b8",
                    Roles = 
                    {
                        "GROUP_OWNER",
                        "GROUP_DATA_ACCESS_ADMIN",
                        "GROUP_SEARCH_INDEX_EDITOR",
                        "GROUP_DATA_ACCESS_READ_ONLY",
                    },
                },
                new Mongodbatlas.Inputs.FederatedSettingsOrgRoleMappingRoleAssignmentArgs
                {
                    GroupId = "628aa20d7f7f7f7f7078b81b8",
                    Roles = 
                    {
                        "GROUP_OWNER",
                        "GROUP_DATA_ACCESS_ADMIN",
                        "GROUP_SEARCH_INDEX_EDITOR",
                        "GROUP_DATA_ACCESS_READ_ONLY",
                        "GROUP_DATA_ACCESS_READ_WRITE",
                    },
                },
            },
        });
    }

}
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.NewFederatedSettingsOrgRoleMapping(ctx, "orgGroupRoleMappingImport", &mongodbatlas.FederatedSettingsOrgRoleMappingArgs{
			ExternalGroupName:    pulumi.String("myGrouptest"),
			FederationSettingsId: pulumi.String("627a9687f7f7f7f774de306f14"),
			OrgId:                pulumi.String("627a9683e7f7f7ff7fe306f14"),
			RoleAssignments: FederatedSettingsOrgRoleMappingRoleAssignmentArray{
				&FederatedSettingsOrgRoleMappingRoleAssignmentArgs{
					OrgId: pulumi.String("627a9683e7f7f7ff7fe306f14"),
					Roles: pulumi.StringArray{
						pulumi.String("ORG_MEMBER"),
						pulumi.String("ORG_GROUP_CREATOR"),
						pulumi.String("ORG_BILLING_ADMIN"),
					},
				},
				&FederatedSettingsOrgRoleMappingRoleAssignmentArgs{
					GroupId: pulumi.String("628aa20d7f7f7f7f7098b81b8"),
					Roles: pulumi.StringArray{
						pulumi.String("GROUP_OWNER"),
						pulumi.String("GROUP_DATA_ACCESS_ADMIN"),
						pulumi.String("GROUP_SEARCH_INDEX_EDITOR"),
						pulumi.String("GROUP_DATA_ACCESS_READ_ONLY"),
					},
				},
				&FederatedSettingsOrgRoleMappingRoleAssignmentArgs{
					GroupId: pulumi.String("628aa20d7f7f7f7f7078b81b8"),
					Roles: pulumi.StringArray{
						pulumi.String("GROUP_OWNER"),
						pulumi.String("GROUP_DATA_ACCESS_ADMIN"),
						pulumi.String("GROUP_SEARCH_INDEX_EDITOR"),
						pulumi.String("GROUP_DATA_ACCESS_READ_ONLY"),
						pulumi.String("GROUP_DATA_ACCESS_READ_WRITE"),
					},
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_mongodbatlas as mongodbatlas

org_group_role_mapping_import = mongodbatlas.FederatedSettingsOrgRoleMapping("orgGroupRoleMappingImport",
    external_group_name="myGrouptest",
    federation_settings_id="627a9687f7f7f7f774de306f14",
    org_id="627a9683e7f7f7ff7fe306f14",
    role_assignments=[
        mongodbatlas.FederatedSettingsOrgRoleMappingRoleAssignmentArgs(
            org_id="627a9683e7f7f7ff7fe306f14",
            roles=[
                "ORG_MEMBER",
                "ORG_GROUP_CREATOR",
                "ORG_BILLING_ADMIN",
            ],
        ),
        mongodbatlas.FederatedSettingsOrgRoleMappingRoleAssignmentArgs(
            group_id="628aa20d7f7f7f7f7098b81b8",
            roles=[
                "GROUP_OWNER",
                "GROUP_DATA_ACCESS_ADMIN",
                "GROUP_SEARCH_INDEX_EDITOR",
                "GROUP_DATA_ACCESS_READ_ONLY",
            ],
        ),
        mongodbatlas.FederatedSettingsOrgRoleMappingRoleAssignmentArgs(
            group_id="628aa20d7f7f7f7f7078b81b8",
            roles=[
                "GROUP_OWNER",
                "GROUP_DATA_ACCESS_ADMIN",
                "GROUP_SEARCH_INDEX_EDITOR",
                "GROUP_DATA_ACCESS_READ_ONLY",
                "GROUP_DATA_ACCESS_READ_WRITE",
            ],
        ),
    ])
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";

const orgGroupRoleMappingImport = new mongodbatlas.FederatedSettingsOrgRoleMapping("org_group_role_mapping_import", {
    externalGroupName: "myGrouptest",
    federationSettingsId: "627a9687f7f7f7f774de306f14",
    orgId: "627a9683e7f7f7ff7fe306f14",
    roleAssignments: [
        {
            orgId: "627a9683e7f7f7ff7fe306f14",
            roles: [
                "ORG_MEMBER",
                "ORG_GROUP_CREATOR",
                "ORG_BILLING_ADMIN",
            ],
        },
        {
            groupId: "628aa20d7f7f7f7f7098b81b8",
            roles: [
                "GROUP_OWNER",
                "GROUP_DATA_ACCESS_ADMIN",
                "GROUP_SEARCH_INDEX_EDITOR",
                "GROUP_DATA_ACCESS_READ_ONLY",
            ],
        },
        {
            groupId: "628aa20d7f7f7f7f7078b81b8",
            roles: [
                "GROUP_OWNER",
                "GROUP_DATA_ACCESS_ADMIN",
                "GROUP_SEARCH_INDEX_EDITOR",
                "GROUP_DATA_ACCESS_READ_ONLY",
                "GROUP_DATA_ACCESS_READ_WRITE",
            ],
        },
    ],
});

Coming soon!

Create a FederatedSettingsOrgRoleMapping Resource

new FederatedSettingsOrgRoleMapping(name: string, args: FederatedSettingsOrgRoleMappingArgs, opts?: CustomResourceOptions);
@overload
def FederatedSettingsOrgRoleMapping(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    external_group_name: Optional[str] = None,
                                    federation_settings_id: Optional[str] = None,
                                    org_id: Optional[str] = None,
                                    role_assignments: Optional[Sequence[FederatedSettingsOrgRoleMappingRoleAssignmentArgs]] = None)
@overload
def FederatedSettingsOrgRoleMapping(resource_name: str,
                                    args: FederatedSettingsOrgRoleMappingArgs,
                                    opts: Optional[ResourceOptions] = None)
func NewFederatedSettingsOrgRoleMapping(ctx *Context, name string, args FederatedSettingsOrgRoleMappingArgs, opts ...ResourceOption) (*FederatedSettingsOrgRoleMapping, error)
public FederatedSettingsOrgRoleMapping(string name, FederatedSettingsOrgRoleMappingArgs args, CustomResourceOptions? opts = null)
public FederatedSettingsOrgRoleMapping(String name, FederatedSettingsOrgRoleMappingArgs args)
public FederatedSettingsOrgRoleMapping(String name, FederatedSettingsOrgRoleMappingArgs args, CustomResourceOptions options)
type: mongodbatlas:FederatedSettingsOrgRoleMapping
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args FederatedSettingsOrgRoleMappingArgs
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 FederatedSettingsOrgRoleMappingArgs
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 FederatedSettingsOrgRoleMappingArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args FederatedSettingsOrgRoleMappingArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args FederatedSettingsOrgRoleMappingArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

FederatedSettingsOrgRoleMapping 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 FederatedSettingsOrgRoleMapping resource accepts the following input properties:

ExternalGroupName string

Unique human-readable label that identifies the identity provider group to which this role mapping applies.

FederationSettingsId string

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

OrgId string

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

RoleAssignments List<FederatedSettingsOrgRoleMappingRoleAssignmentArgs>

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.

FederationSettingsId string

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

OrgId string

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

RoleAssignments []FederatedSettingsOrgRoleMappingRoleAssignmentArgs

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.

federationSettingsId String

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

orgId String

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

roleAssignments List<FederatedSettingsOrgRoleMappingRoleAssignmentArgs>

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.

federationSettingsId string

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

roleAssignments FederatedSettingsOrgRoleMappingRoleAssignmentArgs[]

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.

federation_settings_id str

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

org_id str

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

role_assignments Sequence[FederatedSettingsOrgRoleMappingRoleAssignmentArgs]

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.

federationSettingsId String

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

orgId String

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

roleAssignments List<Property Map>

Atlas roles and the unique identifiers of the groups and organizations associated with each role.

Outputs

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

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

Look up an Existing FederatedSettingsOrgRoleMapping Resource

Get an existing FederatedSettingsOrgRoleMapping 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?: FederatedSettingsOrgRoleMappingState, opts?: CustomResourceOptions): FederatedSettingsOrgRoleMapping
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        external_group_name: Optional[str] = None,
        federation_settings_id: Optional[str] = None,
        org_id: Optional[str] = None,
        role_assignments: Optional[Sequence[FederatedSettingsOrgRoleMappingRoleAssignmentArgs]] = None) -> FederatedSettingsOrgRoleMapping
func GetFederatedSettingsOrgRoleMapping(ctx *Context, name string, id IDInput, state *FederatedSettingsOrgRoleMappingState, opts ...ResourceOption) (*FederatedSettingsOrgRoleMapping, error)
public static FederatedSettingsOrgRoleMapping Get(string name, Input<string> id, FederatedSettingsOrgRoleMappingState? state, CustomResourceOptions? opts = null)
public static FederatedSettingsOrgRoleMapping get(String name, Output<String> id, FederatedSettingsOrgRoleMappingState 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:
ExternalGroupName string

Unique human-readable label that identifies the identity provider group to which this role mapping applies.

FederationSettingsId string

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

OrgId string

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

RoleAssignments List<FederatedSettingsOrgRoleMappingRoleAssignmentArgs>

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.

FederationSettingsId string

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

OrgId string

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

RoleAssignments []FederatedSettingsOrgRoleMappingRoleAssignmentArgs

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.

federationSettingsId String

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

orgId String

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

roleAssignments List<FederatedSettingsOrgRoleMappingRoleAssignmentArgs>

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.

federationSettingsId string

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

orgId string

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

roleAssignments FederatedSettingsOrgRoleMappingRoleAssignmentArgs[]

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.

federation_settings_id str

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

org_id str

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

role_assignments Sequence[FederatedSettingsOrgRoleMappingRoleAssignmentArgs]

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.

federationSettingsId String

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

orgId String

Unique 24-hexadecimal digit string that identifies the organization that contains your projects.

roleAssignments List<Property Map>

Atlas roles and the unique identifiers of the groups and organizations associated with each role.

Supporting Types

FederatedSettingsOrgRoleMappingRoleAssignment

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.

Roles List<string>

Specifies the Roles that are 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.

Roles []string

Specifies the Roles that are 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.

roles List<String>

Specifies the Roles that are 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.

roles string[]

Specifies the Roles that are 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.

roles Sequence[str]

Specifies the Roles that are 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.

roles List<String>

Specifies the Roles that are attached to the Role Mapping.

Import

FederatedSettingsOrgRoleMapping can be imported using federation_settings_id-org_id-role_mapping_id, e.g.

 $ pulumi import mongodbatlas:index/federatedSettingsOrgRoleMapping:FederatedSettingsOrgRoleMapping org_group_role_mapping_import 6287a663c7f7f7f71c441c6c-627a96837f7f7f7e306f14-628ae97f7f7468ea3727

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.