Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Platform Provider
  3. API Docs
  4. OidcConfiguration
platform 2.2.1 published on Friday, Mar 7, 2025 by jfrog
jfrog/terraform-provider-platform

platform.OidcConfiguration

Explore with Pulumi AI

platform logo
platform 2.2.1 published on Friday, Mar 7, 2025 by jfrog
jfrog/terraform-provider-platform

    Manage OIDC configuration in JFrog platform. See the JFrog OIDC configuration documentation for more information.

    Example Usage

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

const my_github_oidc_configuration = new platform.OidcConfiguration("my-github-oidc-configuration", {
    audience: "jfrog-github",
    description: "My GitHub OIDC configuration",
    issuerUrl: "https://token.actions.githubusercontent.com",
    providerType: "GitHub",
});
const my_github_oidc_enterprise_configuration = new platform.OidcConfiguration("my-github-oidc-enterprise-configuration", {
    audience: "jfrog-github",
    description: "My GitHub OIDC enterprise configuration",
    issuerUrl: "https://token.actions.githubusercontent.com/jfrog",
    providerType: "GitHub",
});
const my_generic_oidc_configuration = new platform.OidcConfiguration("my-generic-oidc-configuration", {
    audience: "jfrog-generic",
    description: "My generic OIDC configuration",
    issuerUrl: "https://tempurl.org",
    providerType: "generic",
});

    import pulumi
import pulumi_platform as platform

my_github_oidc_configuration = platform.OidcConfiguration("my-github-oidc-configuration",
    audience="jfrog-github",
    description="My GitHub OIDC configuration",
    issuer_url="https://token.actions.githubusercontent.com",
    provider_type="GitHub")
my_github_oidc_enterprise_configuration = platform.OidcConfiguration("my-github-oidc-enterprise-configuration",
    audience="jfrog-github",
    description="My GitHub OIDC enterprise configuration",
    issuer_url="https://token.actions.githubusercontent.com/jfrog",
    provider_type="GitHub")
