1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. IdpGroupMapping
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

oci.Identity.IdpGroupMapping

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

    This resource provides the Idp Group Mapping resource in Oracle Cloud Infrastructure Identity service.

    Deprecated. For more information, see Deprecated IAM Service APIs.

    Creates a single mapping between an IdP group and an IAM Service group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testIdpGroupMapping = new oci.identity.IdpGroupMapping("test_idp_group_mapping", {
        groupId: testGroup.id,
        identityProviderId: testIdentityProvider.id,
        idpGroupName: idpGroupMappingIdpGroupName,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_idp_group_mapping = oci.identity.IdpGroupMapping("test_idp_group_mapping",
        group_id=test_group["id"],
        identity_provider_id=test_identity_provider["id"],
        idp_group_name=idp_group_mapping_idp_group_name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Identity"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Identity.NewIdpGroupMapping(ctx, "test_idp_group_mapping", &Identity.IdpGroupMappingArgs{
    			GroupId:            pulumi.Any(testGroup.Id),
    			IdentityProviderId: pulumi.Any(testIdentityProvider.Id),
    			IdpGroupName:       pulumi.Any(idpGroupMappingIdpGroupName),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testIdpGroupMapping = new Oci.Identity.IdpGroupMapping("test_idp_group_mapping", new()
        {
            GroupId = testGroup.Id,
            IdentityProviderId = testIdentityProvider.Id,
            IdpGroupName = idpGroupMappingIdpGroupName,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Identity.IdpGroupMapping;
    import com.pulumi.oci.Identity.IdpGroupMappingArgs;
    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 testIdpGroupMapping = new IdpGroupMapping("testIdpGroupMapping", IdpGroupMappingArgs.builder()
                .groupId(testGroup.id())
                .identityProviderId(testIdentityProvider.id())
                .idpGroupName(idpGroupMappingIdpGroupName)
                .build());
    
        }
    }
    
    resources:
      testIdpGroupMapping:
        type: oci:Identity:IdpGroupMapping
        name: test_idp_group_mapping
        properties:
          groupId: ${testGroup.id}
          identityProviderId: ${testIdentityProvider.id}
          idpGroupName: ${idpGroupMappingIdpGroupName}
    

    Create IdpGroupMapping Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new IdpGroupMapping(name: string, args: IdpGroupMappingArgs, opts?: CustomResourceOptions);
    @overload
    def IdpGroupMapping(resource_name: str,
                        args: IdpGroupMappingArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def IdpGroupMapping(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        group_id: Optional[str] = None,
                        identity_provider_id: Optional[str] = None,
                        idp_group_name: Optional[str] = None)
    func NewIdpGroupMapping(ctx *Context, name string, args IdpGroupMappingArgs, opts ...ResourceOption) (*IdpGroupMapping, error)
    public IdpGroupMapping(string name, IdpGroupMappingArgs args, CustomResourceOptions? opts = null)
    public IdpGroupMapping(String name, IdpGroupMappingArgs args)
    public IdpGroupMapping(String name, IdpGroupMappingArgs args, CustomResourceOptions options)
    
    type: oci:Identity:IdpGroupMapping
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

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

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var idpGroupMappingResource = new Oci.Identity.IdpGroupMapping("idpGroupMappingResource", new()
    {
        GroupId = "string",
        IdentityProviderId = "string",
        IdpGroupName = "string",
    });
    
    example, err := Identity.NewIdpGroupMapping(ctx, "idpGroupMappingResource", &Identity.IdpGroupMappingArgs{
    	GroupId:            pulumi.String("string"),
    	IdentityProviderId: pulumi.String("string"),
    	IdpGroupName:       pulumi.String("string"),
    })
    
    var idpGroupMappingResource = new IdpGroupMapping("idpGroupMappingResource", IdpGroupMappingArgs.builder()
        .groupId("string")
        .identityProviderId("string")
        .idpGroupName("string")
        .build());
    
    idp_group_mapping_resource = oci.identity.IdpGroupMapping("idpGroupMappingResource",
        group_id="string",
        identity_provider_id="string",
        idp_group_name="string")
    
    const idpGroupMappingResource = new oci.identity.IdpGroupMapping("idpGroupMappingResource", {
        groupId: "string",
        identityProviderId: "string",
        idpGroupName: "string",
    });
    
    type: oci:Identity:IdpGroupMapping
    properties:
        groupId: string
        identityProviderId: string
        idpGroupName: string
    

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

    GroupId string
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    IdentityProviderId string
    The OCID of the identity provider.
    IdpGroupName string

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    GroupId string
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    IdentityProviderId string
    The OCID of the identity provider.
    IdpGroupName string

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    groupId String
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    identityProviderId String
    The OCID of the identity provider.
    idpGroupName String

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    groupId string
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    identityProviderId string
    The OCID of the identity provider.
    idpGroupName string

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    group_id str
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    identity_provider_id str
    The OCID of the identity provider.
    idp_group_name str

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    groupId String
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    identityProviderId String
    The OCID of the identity provider.
    idpGroupName String

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    Outputs

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

    CompartmentId string
    The OCID of the tenancy containing the IdentityProvider.
    Id string
    The provider-assigned unique ID for this managed resource.
    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    State string
    The mapping's current state.
    TimeCreated string
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    The OCID of the tenancy containing the IdentityProvider.
    Id string
    The provider-assigned unique ID for this managed resource.
    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    State string
    The mapping's current state.
    TimeCreated string
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the tenancy containing the IdentityProvider.
    id String
    The provider-assigned unique ID for this managed resource.
    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    state String
    The mapping's current state.
    timeCreated String
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    The OCID of the tenancy containing the IdentityProvider.
    id string
    The provider-assigned unique ID for this managed resource.
    inactiveState string
    The detailed status of INACTIVE lifecycleState.
    state string
    The mapping's current state.
    timeCreated string
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartment_id str
    The OCID of the tenancy containing the IdentityProvider.
    id str
    The provider-assigned unique ID for this managed resource.
    inactive_state str
    The detailed status of INACTIVE lifecycleState.
    state str
    The mapping's current state.
    time_created str
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the tenancy containing the IdentityProvider.
    id String
    The provider-assigned unique ID for this managed resource.
    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    state String
    The mapping's current state.
    timeCreated String
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Look up Existing IdpGroupMapping Resource

    Get an existing IdpGroupMapping 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?: IdpGroupMappingState, opts?: CustomResourceOptions): IdpGroupMapping
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            group_id: Optional[str] = None,
            identity_provider_id: Optional[str] = None,
            idp_group_name: Optional[str] = None,
            inactive_state: Optional[str] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None) -> IdpGroupMapping
    func GetIdpGroupMapping(ctx *Context, name string, id IDInput, state *IdpGroupMappingState, opts ...ResourceOption) (*IdpGroupMapping, error)
    public static IdpGroupMapping Get(string name, Input<string> id, IdpGroupMappingState? state, CustomResourceOptions? opts = null)
    public static IdpGroupMapping get(String name, Output<String> id, IdpGroupMappingState 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:
    CompartmentId string
    The OCID of the tenancy containing the IdentityProvider.
    GroupId string
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    IdentityProviderId string
    The OCID of the identity provider.
    IdpGroupName string

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    State string
    The mapping's current state.
    TimeCreated string
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    The OCID of the tenancy containing the IdentityProvider.
    GroupId string
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    IdentityProviderId string
    The OCID of the identity provider.
    IdpGroupName string

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    State string
    The mapping's current state.
    TimeCreated string
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the tenancy containing the IdentityProvider.
    groupId String
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    identityProviderId String
    The OCID of the identity provider.
    idpGroupName String

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    state String
    The mapping's current state.
    timeCreated String
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    The OCID of the tenancy containing the IdentityProvider.
    groupId string
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    identityProviderId string
    The OCID of the identity provider.
    idpGroupName string

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    inactiveState string
    The detailed status of INACTIVE lifecycleState.
    state string
    The mapping's current state.
    timeCreated string
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartment_id str
    The OCID of the tenancy containing the IdentityProvider.
    group_id str
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    identity_provider_id str
    The OCID of the identity provider.
    idp_group_name str

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    inactive_state str
    The detailed status of INACTIVE lifecycleState.
    state str
    The mapping's current state.
    time_created str
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of the tenancy containing the IdentityProvider.
    groupId String
    (Updatable) The OCID of the IAM Service group you want to map to the IdP group.
    identityProviderId String
    The OCID of the identity provider.
    idpGroupName String

    (Updatable) The name of the IdP group you want to map.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    state String
    The mapping's current state.
    timeCreated String
    Date and time the mapping was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Import

    IdpGroupMappings can be imported using the id, e.g.

    $ pulumi import oci:Identity/idpGroupMapping:IdpGroupMapping test_idp_group_mapping "identityProviders/{identityProviderId}/groupMappings/{mappingId}"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi