zitadel.ApplicationApi
Explore with Pulumi AI
Resource representing an API application belonging to a project, with all configuration possibilities.
Example Usage
using System.Collections.Generic;
using Pulumi;
using Zitadel = Pulumiverse.Zitadel;
return await Deployment.RunAsync(() =>
{
var applicationApi = new Zitadel.ApplicationApi("applicationApi", new()
{
OrgId = zitadel_org.Org.Id,
ProjectId = zitadel_project.Project.Id,
AuthMethodType = "API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT",
});
});
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, "applicationApi", &zitadel.ApplicationApiArgs{
OrgId: pulumi.Any(zitadel_org.Org.Id),
ProjectId: pulumi.Any(zitadel_project.Project.Id),
AuthMethodType: pulumi.String("API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT"),
})
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 applicationApi = new ApplicationApi("applicationApi", ApplicationApiArgs.builder()
.orgId(zitadel_org.org().id())
.projectId(zitadel_project.project().id())
.authMethodType("API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT")
.build());
}
}
import pulumi
import pulumiverse_zitadel as zitadel
application_api = zitadel.ApplicationApi("applicationApi",
org_id=zitadel_org["org"]["id"],
project_id=zitadel_project["project"]["id"],
auth_method_type="API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT")
import * as pulumi from "@pulumi/pulumi";
import * as zitadel from "@pulumiverse/zitadel";
const applicationApi = new zitadel.ApplicationApi("applicationApi", {
orgId: zitadel_org.org.id,
projectId: zitadel_project.project.id,
authMethodType: "API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT",
});
resources:
applicationApi:
type: zitadel:ApplicationApi
properties:
orgId: ${zitadel_org.org.id}
projectId: ${zitadel_project.project.id}
authMethodType: API_AUTH_METHOD_TYPE_PRIVATE_KEY_JWT
Create ApplicationApi Resource
new ApplicationApi(name: string, args: ApplicationApiArgs, opts?: CustomResourceOptions);
@overload
def ApplicationApi(resource_name: str,
opts: Optional[ResourceOptions] = None,
auth_method_type: Optional[str] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
project_id: Optional[str] = None)
@overload
def ApplicationApi(resource_name: str,
args: ApplicationApiArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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
The ApplicationApi resource accepts the following input properties:
- Org
Id string orgID of the application
- Project
Id string ID of the project
- Auth
Method stringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- Name string
Name of the application
- Org
Id string orgID of the application
- Project
Id string ID of the project
- Auth
Method stringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- Name string
Name of the application
- org
Id String orgID of the application
- project
Id String ID of the project
- auth
Method StringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- name String
Name of the application
- org
Id string orgID of the application
- project
Id string ID of the project
- auth
Method stringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- name string
Name of the application
- org_
id str orgID of the application
- project_
id str ID of the project
- auth_
method_ strtype Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- name str
Name of the application
- org
Id String orgID of the application
- project
Id String ID of the project
- auth
Method StringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- name String
Name of the application
Outputs
All input properties are implicitly available as output properties. Additionally, the ApplicationApi resource produces the following output properties:
- Client
Id string generated ID for this config
- Client
Secret string generated secret for this config
- Id string
The provider-assigned unique ID for this managed resource.
- Client
Id string generated ID for this config
- Client
Secret string generated secret for this config
- Id string
The provider-assigned unique ID for this managed resource.
- client
Id String generated ID for this config
- client
Secret String generated secret for this config
- id String
The provider-assigned unique ID for this managed resource.
- client
Id string generated ID for this config
- client
Secret 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.
- client
Id String generated ID for this config
- client
Secret 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)
Resource lookup is not supported in YAML
- 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.
- Auth
Method stringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- Client
Id string generated ID for this config
- Client
Secret string generated secret for this config
- Name string
Name of the application
- Org
Id string orgID of the application
- Project
Id string ID of the project
- Auth
Method stringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- Client
Id string generated ID for this config
- Client
Secret string generated secret for this config
- Name string
Name of the application
- Org
Id string orgID of the application
- Project
Id string ID of the project
- auth
Method StringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- client
Id String generated ID for this config
- client
Secret String generated secret for this config
- name String
Name of the application
- org
Id String orgID of the application
- project
Id String ID of the project
- auth
Method stringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- client
Id string generated ID for this config
- client
Secret string generated secret for this config
- name string
Name of the application
- org
Id string orgID of the application
- project
Id string ID of the project
- auth_
method_ strtype 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 orgID of the application
- project_
id str ID of the project
- auth
Method StringType Auth method type, supported values: APIAUTHMETHODTYPEBASIC, APIAUTHMETHODTYPEPRIVATEKEYJWT
- client
Id String generated ID for this config
- client
Secret String generated secret for this config
- name String
Name of the application
- org
Id String orgID of the application
- project
Id String ID of the project
Package Details
- Repository
- zitadel pulumiverse/pulumi-zitadel
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
zitadel
Terraform Provider.