my_generic_oidc_configuration = platform.OidcConfiguration("my-generic-oidc-configuration",
    audience="jfrog-generic",
    description="My generic OIDC configuration",
    issuer_url="https://tempurl.org",
    provider_type="generic")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/platform/v2/platform"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := platform.NewOidcConfiguration(ctx, "my-github-oidc-configuration", &platform.OidcConfigurationArgs{
			Audience:     pulumi.String("jfrog-github"),
			Description:  pulumi.String("My GitHub OIDC configuration"),
			IssuerUrl:    pulumi.String("https://token.actions.githubusercontent.com"),
			ProviderType: pulumi.String("GitHub"),
		})
		if err != nil {
			return err
		}
		_, err = platform.NewOidcConfiguration(ctx, "my-github-oidc-enterprise-configuration", &platform.OidcConfigurationArgs{
			Audience:     pulumi.String("jfrog-github"),
			Description:  pulumi.String("My GitHub OIDC enterprise configuration"),
			IssuerUrl:    pulumi.String("https://token.actions.githubusercontent.com/jfrog"),
			ProviderType: pulumi.String("GitHub"),
		})
		if err != nil {
			return err
		}
		_, err = platform.NewOidcConfiguration(ctx, "my-generic-oidc-configuration", &platform.OidcConfigurationArgs{
			Audience:     pulumi.String("jfrog-generic"),
			Description:  pulumi.String("My generic OIDC configuration"),
			IssuerUrl:    pulumi.String("https://tempurl.org"),
			ProviderType: pulumi.String("generic"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Platform = Pulumi.Platform;

return await Deployment.RunAsync(() => 
{
    var my_github_oidc_configuration = new Platform.OidcConfiguration("my-github-oidc-configuration", new()
    {
        Audience = "jfrog-github",
        Description = "My GitHub OIDC configuration",
        IssuerUrl = "https://token.actions.githubusercontent.com",
        ProviderType = "GitHub",
    });

    var my_github_oidc_enterprise_configuration = new Platform.OidcConfiguration("my-github-oidc-enterprise-configuration", new()
    {
        Audience = "jfrog-github",
        Description = "My GitHub OIDC enterprise configuration",
        IssuerUrl = "https://token.actions.githubusercontent.com/jfrog",
        ProviderType = "GitHub",
    });

    var my_generic_oidc_configuration = new Platform.OidcConfiguration("my-generic-oidc-configuration", new()
    {
        Audience = "jfrog-generic",
        Description = "My generic OIDC configuration",
        IssuerUrl = "https://tempurl.org",
        ProviderType = "generic",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.platform.OidcConfiguration;
import com.pulumi.platform.OidcConfigurationArgs;
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 my_github_oidc_configuration = new OidcConfiguration("my-github-oidc-configuration", OidcConfigurationArgs.builder()
            .audience("jfrog-github")
            .description("My GitHub OIDC configuration")
            .issuerUrl("https://token.actions.githubusercontent.com")
            .providerType("GitHub")
            .build());

        var my_github_oidc_enterprise_configuration = new OidcConfiguration("my-github-oidc-enterprise-configuration", OidcConfigurationArgs.builder()
            .audience("jfrog-github")
            .description("My GitHub OIDC enterprise configuration")
            .issuerUrl("https://token.actions.githubusercontent.com/jfrog")
            .providerType("GitHub")
            .build());

        var my_generic_oidc_configuration = new OidcConfiguration("my-generic-oidc-configuration", OidcConfigurationArgs.builder()
            .audience("jfrog-generic")
            .description("My generic OIDC configuration")
            .issuerUrl("https://tempurl.org")
            .providerType("generic")
            .build());

    }
}

    resources:
  my-github-oidc-configuration:
    type: platform:OidcConfiguration
    properties:
      audience: jfrog-github
      description: My GitHub OIDC configuration
      issuerUrl: https://token.actions.githubusercontent.com
      providerType: GitHub
  my-github-oidc-enterprise-configuration:
    type: platform:OidcConfiguration
    properties:
      audience: jfrog-github
      description: My GitHub OIDC enterprise configuration
      issuerUrl: https://token.actions.githubusercontent.com/jfrog
      providerType: GitHub
  my-generic-oidc-configuration:
    type: platform:OidcConfiguration
    properties:
      audience: jfrog-generic
      description: My generic OIDC configuration
      issuerUrl: https://tempurl.org
      providerType: generic

    Create OidcConfiguration Resource

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

    Constructor syntax

    new OidcConfiguration(name: string, args: OidcConfigurationArgs, opts?: CustomResourceOptions);
    @overload
def OidcConfiguration(resource_name: str,
                      args: OidcConfigurationArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def OidcConfiguration(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      issuer_url: Optional[str] = None,
                      provider_type: Optional[str] = None,
                      audience: Optional[str] = None,
                      description: Optional[str] = None,
                      name: Optional[str] = None,
                      project_key: Optional[str] = None,
                      use_default_proxy: Optional[bool] = None)
    func NewOidcConfiguration(ctx *Context, name string, args OidcConfigurationArgs, opts ...ResourceOption) (*OidcConfiguration, error)
    public OidcConfiguration(string name, OidcConfigurationArgs args, CustomResourceOptions? opts = null)
    public OidcConfiguration(String name, OidcConfigurationArgs args)
public OidcConfiguration(String name, OidcConfigurationArgs args, CustomResourceOptions options)

    type: platform:OidcConfiguration
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 OidcConfigurationArgs
    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 OidcConfigurationArgs
    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 OidcConfigurationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OidcConfigurationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OidcConfigurationArgs
    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 oidcConfigurationResource = new Platform.OidcConfiguration("oidcConfigurationResource", new()
{
    IssuerUrl = "string",
    ProviderType = "string",
    Audience = "string",
    Description = "string",
    Name = "string",
    ProjectKey = "string",
    UseDefaultProxy = false,
});

    example, err := platform.NewOidcConfiguration(ctx, "oidcConfigurationResource", &platform.OidcConfigurationArgs{
IssuerUrl: pulumi.String("string"),
ProviderType: pulumi.String("string"),
Audience: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
ProjectKey: pulumi.String("string"),
UseDefaultProxy: pulumi.Bool(false),
})

    var oidcConfigurationResource = new OidcConfiguration("oidcConfigurationResource", OidcConfigurationArgs.builder()
    .issuerUrl("string")
    .providerType("string")
    .audience("string")
    .description("string")
    .name("string")
    .projectKey("string")
    .useDefaultProxy(false)
    .build());

    oidc_configuration_resource = platform.OidcConfiguration("oidcConfigurationResource",
    issuer_url="string",
    provider_type="string",
    audience="string",
    description="string",
    name="string",
    project_key="string",
    use_default_proxy=False)

    const oidcConfigurationResource = new platform.OidcConfiguration("oidcConfigurationResource", {
    issuerUrl: "string",
    providerType: "string",
    audience: "string",
    description: "string",
    name: "string",
    projectKey: "string",
    useDefaultProxy: false,
});

    type: platform:OidcConfiguration
properties:
    audience: string
    description: string
    issuerUrl: string
    name: string
    projectKey: string
    providerType: string
    useDefaultProxy: false

    OidcConfiguration Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OidcConfiguration resource accepts the following input properties:

    IssuerUrl string
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    ProviderType string
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    Audience string
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    Description string
    Description of the OIDC provider
    Name string
    Name of the OIDC provider
    ProjectKey string
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    UseDefaultProxy bool
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    IssuerUrl string
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    ProviderType string
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    Audience string
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    Description string
    Description of the OIDC provider
    Name string
    Name of the OIDC provider
    ProjectKey string
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    UseDefaultProxy bool
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    issuerUrl String
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    providerType String
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    audience String
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    description String
    Description of the OIDC provider
    name String
    Name of the OIDC provider
    projectKey String
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    useDefaultProxy Boolean
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    issuerUrl string
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    providerType string
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    audience string
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    description string
    Description of the OIDC provider
    name string
    Name of the OIDC provider
    projectKey string
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    useDefaultProxy boolean
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    issuer_url str
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    provider_type str
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    audience str
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    description str
    Description of the OIDC provider
    name str
    Name of the OIDC provider
    project_key str
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    use_default_proxy bool
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    issuerUrl String
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    providerType String
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    audience String
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    description String
    Description of the OIDC provider
    name String
    Name of the OIDC provider
    projectKey String
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    useDefaultProxy Boolean
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OidcConfiguration 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 Existing OidcConfiguration Resource

    Get an existing OidcConfiguration 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?: OidcConfigurationState, opts?: CustomResourceOptions): OidcConfiguration
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        audience: Optional[str] = None,
        description: Optional[str] = None,
        issuer_url: Optional[str] = None,
        name: Optional[str] = None,
        project_key: Optional[str] = None,
        provider_type: Optional[str] = None,
        use_default_proxy: Optional[bool] = None) -> OidcConfiguration
    func GetOidcConfiguration(ctx *Context, name string, id IDInput, state *OidcConfigurationState, opts ...ResourceOption) (*OidcConfiguration, error)
    public static OidcConfiguration Get(string name, Input<string> id, OidcConfigurationState? state, CustomResourceOptions? opts = null)
    public static OidcConfiguration get(String name, Output<String> id, OidcConfigurationState state, CustomResourceOptions options)
    resources:  _:    type: platform:OidcConfiguration    get:      id: ${id}
    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:
    Audience string
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    Description string
    Description of the OIDC provider
    IssuerUrl string
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    Name string
    Name of the OIDC provider
    ProjectKey string
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    ProviderType string
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    UseDefaultProxy bool
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    Audience string
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    Description string
    Description of the OIDC provider
    IssuerUrl string
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    Name string
    Name of the OIDC provider
    ProjectKey string
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    ProviderType string
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    UseDefaultProxy bool
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    audience String
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    description String
    Description of the OIDC provider
    issuerUrl String
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    name String
    Name of the OIDC provider
    projectKey String
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    providerType String
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    useDefaultProxy Boolean
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    audience string
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    description string
    Description of the OIDC provider
    issuerUrl string
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    name string
    Name of the OIDC provider
    projectKey string
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    providerType string
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    useDefaultProxy boolean
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    audience str
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    description str
    Description of the OIDC provider
    issuer_url str
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    name str
    Name of the OIDC provider
    project_key str
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    provider_type str
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    use_default_proxy bool
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.
    audience String
    Informational field that you can use to include details of the audience that uses the OIDC configuration.
    description String
    Description of the OIDC provider
    issuerUrl String
    OIDC issuer URL. For GitHub actions, the URL must start with https://token.actions.githubusercontent.com.
    name String
    Name of the OIDC provider
    projectKey String
    If set, this Identity Configuration will be available in the scope of the given project (editable by platform admin and project admin). If not set, this Identity Configuration will be global and only editable by platform admin. Once set, the projectKey cannot be changed.
    providerType String
    Type of OIDC provider. Can be generic, GitHub, or Azure.
    useDefaultProxy Boolean
    This enables and disables the default proxy for OIDC integration. If enabled, the OIDC mechanism will utilize the default proxy for all OIDC requests. If disabled, the OIDC mechanism does not use any proxy for all OIDC requests. Before enabling this functionality you must configure the default proxy.

    Import

    $ pulumi import platform:index/oidcConfiguration:OidcConfiguration my-oidc-configuration my-oidc-configuration

    $ pulumi import platform:index/oidcConfiguration:OidcConfiguration my-oidc-configuration my-oidc-configuration:myproj

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

    Package Details

    Repository
    platform jfrog/terraform-provider-platform
    License
    Notes
    This Pulumi package is based on the platform Terraform Provider.
    platform logo
    platform 2.2.1 published on Friday, Mar 7, 2025 by jfrog
    jfrog/terraform-provider-platform