Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Propelauth Provider
  3. API Docs
  4. BeApiKey
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

propelauth.BeApiKey

Explore with Pulumi AI

propelauth logo
propelauth 0.4.1 published on Friday, Mar 7, 2025 by propelauth
propelauth/terraform-provider-propelauth

    Backend API Key resource. This is for configuring the basic BE API key information in PropelAuth.

    Example Usage

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

// Create a PropelAuth API key for use in the Back End of your application.
const example = new propelauth.BeApiKey("example", {
    environment: "Prod",
    readOnly: false,
});
export const beApiKeyResult = example.apiKey;

    import pulumi
import pulumi_propelauth as propelauth

# Create a PropelAuth API key for use in the Back End of your application.
example = propelauth.BeApiKey("example",
    environment="Prod",
    read_only=False)
pulumi.export("beApiKeyResult", example.api_key)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a PropelAuth API key for use in the Back End of your application.
		example, err := propelauth.NewBeApiKey(ctx, "example", &propelauth.BeApiKeyArgs{
			Environment: pulumi.String("Prod"),
			ReadOnly:    pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		ctx.Export("beApiKeyResult", example.ApiKey)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    // Create a PropelAuth API key for use in the Back End of your application.
    var example = new Propelauth.BeApiKey("example", new()
    {
        Environment = "Prod",
        ReadOnly = false,
    });

    return new Dictionary<string, object?>
    {
        ["beApiKeyResult"] = example.ApiKey,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.propelauth.BeApiKey;
import com.pulumi.propelauth.BeApiKeyArgs;
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) {
        // Create a PropelAuth API key for use in the Back End of your application.
        var example = new BeApiKey("example", BeApiKeyArgs.builder()
            .environment("Prod")
            .readOnly(false)
            .build());

        ctx.export("beApiKeyResult", example.apiKey());
    }
}

    resources:
  # Create a PropelAuth API key for use in the Back End of your application.
  example:
    type: propelauth:BeApiKey
    properties:
      environment: Prod
      readOnly: false
outputs:
  beApiKeyResult: ${example.apiKey}

    Create BeApiKey Resource

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

    Constructor syntax

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

@overload
def BeApiKey(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             environment: Optional[str] = None,
             read_only: Optional[bool] = None,
             name: Optional[str] = None)
    func NewBeApiKey(ctx *Context, name string, args BeApiKeyArgs, opts ...ResourceOption) (*BeApiKey, error)
    public BeApiKey(string name, BeApiKeyArgs args, CustomResourceOptions? opts = null)
    public BeApiKey(String name, BeApiKeyArgs args)
public BeApiKey(String name, BeApiKeyArgs args, CustomResourceOptions options)

    type: propelauth:BeApiKey
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 BeApiKeyArgs
    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 BeApiKeyArgs
    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 BeApiKeyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BeApiKeyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BeApiKeyArgs
    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 beApiKeyResource = new Propelauth.BeApiKey("beApiKeyResource", new()
{
    Environment = "string",
    ReadOnly = false,
    Name = "string",
});

    example, err := propelauth.NewBeApiKey(ctx, "beApiKeyResource", &propelauth.BeApiKeyArgs{
Environment: pulumi.String("string"),
ReadOnly: pulumi.Bool(false),
Name: pulumi.String("string"),
})

    var beApiKeyResource = new BeApiKey("beApiKeyResource", BeApiKeyArgs.builder()
    .environment("string")
    .readOnly(false)
    .name("string")
    .build());

    be_api_key_resource = propelauth.BeApiKey("beApiKeyResource",
    environment="string",
    read_only=False,
    name="string")

    const beApiKeyResource = new propelauth.BeApiKey("beApiKeyResource", {
    environment: "string",
    readOnly: false,
    name: "string",
});

    type: propelauth:BeApiKey
properties:
    environment: string
    name: string
    readOnly: false

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

    Environment string
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    ReadOnly bool
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    Name string
    The API key's name. This is only for internal dislay purposes.
    Environment string
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    ReadOnly bool
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    Name string
    The API key's name. This is only for internal dislay purposes.
    environment String
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    readOnly Boolean
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    name String
    The API key's name. This is only for internal dislay purposes.
    environment string
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    readOnly boolean
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    name string
    The API key's name. This is only for internal dislay purposes.
    environment str
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    read_only bool
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    name str
    The API key's name. This is only for internal dislay purposes.
    environment String
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    readOnly Boolean
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    name String
    The API key's name. This is only for internal dislay purposes.

    Outputs

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

    ApiKey string
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    ApiKeyId string
    The API key ID. This is a unique identifier for the API key.
    Id string
    The provider-assigned unique ID for this managed resource.
    ApiKey string
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    ApiKeyId string
    The API key ID. This is a unique identifier for the API key.
    Id string
    The provider-assigned unique ID for this managed resource.
    apiKey String
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    apiKeyId String
    The API key ID. This is a unique identifier for the API key.
    id String
    The provider-assigned unique ID for this managed resource.
    apiKey string
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    apiKeyId string
    The API key ID. This is a unique identifier for the API key.
    id string
    The provider-assigned unique ID for this managed resource.
    api_key str
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    api_key_id str
    The API key ID. This is a unique identifier for the API key.
    id str
    The provider-assigned unique ID for this managed resource.
    apiKey String
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    apiKeyId String
    The API key ID. This is a unique identifier for the API key.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing BeApiKey Resource

    Get an existing BeApiKey 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?: BeApiKeyState, opts?: CustomResourceOptions): BeApiKey
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        api_key_id: Optional[str] = None,
        environment: Optional[str] = None,
        name: Optional[str] = None,
        read_only: Optional[bool] = None) -> BeApiKey
    func GetBeApiKey(ctx *Context, name string, id IDInput, state *BeApiKeyState, opts ...ResourceOption) (*BeApiKey, error)
    public static BeApiKey Get(string name, Input<string> id, BeApiKeyState? state, CustomResourceOptions? opts = null)
    public static BeApiKey get(String name, Output<String> id, BeApiKeyState state, CustomResourceOptions options)
    resources:  _:    type: propelauth:BeApiKey    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:
    ApiKey string
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    ApiKeyId string
    The API key ID. This is a unique identifier for the API key.
    Environment string
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    Name string
    The API key's name. This is only for internal dislay purposes.
    ReadOnly bool
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    ApiKey string
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    ApiKeyId string
    The API key ID. This is a unique identifier for the API key.
    Environment string
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    Name string
    The API key's name. This is only for internal dislay purposes.
    ReadOnly bool
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    apiKey String
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    apiKeyId String
    The API key ID. This is a unique identifier for the API key.
    environment String
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    name String
    The API key's name. This is only for internal dislay purposes.
    readOnly Boolean
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    apiKey string
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    apiKeyId string
    The API key ID. This is a unique identifier for the API key.
    environment string
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    name string
    The API key's name. This is only for internal dislay purposes.
    readOnly boolean
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    api_key str
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    api_key_id str
    The API key ID. This is a unique identifier for the API key.
    environment str
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    name str
    The API key's name. This is only for internal dislay purposes.
    read_only bool
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.
    apiKey String
    The API key value. This is the secret value that is used to authenticate requests to PropelAuth.
    apiKeyId String
    The API key ID. This is a unique identifier for the API key.
    environment String
    The environment for which you are configuring the backend integration. Accepted values are Test, Staging, and Prod.
    name String
    The API key's name. This is only for internal dislay purposes.
    readOnly Boolean
    If true, the API key has read-only privileges. For example, it cannot be used for creating, editing, or deleting users/orgs. This value can only be set during the creation of the API key.

    Package Details

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