1. Packages
  2. MongoDB Atlas
  3. API Docs
  4. getFederatedSettingsOrgRoleMappings
MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi

mongodbatlas.getFederatedSettingsOrgRoleMappings

Explore with Pulumi AI

mongodbatlas logo
MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi

    # Data Source: mongodbatlas.getFederatedSettingsOrgRoleMappings

    mongodbatlas.getFederatedSettingsOrgRoleMappings provides an Federated Settings Org Role Mapping datasource. Atlas Cloud Federated Settings Org Role Mapping provides federated settings outputs for the configured Org Role Mapping.

    Example Usage

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    resources:
      orgGroupRoleMappingImport:
        type: mongodbatlas:FederatedSettingsOrgRoleMapping
        name: org_group_role_mapping_import
        properties:
          federationSettingsId:
          orgId: 627a9683e7f7f7ff7fe306f14
          groupId: 628aa20d7f7f7f7f7098b81b8
          externalGroupName: myGrouptest
          organizationRoles:
            - ORG_OWNER
            - ORG_MEMBER
            - ORG_BILLING_ADMIN
            - ORG_GROUP_CREATOR
            - ORG_READ_ONLY
          groupRoles:
            - GROUP_OWNER
            - GROUP_CLUSTER_MANAGER
            - GROUP_DATA_ACCESS_ADMIN
            - GROUP_DATA_ACCESS_READ_WRITE
            - GROUP_SEARCH_INDEX_EDITOR
            - GROUP_DATA_ACCESS_READ_ONLY
            - GROUP_READ_ONLY
    variables:
      roleMappings:
        fn::invoke:
          Function: mongodbatlas:getFederatedSettingsOrgRoleMappings
          Arguments:
            federationSettingsId: ${orgGroupRoleMappingImport.id}
            orgId: 627a9683e7f7f7ff7fe306f14
            pageNum: 1
            itemsPerPage: 5
    

    Using getFederatedSettingsOrgRoleMappings

    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 getFederatedSettingsOrgRoleMappings(args: GetFederatedSettingsOrgRoleMappingsArgs, opts?: InvokeOptions): Promise<GetFederatedSettingsOrgRoleMappingsResult>
    function getFederatedSettingsOrgRoleMappingsOutput(args: GetFederatedSettingsOrgRoleMappingsOutputArgs, opts?: InvokeOptions): Output<GetFederatedSettingsOrgRoleMappingsResult>
    def get_federated_settings_org_role_mappings(federation_settings_id: Optional[str] = None,
                                                 items_per_page: Optional[int] = None,
                                                 org_id: Optional[str] = None,
                                                 page_num: Optional[int] = None,
                                                 opts: Optional[InvokeOptions] = None) -> GetFederatedSettingsOrgRoleMappingsResult
    def get_federated_settings_org_role_mappings_output(federation_settings_id: Optional[pulumi.Input[str]] = None,
                                                 items_per_page: Optional[pulumi.Input[int]] = None,
                                                 org_id: Optional[pulumi.Input[str]] = None,
                                                 page_num: Optional[pulumi.Input[int]] = None,
                                                 opts: Optional[InvokeOptions] = None) -> Output[GetFederatedSettingsOrgRoleMappingsResult]
    func LookupFederatedSettingsOrgRoleMappings(ctx *Context, args *LookupFederatedSettingsOrgRoleMappingsArgs, opts ...InvokeOption) (*LookupFederatedSettingsOrgRoleMappingsResult, error)
    func LookupFederatedSettingsOrgRoleMappingsOutput(ctx *Context, args *LookupFederatedSettingsOrgRoleMappingsOutputArgs, opts ...InvokeOption) LookupFederatedSettingsOrgRoleMappingsResultOutput

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

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

    The following arguments are supported:

    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.
    ItemsPerPage int
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    PageNum int
    The page to return. Defaults to 1.
    FederationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    OrgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    ItemsPerPage int
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    PageNum int
    The page to return. Defaults to 1.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    itemsPerPage Integer
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    pageNum Integer
    The page to return. Defaults to 1.
    federationSettingsId string
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    orgId string
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    itemsPerPage number
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    pageNum number
    The page to return. Defaults to 1.
    federation_settings_id str
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    org_id str
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    items_per_page int
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    page_num int
    The page to return. Defaults to 1.
    federationSettingsId String
    Unique 24-hexadecimal digit string that identifies the federated authentication configuration.
    orgId String
    Unique 24-hexadecimal digit string that identifies the organization that contains your projects.
    itemsPerPage Number
    Number of items to return per page, up to a maximum of 500. Defaults to 100.
    pageNum Number
    The page to return. Defaults to 1.

    getFederatedSettingsOrgRoleMappings Result

    The following output properties are available:

    FederationSettingsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    Results List<GetFederatedSettingsOrgRoleMappingsResult>
    Includes cloudProviderSnapshot object for each item detailed in the results array section.

    • totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    ItemsPerPage int
    PageNum int
    FederationSettingsId string
    Id string
    The provider-assigned unique ID for this managed resource.
    OrgId string
    Results []GetFederatedSettingsOrgRoleMappingsResult
    Includes cloudProviderSnapshot object for each item detailed in the results array section.

    • totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    ItemsPerPage int
    PageNum int
    federationSettingsId String
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    results List<GetFederatedSettingsOrgRoleMappingsResult>
    Includes cloudProviderSnapshot object for each item detailed in the results array section.

    • totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage Integer
    pageNum Integer
    federationSettingsId string
    id string
    The provider-assigned unique ID for this managed resource.
    orgId string
    results GetFederatedSettingsOrgRoleMappingsResult[]
    Includes cloudProviderSnapshot object for each item detailed in the results array section.

    • totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage number
    pageNum number
    federation_settings_id str
    id str
    The provider-assigned unique ID for this managed resource.
    org_id str
    results Sequence[GetFederatedSettingsOrgRoleMappingsResult]
    Includes cloudProviderSnapshot object for each item detailed in the results array section.

    • totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    items_per_page int
    page_num int
    federationSettingsId String
    id String
    The provider-assigned unique ID for this managed resource.
    orgId String
    results List<Property Map>
    Includes cloudProviderSnapshot object for each item detailed in the results array section.

    • totalCount - Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.
    itemsPerPage Number
    pageNum Number

    Supporting Types

    GetFederatedSettingsOrgRoleMappingsResult

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

    GetFederatedSettingsOrgRoleMappingsResultRoleAssignment

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

    Package Details

    Repository
    MongoDB Atlas pulumi/pulumi-mongodbatlas
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the mongodbatlas Terraform Provider.
    mongodbatlas logo
    MongoDB Atlas v3.18.0 published on Thursday, Sep 12, 2024 by Pulumi