1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. getIdentityProviderGroups
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

oci.Identity.getIdentityProviderGroups

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    This data source provides the list of Identity Provider Groups in Oracle Cloud Infrastructure Identity service.

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

    Lists the identity provider groups.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testIdentityProviderGroups = oci.Identity.getIdentityProviderGroups({
        identityProviderId: testIdentityProvider.id,
        name: identityProviderGroupName,
        state: identityProviderGroupState,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_identity_provider_groups = oci.Identity.get_identity_provider_groups(identity_provider_id=test_identity_provider["id"],
        name=identity_provider_group_name,
        state=identity_provider_group_state)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/go/oci/Identity"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Identity.GetIdentityProviderGroups(ctx, &identity.GetIdentityProviderGroupsArgs{
    			IdentityProviderId: testIdentityProvider.Id,
    			Name:               pulumi.StringRef(identityProviderGroupName),
    			State:              pulumi.StringRef(identityProviderGroupState),
    		}, nil)
    		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 testIdentityProviderGroups = Oci.Identity.GetIdentityProviderGroups.Invoke(new()
        {
            IdentityProviderId = testIdentityProvider.Id,
            Name = identityProviderGroupName,
            State = identityProviderGroupState,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Identity.IdentityFunctions;
    import com.pulumi.oci.Identity.inputs.GetIdentityProviderGroupsArgs;
    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) {
            final var testIdentityProviderGroups = IdentityFunctions.getIdentityProviderGroups(GetIdentityProviderGroupsArgs.builder()
                .identityProviderId(testIdentityProvider.id())
                .name(identityProviderGroupName)
                .state(identityProviderGroupState)
                .build());
    
        }
    }
    
    variables:
      testIdentityProviderGroups:
        fn::invoke:
          Function: oci:Identity:getIdentityProviderGroups
          Arguments:
            identityProviderId: ${testIdentityProvider.id}
            name: ${identityProviderGroupName}
            state: ${identityProviderGroupState}
    

    Using getIdentityProviderGroups

    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 getIdentityProviderGroups(args: GetIdentityProviderGroupsArgs, opts?: InvokeOptions): Promise<GetIdentityProviderGroupsResult>
    function getIdentityProviderGroupsOutput(args: GetIdentityProviderGroupsOutputArgs, opts?: InvokeOptions): Output<GetIdentityProviderGroupsResult>
    def get_identity_provider_groups(filters: Optional[Sequence[_identity.GetIdentityProviderGroupsFilter]] = None,
                                     identity_provider_id: Optional[str] = None,
                                     name: Optional[str] = None,
                                     state: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetIdentityProviderGroupsResult
    def get_identity_provider_groups_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[_identity.GetIdentityProviderGroupsFilterArgs]]]] = None,
                                     identity_provider_id: Optional[pulumi.Input[str]] = None,
                                     name: Optional[pulumi.Input[str]] = None,
                                     state: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetIdentityProviderGroupsResult]
    func GetIdentityProviderGroups(ctx *Context, args *GetIdentityProviderGroupsArgs, opts ...InvokeOption) (*GetIdentityProviderGroupsResult, error)
    func GetIdentityProviderGroupsOutput(ctx *Context, args *GetIdentityProviderGroupsOutputArgs, opts ...InvokeOption) GetIdentityProviderGroupsResultOutput

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

    public static class GetIdentityProviderGroups 
    {
        public static Task<GetIdentityProviderGroupsResult> InvokeAsync(GetIdentityProviderGroupsArgs args, InvokeOptions? opts = null)
        public static Output<GetIdentityProviderGroupsResult> Invoke(GetIdentityProviderGroupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetIdentityProviderGroupsResult> getIdentityProviderGroups(GetIdentityProviderGroupsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: oci:Identity/getIdentityProviderGroups:getIdentityProviderGroups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    IdentityProviderId string
    The OCID of the identity provider.
    Filters List<GetIdentityProviderGroupsFilter>
    Name string
    A filter to only return resources that match the given name exactly.
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    IdentityProviderId string
    The OCID of the identity provider.
    Filters []GetIdentityProviderGroupsFilter
    Name string
    A filter to only return resources that match the given name exactly.
    State string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    identityProviderId String
    The OCID of the identity provider.
    filters List<GetProviderGroupsFilter>
    name String
    A filter to only return resources that match the given name exactly.
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    identityProviderId string
    The OCID of the identity provider.
    filters GetIdentityProviderGroupsFilter[]
    name string
    A filter to only return resources that match the given name exactly.
    state string
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    identity_provider_id str
    The OCID of the identity provider.
    filters Sequence[identity.GetIdentityProviderGroupsFilter]
    name str
    A filter to only return resources that match the given name exactly.
    state str
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
    identityProviderId String
    The OCID of the identity provider.
    filters List<Property Map>
    name String
    A filter to only return resources that match the given name exactly.
    state String
    A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    getIdentityProviderGroups Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderGroups List<GetIdentityProviderGroupsIdentityProviderGroup>
    The list of identity_provider_groups.
    IdentityProviderId string
    The OCID of the IdentityProvider this group belongs to.
    Filters List<GetIdentityProviderGroupsFilter>
    Name string
    Display name of the group
    State string
    Id string
    The provider-assigned unique ID for this managed resource.
    IdentityProviderGroups []GetIdentityProviderGroupsIdentityProviderGroup
    The list of identity_provider_groups.
    IdentityProviderId string
    The OCID of the IdentityProvider this group belongs to.
    Filters []GetIdentityProviderGroupsFilter
    Name string
    Display name of the group
    State string
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderGroups List<GetProviderGroupsProviderGroup>
    The list of identity_provider_groups.
    identityProviderId String
    The OCID of the IdentityProvider this group belongs to.
    filters List<GetProviderGroupsFilter>
    name String
    Display name of the group
    state String
    id string
    The provider-assigned unique ID for this managed resource.
    identityProviderGroups GetIdentityProviderGroupsIdentityProviderGroup[]
    The list of identity_provider_groups.
    identityProviderId string
    The OCID of the IdentityProvider this group belongs to.
    filters GetIdentityProviderGroupsFilter[]
    name string
    Display name of the group
    state string
    id str
    The provider-assigned unique ID for this managed resource.
    identity_provider_groups Sequence[identity.GetIdentityProviderGroupsIdentityProviderGroup]
    The list of identity_provider_groups.
    identity_provider_id str
    The OCID of the IdentityProvider this group belongs to.
    filters Sequence[identity.GetIdentityProviderGroupsFilter]
    name str
    Display name of the group
    state str
    id String
    The provider-assigned unique ID for this managed resource.
    identityProviderGroups List<Property Map>
    The list of identity_provider_groups.
    identityProviderId String
    The OCID of the IdentityProvider this group belongs to.
    filters List<Property Map>
    name String
    Display name of the group
    state String

    Supporting Types

    GetIdentityProviderGroupsFilter

    Name string
    A filter to only return resources that match the given name exactly.
    Values List<string>
    Regex bool
    Name string
    A filter to only return resources that match the given name exactly.
    Values []string
    Regex bool
    name String
    A filter to only return resources that match the given name exactly.
    values List<String>
    regex Boolean
    name string
    A filter to only return resources that match the given name exactly.
    values string[]
    regex boolean
    name str
    A filter to only return resources that match the given name exactly.
    values Sequence[str]
    regex bool
    name String
    A filter to only return resources that match the given name exactly.
    values List<String>
    regex Boolean

    GetIdentityProviderGroupsIdentityProviderGroup

    DisplayName string
    Display name of the group
    ExternalIdentifier string
    Identifier of the group in the identity provider
    Id string
    The OCID of the IdentityProviderGroup.
    IdentityProviderId string
    The OCID of the identity provider.
    Name string
    A filter to only return resources that match the given name exactly.
    TimeCreated string
    Date and time the IdentityProviderGroup was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeModified string
    Date and time the IdentityProviderGroup was last modified, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    DisplayName string
    Display name of the group
    ExternalIdentifier string
    Identifier of the group in the identity provider
    Id string
    The OCID of the IdentityProviderGroup.
    IdentityProviderId string
    The OCID of the identity provider.
    Name string
    A filter to only return resources that match the given name exactly.
    TimeCreated string
    Date and time the IdentityProviderGroup was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    TimeModified string
    Date and time the IdentityProviderGroup was last modified, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    displayName String
    Display name of the group
    externalIdentifier String
    Identifier of the group in the identity provider
    id String
    The OCID of the IdentityProviderGroup.
    identityProviderId String
    The OCID of the identity provider.
    name String
    A filter to only return resources that match the given name exactly.
    timeCreated String
    Date and time the IdentityProviderGroup was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeModified String
    Date and time the IdentityProviderGroup was last modified, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    displayName string
    Display name of the group
    externalIdentifier string
    Identifier of the group in the identity provider
    id string
    The OCID of the IdentityProviderGroup.
    identityProviderId string
    The OCID of the identity provider.
    name string
    A filter to only return resources that match the given name exactly.
    timeCreated string
    Date and time the IdentityProviderGroup was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeModified string
    Date and time the IdentityProviderGroup was last modified, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    display_name str
    Display name of the group
    external_identifier str
    Identifier of the group in the identity provider
    id str
    The OCID of the IdentityProviderGroup.
    identity_provider_id str
    The OCID of the identity provider.
    name str
    A filter to only return resources that match the given name exactly.
    time_created str
    Date and time the IdentityProviderGroup was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    time_modified str
    Date and time the IdentityProviderGroup was last modified, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    displayName String
    Display name of the group
    externalIdentifier String
    Identifier of the group in the identity provider
    id String
    The OCID of the IdentityProviderGroup.
    identityProviderId String
    The OCID of the identity provider.
    name String
    A filter to only return resources that match the given name exactly.
    timeCreated String
    Date and time the IdentityProviderGroup was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    timeModified String
    Date and time the IdentityProviderGroup was last modified, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    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 v1.40.0 published on Wednesday, Jun 12, 2024 by Pulumi