pulumi-vault-kotlin/com.pulumi.vault.identity.kotlin/OidcRole

OidcRole

class OidcRole : KotlinCustomResource

Example Usage

You need to create a role with a named key. At creation time, the key can be created independently of the role. However, the key must exist before the role can be used to issue tokens. You must also configure the key with the role's Client ID to allow the role to use the key.

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const config = new pulumi.Config();
// Name of the OIDC Key
const key = config.get("key") || "key";
const role = new vault.identity.OidcRole("role", {
    name: "role",
    key: key,
});
const keyOidcKey = new vault.identity.OidcKey("key", {
    name: key,
    algorithm: "RS256",
    allowedClientIds: [role&#46;clientId],
});

import pulumi
import pulumi_vault as vault
config = pulumi.Config()
# Name of the OIDC Key
key = config.get("key")
if key is None:
    key = "key"
role = vault.identity.OidcRole("role",
    name="role",
    key=key)
key_oidc_key = vault.identity.OidcKey("key",
    name=key,
    algorithm="RS256",
    allowed_client_ids=[role&#46;client_id])

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
    var config = new Config();
    // Name of the OIDC Key
    var key = config.Get("key") ?? "key";
    var role = new Vault.Identity.OidcRole("role", new()
    {
        Name = "role",
        Key = key,
    });
    var keyOidcKey = new Vault.Identity.OidcKey("key", new()
    {
        Name = key,
        Algorithm = "RS256",
        AllowedClientIds = new[]
        {
            role.ClientId,
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		// Name of the OIDC Key
		key := "key"
		if param := cfg.Get("key"); param != "" {
			key = param
		}
		role, err := identity.NewOidcRole(ctx, "role", &identity.OidcRoleArgs{
			Name: pulumi.String("role"),
			Key:  pulumi.String(key),
		})
		if err != nil {
			return err
		}
		_, err = identity.NewOidcKey(ctx, "key", &identity.OidcKeyArgs{
			Name:      pulumi.String(key),
			Algorithm: pulumi.String("RS256"),
			AllowedClientIds: pulumi.StringArray{
				role.ClientId,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.identity.OidcRole;
import com.pulumi.vault.identity.OidcRoleArgs;
import com.pulumi.vault.identity.OidcKey;
import com.pulumi.vault.identity.OidcKeyArgs;
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 config = ctx.config();
        final var key = config.get("key").orElse("key");
        var role = new OidcRole("role", OidcRoleArgs.builder()
            .name("role")
            .key(key)
            .build());
        var keyOidcKey = new OidcKey("keyOidcKey", OidcKeyArgs.builder()
            .name(key)
            .algorithm("RS256")
            .allowedClientIds(role.clientId())
            .build());
    }
}

configuration:
  key:
    type: string
    default: key
resources:
  keyOidcKey:
    type: vault:identity:OidcKey
    name: key
    properties:
      name: ${key}
      algorithm: RS256
      allowedClientIds:
        - ${role.clientId}
  role:
    type: vault:identity:OidcRole
    properties:
      name: role
      key: ${key}

If you want to create the key first before creating the role, you can use a separate resource to configure the allowed Client ID on the key.

import * as pulumi from "@pulumi/pulumi";
import * as vault from "@pulumi/vault";
const key = new vault.identity.OidcKey("key", {
    name: "key",
    algorithm: "RS256",
});
const role = new vault.identity.OidcRole("role", {
    name: "role",
    key: key.name,
});
const roleOidcKeyAllowedClientID = new vault.identity.OidcKeyAllowedClientID("role", {
    keyName: key.name,
    allowedClientId: role.clientId,
});

import pulumi
import pulumi_vault as vault
key = vault.identity.OidcKey("key",
    name="key",
    algorithm="RS256")
role = vault.identity.OidcRole("role",
    name="role",
    key=key.name)
role_oidc_key_allowed_client_id = vault.identity.OidcKeyAllowedClientID("role",
    key_name=key.name,
    allowed_client_id=role.client_id)

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vault = Pulumi.Vault;
return await Deployment.RunAsync(() =>
{
    var key = new Vault.Identity.OidcKey("key", new()
    {
        Name = "key",
        Algorithm = "RS256",
    });
    var role = new Vault.Identity.OidcRole("role", new()
    {
        Name = "role",
        Key = key.Name,
    });
    var roleOidcKeyAllowedClientID = new Vault.Identity.OidcKeyAllowedClientID("role", new()
    {
        KeyName = key.Name,
        AllowedClientId = role.ClientId,
    });
});

package main
import (
	"github.com/pulumi/pulumi-vault/sdk/v6/go/vault/identity"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		key, err := identity.NewOidcKey(ctx, "key", &identity.OidcKeyArgs{
			Name:      pulumi.String("key"),
			Algorithm: pulumi.String("RS256"),
		})
		if err != nil {
			return err
		}
		role, err := identity.NewOidcRole(ctx, "role", &identity.OidcRoleArgs{
			Name: pulumi.String("role"),
			Key:  key.Name,
		})
		if err != nil {
			return err
		}
		_, err = identity.NewOidcKeyAllowedClientID(ctx, "role", &identity.OidcKeyAllowedClientIDArgs{
			KeyName:         key.Name,
			AllowedClientId: role.ClientId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vault.identity.OidcKey;
import com.pulumi.vault.identity.OidcKeyArgs;
import com.pulumi.vault.identity.OidcRole;
import com.pulumi.vault.identity.OidcRoleArgs;
import com.pulumi.vault.identity.OidcKeyAllowedClientID;
import com.pulumi.vault.identity.OidcKeyAllowedClientIDArgs;
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 key = new OidcKey("key", OidcKeyArgs.builder()
            .name("key")
            .algorithm("RS256")
            .build());
        var role = new OidcRole("role", OidcRoleArgs.builder()
            .name("role")
            .key(key.name())
            .build());
        var roleOidcKeyAllowedClientID = new OidcKeyAllowedClientID("roleOidcKeyAllowedClientID", OidcKeyAllowedClientIDArgs.builder()
            .keyName(key.name())
            .allowedClientId(role.clientId())
            .build());
    }
}

resources:
  key:
    type: vault:identity:OidcKey
    properties:
      name: key
      algorithm: RS256
  role:
    type: vault:identity:OidcRole
    properties:
      name: role
      key: ${key.name}
  roleOidcKeyAllowedClientID:
    type: vault:identity:OidcKeyAllowedClientID
    name: role
    properties:
      keyName: ${key.name}
      allowedClientId: ${role.clientId}

Import

The key can be imported with the role name, for example:

$ pulumi import vault:identity/oidcRole:OidcRole role role

Properties

clientId

val clientId: Output<String>

The value that will be included in the aud field of all the OIDC identity tokens issued by this role

val id: Output<String>

key

val key: Output<String>

A configured named key, the key must already exist before tokens can be issued.

name

val name: Output<String>

Name of the OIDC Role to create.

namespace

val namespace: Output<String>?

The namespace to provision the resource in. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

template

val template: Output<String>?

The template string to use for generating tokens. This may be in string-ified JSON or base64 format. See the documentation for the template format.

ttl

val ttl: Output<Int>?

TTL of the tokens generated against the role in number of seconds.

urn

val urn: Output<String>