Oracle Cloud Infrastructure v2.17.0, Nov 15 24

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

oci.Identity.getIdentityProviders

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

Lists all the identity providers in your tenancy. You must specify the identity provider type (e.g., SAML2 for identity providers using the SAML2.0 protocol). You must specify your tenancy’s OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See Where to Get the Tenancy’s OCID and User’s OCID.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testIdentityProviders = oci.Identity.getIdentityProviders({
    compartmentId: tenancyOcid,
    protocol: identityProviderProtocol,
    name: identityProviderName,
    state: identityProviderState,
});

import pulumi
import pulumi_oci as oci

test_identity_providers = oci.Identity.get_identity_providers(compartment_id=tenancy_ocid,
    protocol=identity_provider_protocol,
    name=identity_provider_name,
    state=identity_provider_state)

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.GetIdentityProviders(ctx, &identity.GetIdentityProvidersArgs{
			CompartmentId: tenancyOcid,
			Protocol:      identityProviderProtocol,
			Name:          pulumi.StringRef(identityProviderName),
			State:         pulumi.StringRef(identityProviderState),
		}, 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 testIdentityProviders = Oci.Identity.GetIdentityProviders.Invoke(new()
    {
        CompartmentId = tenancyOcid,
        Protocol = identityProviderProtocol,
        Name = identityProviderName,
        State = identityProviderState,
    });

});

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.GetIdentityProvidersArgs;
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 testIdentityProviders = IdentityFunctions.getIdentityProviders(GetIdentityProvidersArgs.builder()
            .compartmentId(tenancyOcid)
            .protocol(identityProviderProtocol)
            .name(identityProviderName)
            .state(identityProviderState)
            .build());

    }
}

variables:
  testIdentityProviders:
    fn::invoke:
      Function: oci:Identity:getIdentityProviders
      Arguments:
        compartmentId: ${tenancyOcid}
        protocol: ${identityProviderProtocol}
        name: ${identityProviderName}
        state: ${identityProviderState}

Using getIdentityProviders

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 getIdentityProviders(args: GetIdentityProvidersArgs, opts?: InvokeOptions): Promise<GetIdentityProvidersResult>
function getIdentityProvidersOutput(args: GetIdentityProvidersOutputArgs, opts?: InvokeOptions): Output<GetIdentityProvidersResult>

