Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Zitadel
  3. API Docs
  4. ApplicationApi
zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
pulumiverse/pulumi-zitadel

zitadel.ApplicationApi

Explore with Pulumi AI

zitadel logo
zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
pulumiverse/pulumi-zitadel

    Resource representing an API application belonging to a project, with all configuration possibilities.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumiverse.Zitadel;

return await Deployment.RunAsync(() => 
{
    var @default = new Zitadel.ApplicationApi("default", new()
    {
        OrgId = defaultZitadelOrg.Id,
        ProjectId = defaultZitadelProject.Id,
        Name = "applicationapi",
        AuthMethodType = "API_AUTH_METHOD_TYPE_BASIC",
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zitadel.NewApplicationApi(ctx, "default", &zitadel.ApplicationApiArgs{
			OrgId:          pulumi.Any(defaultZitadelOrg.Id),
			ProjectId:      pulumi.Any(defaultZitadelProject.Id),
			Name:           pulumi.String("applicationapi"),
			AuthMethodType: pulumi.String("API_AUTH_METHOD_TYPE_BASIC"),
		})
		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.zitadel.ApplicationApi;
import com.pulumi.zitadel.ApplicationApiArgs;
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 default_ = new ApplicationApi("default", ApplicationApiArgs.builder()        
            .orgId(defaultZitadelOrg.id())
            .projectId(defaultZitadelProject.id())
            .name("applicationapi")
            .authMethodType("API_AUTH_METHOD_TYPE_BASIC")
            .build());

    }
}

    import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumiverse/zitadel";

const _default = new zitadel.ApplicationApi("default", {
    orgId: defaultZitadelOrg.id,
    projectId: defaultZitadelProject.id,
    name: "applicationapi",
    authMethodType: "API_AUTH_METHOD_TYPE_BASIC",
});

    import pulumi
import pulumiverse_zitadel as zitadel

default = zitadel.ApplicationApi("default",
    org_id=default_zitadel_org["id"],
    project_id=default_zitadel_project["id"],
    name="applicationapi",
    auth_method_type="API_AUTH_METHOD_TYPE_BASIC")

    resources:
  default:
    type: zitadel:ApplicationApi
    properties:
      orgId: ${defaultZitadelOrg.id}
      projectId: ${defaultZitadelProject.id}
      name: applicationapi
      authMethodType: API_AUTH_METHOD_TYPE_BASIC

    Create ApplicationApi Resource

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

    Constructor syntax

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

@overload
def ApplicationApi(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   project_id: Optional[str] = None,
                   auth_method_type: Optional[str] = None,
                   name: Optional[str] = None,
                   org_id: Optional[str] = None)
    func NewApplicationApi(ctx *Context, name string, args ApplicationApiArgs, opts ...ResourceOption) (*ApplicationApi, error)
    public ApplicationApi(string name, ApplicationApiArgs args, CustomResourceOptions? opts = null)
    public ApplicationApi(String name, ApplicationApiArgs args)
public ApplicationApi(String name, ApplicationApiArgs args, CustomResourceOptions options)

    type: zitadel:ApplicationApi
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 ApplicationApiArgs
    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 ApplicationApiArgs
    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 ApplicationApiArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApplicationApiArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApplicationApiArgs
    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 applicationApiResource = new Zitadel.ApplicationApi("applicationApiResource", new()
{
    ProjectId = "string",
    AuthMethodType = "string",
    Name = "string",
    OrgId = "string",
});

    example, err := zitadel.NewApplicationApi(ctx, "applicationApiResource", &zitadel.ApplicationApiArgs{
	ProjectId:      pulumi.String("string"),
	AuthMethodType: pulumi.String("string"),
	Name:           pulumi.String("string"),
	OrgId:          pulumi.String("string"),
})

    var applicationApiResource = new ApplicationApi("applicationApiResource", ApplicationApiArgs.builder()
    .projectId("string")
    .authMethodType("string")
    .name("string")
    .orgId("string")
    .build());

    application_api_resource = zitadel.ApplicationApi("applicationApiResource",
    project_id="string",
    auth_method_type="string",
    name="string",
    org_id="string")

    const applicationApiResource = new zitadel.ApplicationApi("applicationApiResource", {
    projectId: "string",
    authMethodType: "string",
    name: "string",
    orgId: "string",
});

    type: zitadel:ApplicationApi
properties:
    authMethodType: string
    name: string
    orgId: string
    projectId: string

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

    ProjectId string
    ID of the project
    AuthMethodType string
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    Name string
    Name of the application
    OrgId string
    ID of the organization
    ProjectId string
    ID of the project
    AuthMethodType string
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    Name string
    Name of the application
    OrgId string
    ID of the organization
    projectId String
    ID of the project
    authMethodType String
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    name String
    Name of the application
    orgId String
    ID of the organization
    projectId string
    ID of the project
    authMethodType string
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    name string
    Name of the application
    orgId string
    ID of the organization
    project_id str
    ID of the project
    auth_method_type str
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    name str
    Name of the application
    org_id str
    ID of the organization
    projectId String
    ID of the project
    authMethodType String
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    name String
    Name of the application
    orgId String
    ID of the organization

    Outputs

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

    ClientId string
    generated ID for this config
    ClientSecret string
    generated secret for this config
    Id string
    The provider-assigned unique ID for this managed resource.
    ClientId string
    generated ID for this config
    ClientSecret string
    generated secret for this config
    Id string
    The provider-assigned unique ID for this managed resource.
    clientId String
    generated ID for this config
    clientSecret String
    generated secret for this config
    id String
    The provider-assigned unique ID for this managed resource.
    clientId string
    generated ID for this config
    clientSecret string
    generated secret for this config
    id string
    The provider-assigned unique ID for this managed resource.
    client_id str
    generated ID for this config
    client_secret str
    generated secret for this config
    id str
    The provider-assigned unique ID for this managed resource.
    clientId String
    generated ID for this config
    clientSecret String
    generated secret for this config
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApplicationApi Resource

    Get an existing ApplicationApi 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?: ApplicationApiState, opts?: CustomResourceOptions): ApplicationApi
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_method_type: Optional[str] = None,
        client_id: Optional[str] = None,
        client_secret: Optional[str] = None,
        name: Optional[str] = None,
        org_id: Optional[str] = None,
        project_id: Optional[str] = None) -> ApplicationApi
    func GetApplicationApi(ctx *Context, name string, id IDInput, state *ApplicationApiState, opts ...ResourceOption) (*ApplicationApi, error)
    public static ApplicationApi Get(string name, Input<string> id, ApplicationApiState? state, CustomResourceOptions? opts = null)
    public static ApplicationApi get(String name, Output<String> id, ApplicationApiState state, CustomResourceOptions options)
    resources:  _:    type: zitadel:ApplicationApi    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:
    AuthMethodType string
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    ClientId string
    generated ID for this config
    ClientSecret string
    generated secret for this config
    Name string
    Name of the application
    OrgId string
    ID of the organization
    ProjectId string
    ID of the project
    AuthMethodType string
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    ClientId string
    generated ID for this config
    ClientSecret string
    generated secret for this config
    Name string
    Name of the application
    OrgId string
    ID of the organization
    ProjectId string
    ID of the project
    authMethodType String
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    clientId String
    generated ID for this config
    clientSecret String
    generated secret for this config
    name String
    Name of the application
    orgId String
    ID of the organization
    projectId String
    ID of the project
    authMethodType string
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    clientId string
    generated ID for this config
    clientSecret string
    generated secret for this config
    name string
    Name of the application
    orgId string
    ID of the organization
    projectId string
    ID of the project
    auth_method_type str
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    client_id str
    generated ID for this config
    client_secret str
    generated secret for this config
    name str
    Name of the application
    org_id str
    ID of the organization
    project_id str
    ID of the project
    authMethodType String
    Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
    clientId String
    generated ID for this config
    clientSecret String
    generated secret for this config
    name String
    Name of the application
    orgId String
    ID of the organization
    projectId String
    ID of the project

    Import

    bash The resource can be imported using the ID format <id:project_id[:org_id][:client_id][:client_secret]>, e.g.

     $ pulumi import zitadel:index/applicationApi:ApplicationApi imported '123456789012345678:123456789012345678:123456789012345678:123456789012345678@zitadel:JuaDFFeOak5DGE655KCYPSAclSkbMVEJXXuX1lEMBT14eLMSs0A0qhafKX5SA2Df'

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

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.2.0 published on Monday, Mar 24, 2025 by pulumiverse
    pulumiverse/pulumi-zitadel