def get_identity_providers(compartment_id: Optional[str] = None,
                           filters: Optional[Sequence[_identity.GetIdentityProvidersFilter]] = None,
                           name: Optional[str] = None,
                           protocol: Optional[str] = None,
                           state: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetIdentityProvidersResult
def get_identity_providers_output(compartment_id: Optional[pulumi.Input[str]] = None,
                           filters: Optional[pulumi.Input[Sequence[pulumi.Input[_identity.GetIdentityProvidersFilterArgs]]]] = None,
                           name: Optional[pulumi.Input[str]] = None,
                           protocol: Optional[pulumi.Input[str]] = None,
                           state: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetIdentityProvidersResult]

func GetIdentityProviders(ctx *Context, args *GetIdentityProvidersArgs, opts ...InvokeOption) (*GetIdentityProvidersResult, error)
func GetIdentityProvidersOutput(ctx *Context, args *GetIdentityProvidersOutputArgs, opts ...InvokeOption) GetIdentityProvidersResultOutput

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

public static class GetIdentityProviders 
{
    public static Task<GetIdentityProvidersResult> InvokeAsync(GetIdentityProvidersArgs args, InvokeOptions? opts = null)
    public static Output<GetIdentityProvidersResult> Invoke(GetIdentityProvidersInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIdentityProvidersResult> getIdentityProviders(GetIdentityProvidersArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:Identity/getIdentityProviders:getIdentityProviders
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
Protocol string: The protocol used for federation.
Filters List<GetIdentityProvidersFilter>
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.

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
Protocol string: The protocol used for federation.
Filters []GetIdentityProvidersFilter
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.

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
protocol String: The protocol used for federation.
filters List<GetProvidersFilter>
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.

compartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
protocol string: The protocol used for federation.
filters GetIdentityProvidersFilter[]
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.

compartment_id str: The OCID of the compartment (remember that the tenancy is simply the root compartment).
protocol str: The protocol used for federation.
filters Sequence[identity.GetIdentityProvidersFilter]
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.

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
protocol String: The protocol used for federation.
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.

getIdentityProviders Result

The following output properties are available:

CompartmentId string: The OCID of the tenancy containing the IdentityProvider.
Id string: The provider-assigned unique ID for this managed resource.
IdentityProviders List<GetIdentityProvidersIdentityProvider>: The list of identity_providers.
Protocol string: The protocol used for federation. Allowed value: SAML2. Example: SAML2
Filters List<GetIdentityProvidersFilter>
Name string: The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console.
State string: The current state.

CompartmentId string: The OCID of the tenancy containing the IdentityProvider.
Id string: The provider-assigned unique ID for this managed resource.
IdentityProviders []GetIdentityProvidersIdentityProvider: The list of identity_providers.
Protocol string: The protocol used for federation. Allowed value: SAML2. Example: SAML2
Filters []GetIdentityProvidersFilter
Name string: The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console.
State string: The current state.

compartmentId String: The OCID of the tenancy containing the IdentityProvider.
id String: The provider-assigned unique ID for this managed resource.
identityProviders List<GetProvidersProvider>: The list of identity_providers.
protocol String: The protocol used for federation. Allowed value: SAML2. Example: SAML2
filters List<GetProvidersFilter>
name String: The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console.
state String: The current state.

compartmentId string: The OCID of the tenancy containing the IdentityProvider.
id string: The provider-assigned unique ID for this managed resource.
identityProviders GetIdentityProvidersIdentityProvider[]: The list of identity_providers.
protocol string: The protocol used for federation. Allowed value: SAML2. Example: SAML2
filters GetIdentityProvidersFilter[]
name string: The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console.
state string: The current state.

compartment_id str: The OCID of the tenancy containing the IdentityProvider.
id str: The provider-assigned unique ID for this managed resource.
identity_providers Sequence[identity.GetIdentityProvidersIdentityProvider]: The list of identity_providers.
protocol str: The protocol used for federation. Allowed value: SAML2. Example: SAML2
filters Sequence[identity.GetIdentityProvidersFilter]
name str: The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console.
state str: The current state.

compartmentId String: The OCID of the tenancy containing the IdentityProvider.
id String: The provider-assigned unique ID for this managed resource.
identityProviders List<Property Map>: The list of identity_providers.
protocol String: The protocol used for federation. Allowed value: SAML2. Example: SAML2
filters List<Property Map>
name String: The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console.
state String: The current state.

Supporting Types

GetIdentityProvidersFilter

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

GetIdentityProvidersIdentityProvider

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
FreeformAttributes Dictionary<string, string>: Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the IdentityProvider.
InactiveState string: The detailed status of INACTIVE lifecycleState.
Metadata string: The XML that contains the information required for federating Identity with SAML2 Identity Provider.
MetadataUrl string: The URL for retrieving the identity provider's metadata, which contains information required for federating.
Name string: A filter to only return resources that match the given name exactly.
ProductType string: The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).
Protocol string: The protocol used for federation.
RedirectUrl string: The URL to redirect federated users to for authentication with the identity provider.
SigningCertificate string: The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
TimeCreated string: Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

CompartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
FreeformAttributes map[string]string: Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of the IdentityProvider.
InactiveState string: The detailed status of INACTIVE lifecycleState.
Metadata string: The XML that contains the information required for federating Identity with SAML2 Identity Provider.
MetadataUrl string: The URL for retrieving the identity provider's metadata, which contains information required for federating.
Name string: A filter to only return resources that match the given name exactly.
ProductType string: The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).
Protocol string: The protocol used for federation.
RedirectUrl string: The URL to redirect federated users to for authentication with the identity provider.
SigningCertificate string: The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
State string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
TimeCreated string: Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
freeformAttributes Map<String,String>: Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the IdentityProvider.
inactiveState String: The detailed status of INACTIVE lifecycleState.
metadata String: The XML that contains the information required for federating Identity with SAML2 Identity Provider.
metadataUrl String: The URL for retrieving the identity provider's metadata, which contains information required for federating.
name String: A filter to only return resources that match the given name exactly.
productType String: The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).
protocol String: The protocol used for federation.
redirectUrl String: The URL to redirect federated users to for authentication with the identity provider.
signingCertificate String: The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated String: Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId string: The OCID of the compartment (remember that the tenancy is simply the root compartment).
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
freeformAttributes {[key: string]: string}: Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of the IdentityProvider.
inactiveState string: The detailed status of INACTIVE lifecycleState.
metadata string: The XML that contains the information required for federating Identity with SAML2 Identity Provider.
metadataUrl string: The URL for retrieving the identity provider's metadata, which contains information required for federating.
name string: A filter to only return resources that match the given name exactly.
productType string: The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).
protocol string: The protocol used for federation.
redirectUrl string: The URL to redirect federated users to for authentication with the identity provider.
signingCertificate string: The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
state string: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated string: Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartment_id str: The OCID of the compartment (remember that the tenancy is simply the root compartment).
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
freeform_attributes Mapping[str, str]: Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of the IdentityProvider.
inactive_state str: The detailed status of INACTIVE lifecycleState.
metadata str: The XML that contains the information required for federating Identity with SAML2 Identity Provider.
metadata_url str: The URL for retrieving the identity provider's metadata, which contains information required for federating.
name str: A filter to only return resources that match the given name exactly.
product_type str: The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).
protocol str: The protocol used for federation.
redirect_url str: The URL to redirect federated users to for authentication with the identity provider.
signing_certificate str: The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
state str: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
time_created str: Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

compartmentId String: The OCID of the compartment (remember that the tenancy is simply the root compartment).
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
freeformAttributes Map<String>: Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of the IdentityProvider.
inactiveState String: The detailed status of INACTIVE lifecycleState.
metadata String: The XML that contains the information required for federating Identity with SAML2 Identity Provider.
metadataUrl String: The URL for retrieving the identity provider's metadata, which contains information required for federating.
name String: A filter to only return resources that match the given name exactly.
productType String: The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS).
protocol String: The protocol used for federation.
redirectUrl String: The URL to redirect federated users to for authentication with the identity provider.
signingCertificate String: The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
state String: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
timeCreated String: Date and time the IdentityProvider was created, 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.

Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi

pulumi/pulumi-oci

oci.Identity.getIdentityProviders

On this page

On this page

Example Usage

Using getIdentityProviders

getIdentityProviders Result

Supporting Types

GetIdentityProvidersFilter

GetIdentityProvidersIdentityProvider

Package Details

On this page

On this page