gcp.apigee.DeveloperApp
Creates an app associated with a developer. This API associates the developer app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product.
To get more information about DeveloperApp, see:
- API documentation
- How-to Guides
Example Usage
Apigee Developer App Basic
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
Example coming soon!
resources:
apigeeDeveloperApp:
type: gcp:apigee:DeveloperApp
name: apigee_developer_app
properties:
name: sample-app
orgId: ${apigeeOrg.id}
developerId: ${developer.id}
developerEmail: ${developer.email}
callbackUrl: https://example-call.url
apiProducts:
- ${apiProduct.name}
scopes: ${apiProduct.scopes}
apiProduct:
type: gcp:apigee:ApiProduct
name: api_product
properties:
orgId: ${apigeeOrg.id}
name: sample-api
displayName: A sample API Product
approvalType: auto
scopes:
- read:weather
- write:reports
options:
dependsOn:
- ${apigeeInstance}
developer:
type: gcp:apigee:Developer
properties:
email: john.doe@acme.com
firstName: John
lastName: Doe
userName: john.doe
orgId: ${apigeeOrg.id}
options:
dependsOn:
- ${apigeeInstance}
apigeeInstance:
type: gcp:apigee:Instance
name: apigee_instance
properties:
name: instance
location: us-central1
orgId: ${apigeeOrg.id}
apigeeOrg:
type: gcp:apigee:Organization
name: apigee_org
properties:
analyticsRegion: us-central1
projectId: ${projectGoogleProject.projectId}
disableVpcPeering: true
variables:
project:
fn::invoke:
function: gcp:organizations:getProject
arguments: {}
Apigee Developer App Basic Test
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as time from "@pulumiverse/time";
const project = new gcp.organizations.Project("project", {
projectId: "prj",
name: "prj",
orgId: "123456789",
billingAccount: "000000-0000000-0000000-000000",
deletionPolicy: "DELETE",
});
const wait60Seconds = new time.Sleep("wait_60_seconds", {createDuration: "60s"}, {
dependsOn: [project],
});
const apigee = new gcp.projects.Service("apigee", {
project: project.projectId,
service: "apigee.googleapis.com",
}, {
dependsOn: [wait60Seconds],
});
const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
analyticsRegion: "us-central1",
projectId: project.projectId,
disableVpcPeering: true,
}, {
dependsOn: [apigee],
});
const apigeeInstance = new gcp.apigee.Instance("apigee_instance", {
name: "instance",
location: "us-central1",
orgId: apigeeOrg.id,
});
const apiProduct = new gcp.apigee.ApiProduct("api_product", {
name: "sample-api",
orgId: apigeeOrg.id,
displayName: "A sample API Product",
approvalType: "auto",
scopes: [
"read:weather",
"write:reports",
"write:files",
],
}, {
dependsOn: [apigeeInstance],
});
const developer = new gcp.apigee.Developer("developer", {
email: "john.doe@acme.com",
firstName: "John",
lastName: "Doe",
userName: "john.doe",
orgId: apigeeOrg.id,
}, {
dependsOn: [apigeeInstance],
});
const apigeeDeveloperApp = new gcp.apigee.DeveloperApp("apigee_developer_app", {
name: "sample-app",
appFamily: "default",
developerEmail: developer.email,
orgId: apigeeOrg.id,
callbackUrl: "https://example-call.url",
keyExpiresIn: "-1",
status: "approved",
apiProducts: [apiProduct.name],
scopes: apiProduct.scopes,
attributes: [{
name: "sample_name",
value: "sample_value",
}],
});
import pulumi
import pulumi_gcp as gcp
import pulumiverse_time as time
project = gcp.organizations.Project("project",
project_id="prj",
name="prj",
org_id="123456789",
billing_account="000000-0000000-0000000-000000",
deletion_policy="DELETE")
wait60_seconds = time.Sleep("wait_60_seconds", create_duration="60s",
opts = pulumi.ResourceOptions(depends_on=[project]))
apigee = gcp.projects.Service("apigee",
project=project.project_id,
service="apigee.googleapis.com",
opts = pulumi.ResourceOptions(depends_on=[wait60_seconds]))
apigee_org = gcp.apigee.Organization("apigee_org",
analytics_region="us-central1",
project_id=project.project_id,
disable_vpc_peering=True,
opts = pulumi.ResourceOptions(depends_on=[apigee]))
apigee_instance = gcp.apigee.Instance("apigee_instance",
name="instance",
location="us-central1",
org_id=apigee_org.id)
api_product = gcp.apigee.ApiProduct("api_product",
name="sample-api",
org_id=apigee_org.id,
display_name="A sample API Product",
approval_type="auto",
scopes=[
"read:weather",
"write:reports",
"write:files",
],
opts = pulumi.ResourceOptions(depends_on=[apigee_instance]))
developer = gcp.apigee.Developer("developer",
email="john.doe@acme.com",
first_name="John",
last_name="Doe",
user_name="john.doe",
org_id=apigee_org.id,
opts = pulumi.ResourceOptions(depends_on=[apigee_instance]))
apigee_developer_app = gcp.apigee.DeveloperApp("apigee_developer_app",
name="sample-app",
app_family="default",
developer_email=developer.email,
org_id=apigee_org.id,
callback_url="https://example-call.url",
key_expires_in="-1",
status="approved",
api_products=[api_product.name],
scopes=api_product.scopes,
attributes=[{
"name": "sample_name",
"value": "sample_value",
}])
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/apigee"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-time/sdk/go/time"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
project, err := organizations.NewProject(ctx, "project", &organizations.ProjectArgs{
ProjectId: pulumi.String("prj"),
Name: pulumi.String("prj"),
OrgId: pulumi.String("123456789"),
BillingAccount: pulumi.String("000000-0000000-0000000-000000"),
DeletionPolicy: pulumi.String("DELETE"),
})
if err != nil {
return err
}
wait60Seconds, err := time.NewSleep(ctx, "wait_60_seconds", &time.SleepArgs{
CreateDuration: pulumi.String("60s"),
}, pulumi.DependsOn([]pulumi.Resource{
project,
}))
if err != nil {
return err
}
apigee, err := projects.NewService(ctx, "apigee", &projects.ServiceArgs{
Project: project.ProjectId,
Service: pulumi.String("apigee.googleapis.com"),
}, pulumi.DependsOn([]pulumi.Resource{
wait60Seconds,
}))
if err != nil {
return err
}
apigeeOrg, err := apigee.NewOrganization(ctx, "apigee_org", &apigee.OrganizationArgs{
AnalyticsRegion: pulumi.String("us-central1"),
ProjectId: project.ProjectId,
DisableVpcPeering: pulumi.Bool(true),
}, pulumi.DependsOn([]pulumi.Resource{
apigee,
}))
if err != nil {
return err
}
apigeeInstance, err := apigee.NewInstance(ctx, "apigee_instance", &apigee.InstanceArgs{
Name: pulumi.String("instance"),
Location: pulumi.String("us-central1"),
OrgId: apigeeOrg.ID(),
})
if err != nil {
return err
}
apiProduct, err := apigee.NewApiProduct(ctx, "api_product", &apigee.ApiProductArgs{
Name: pulumi.String("sample-api"),
OrgId: apigeeOrg.ID(),
DisplayName: pulumi.String("A sample API Product"),
ApprovalType: pulumi.String("auto"),
Scopes: pulumi.StringArray{
pulumi.String("read:weather"),
pulumi.String("write:reports"),
pulumi.String("write:files"),
},
}, pulumi.DependsOn([]pulumi.Resource{
apigeeInstance,
}))
if err != nil {
return err
}
developer, err := apigee.NewDeveloper(ctx, "developer", &apigee.DeveloperArgs{
Email: pulumi.String("john.doe@acme.com"),
FirstName: pulumi.String("John"),
LastName: pulumi.String("Doe"),
UserName: pulumi.String("john.doe"),
OrgId: apigeeOrg.ID(),
}, pulumi.DependsOn([]pulumi.Resource{
apigeeInstance,
}))
if err != nil {
return err
}
_, err = apigee.NewDeveloperApp(ctx, "apigee_developer_app", &apigee.DeveloperAppArgs{
Name: pulumi.String("sample-app"),
AppFamily: pulumi.String("default"),
DeveloperEmail: developer.Email,
OrgId: apigeeOrg.ID(),
CallbackUrl: pulumi.String("https://example-call.url"),
KeyExpiresIn: pulumi.String("-1"),
Status: pulumi.String("approved"),
ApiProducts: pulumi.StringArray{
apiProduct.Name,
},
Scopes: apiProduct.Scopes,
Attributes: apigee.DeveloperAppAttributeArray{
&apigee.DeveloperAppAttributeArgs{
Name: pulumi.String("sample_name"),
Value: pulumi.String("sample_value"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Time = Pulumiverse.Time;
return await Deployment.RunAsync(() =>
{
var project = new Gcp.Organizations.Project("project", new()
{
ProjectId = "prj",
Name = "prj",
OrgId = "123456789",
BillingAccount = "000000-0000000-0000000-000000",
DeletionPolicy = "DELETE",
});
var wait60Seconds = new Time.Sleep("wait_60_seconds", new()
{
CreateDuration = "60s",
}, new CustomResourceOptions
{
DependsOn =
{
project,
},
});
var apigee = new Gcp.Projects.Service("apigee", new()
{
Project = project.ProjectId,
ServiceName = "apigee.googleapis.com",
}, new CustomResourceOptions
{
DependsOn =
{
wait60Seconds,
},
});
var apigeeOrg = new Gcp.Apigee.Organization("apigee_org", new()
{
AnalyticsRegion = "us-central1",
ProjectId = project.ProjectId,
DisableVpcPeering = true,
}, new CustomResourceOptions
{
DependsOn =
{
apigee,
},
});
var apigeeInstance = new Gcp.Apigee.Instance("apigee_instance", new()
{
Name = "instance",
Location = "us-central1",
OrgId = apigeeOrg.Id,
});
var apiProduct = new Gcp.Apigee.ApiProduct("api_product", new()
{
Name = "sample-api",
OrgId = apigeeOrg.Id,
DisplayName = "A sample API Product",
ApprovalType = "auto",
Scopes = new[]
{
"read:weather",
"write:reports",
"write:files",
},
}, new CustomResourceOptions
{
DependsOn =
{
apigeeInstance,
},
});
var developer = new Gcp.Apigee.Developer("developer", new()
{
Email = "john.doe@acme.com",
FirstName = "John",
LastName = "Doe",
UserName = "john.doe",
OrgId = apigeeOrg.Id,
}, new CustomResourceOptions
{
DependsOn =
{
apigeeInstance,
},
});
var apigeeDeveloperApp = new Gcp.Apigee.DeveloperApp("apigee_developer_app", new()
{
Name = "sample-app",
AppFamily = "default",
DeveloperEmail = developer.Email,
OrgId = apigeeOrg.Id,
CallbackUrl = "https://example-call.url",
KeyExpiresIn = "-1",
Status = "approved",
ApiProducts = new[]
{
apiProduct.Name,
},
Scopes = apiProduct.Scopes,
Attributes = new[]
{
new Gcp.Apigee.Inputs.DeveloperAppAttributeArgs
{
Name = "sample_name",
Value = "sample_value",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import com.pulumiverse.time.Sleep;
import com.pulumiverse.time.SleepArgs;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumi.gcp.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
import com.pulumi.gcp.apigee.Instance;
import com.pulumi.gcp.apigee.InstanceArgs;
import com.pulumi.gcp.apigee.ApiProduct;
import com.pulumi.gcp.apigee.ApiProductArgs;
import com.pulumi.gcp.apigee.Developer;
import com.pulumi.gcp.apigee.DeveloperArgs;
import com.pulumi.gcp.apigee.DeveloperApp;
import com.pulumi.gcp.apigee.DeveloperAppArgs;
import com.pulumi.gcp.apigee.inputs.DeveloperAppAttributeArgs;
import com.pulumi.resources.CustomResourceOptions;
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 project = new Project("project", ProjectArgs.builder()
.projectId("prj")
.name("prj")
.orgId("123456789")
.billingAccount("000000-0000000-0000000-000000")
.deletionPolicy("DELETE")
.build());
var wait60Seconds = new Sleep("wait60Seconds", SleepArgs.builder()
.createDuration("60s")
.build(), CustomResourceOptions.builder()
.dependsOn(project)
.build());
var apigee = new Service("apigee", ServiceArgs.builder()
.project(project.projectId())
.service("apigee.googleapis.com")
.build(), CustomResourceOptions.builder()
.dependsOn(wait60Seconds)
.build());
var apigeeOrg = new Organization("apigeeOrg", OrganizationArgs.builder()
.analyticsRegion("us-central1")
.projectId(project.projectId())
.disableVpcPeering(true)
.build(), CustomResourceOptions.builder()
.dependsOn(apigee)
.build());
var apigeeInstance = new Instance("apigeeInstance", InstanceArgs.builder()
.name("instance")
.location("us-central1")
.orgId(apigeeOrg.id())
.build());
var apiProduct = new ApiProduct("apiProduct", ApiProductArgs.builder()
.name("sample-api")
.orgId(apigeeOrg.id())
.displayName("A sample API Product")
.approvalType("auto")
.scopes(
"read:weather",
"write:reports",
"write:files")
.build(), CustomResourceOptions.builder()
.dependsOn(apigeeInstance)
.build());
var developer = new Developer("developer", DeveloperArgs.builder()
.email("john.doe@acme.com")
.firstName("John")
.lastName("Doe")
.userName("john.doe")
.orgId(apigeeOrg.id())
.build(), CustomResourceOptions.builder()
.dependsOn(apigeeInstance)
.build());
var apigeeDeveloperApp = new DeveloperApp("apigeeDeveloperApp", DeveloperAppArgs.builder()
.name("sample-app")
.appFamily("default")
.developerEmail(developer.email())
.orgId(apigeeOrg.id())
.callbackUrl("https://example-call.url")
.keyExpiresIn("-1")
.status("approved")
.apiProducts(apiProduct.name())
.scopes(apiProduct.scopes())
.attributes(DeveloperAppAttributeArgs.builder()
.name("sample_name")
.value("sample_value")
.build())
.build());
}
}
resources:
apigeeDeveloperApp:
type: gcp:apigee:DeveloperApp
name: apigee_developer_app
properties:
name: sample-app
appFamily: default
developerEmail: ${developer.email}
orgId: ${apigeeOrg.id}
callbackUrl: https://example-call.url
keyExpiresIn: '-1'
status: approved
apiProducts:
- ${apiProduct.name}
scopes: ${apiProduct.scopes}
attributes:
- name: sample_name
value: sample_value
apiProduct:
type: gcp:apigee:ApiProduct
name: api_product
properties:
name: sample-api
orgId: ${apigeeOrg.id}
displayName: A sample API Product
approvalType: auto
scopes:
- read:weather
- write:reports
- write:files
options:
dependsOn:
- ${apigeeInstance}
developer:
type: gcp:apigee:Developer
properties:
email: john.doe@acme.com
firstName: John
lastName: Doe
userName: john.doe
orgId: ${apigeeOrg.id}
options:
dependsOn:
- ${apigeeInstance}
apigeeInstance:
type: gcp:apigee:Instance
name: apigee_instance
properties:
name: instance
location: us-central1
orgId: ${apigeeOrg.id}
apigeeOrg:
type: gcp:apigee:Organization
name: apigee_org
properties:
analyticsRegion: us-central1
projectId: ${project.projectId}
disableVpcPeering: true
options:
dependsOn:
- ${apigee}
apigee:
type: gcp:projects:Service
properties:
project: ${project.projectId}
service: apigee.googleapis.com
options:
dependsOn:
- ${wait60Seconds}
wait60Seconds:
type: time:Sleep
name: wait_60_seconds
properties:
createDuration: 60s
options:
dependsOn:
- ${project}
project:
type: gcp:organizations:Project
properties:
projectId: prj
name: prj
orgId: '123456789'
billingAccount: 000000-0000000-0000000-000000
deletionPolicy: DELETE
Create DeveloperApp Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DeveloperApp(name: string, args: DeveloperAppArgs, opts?: CustomResourceOptions);@overload
def DeveloperApp(resource_name: str,
args: DeveloperAppArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DeveloperApp(resource_name: str,
opts: Optional[ResourceOptions] = None,
callback_url: Optional[str] = None,
developer_email: Optional[str] = None,
org_id: Optional[str] = None,
api_products: Optional[Sequence[str]] = None,
app_family: Optional[str] = None,
attributes: Optional[Sequence[DeveloperAppAttributeArgs]] = None,
key_expires_in: Optional[str] = None,
name: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
status: Optional[str] = None)func NewDeveloperApp(ctx *Context, name string, args DeveloperAppArgs, opts ...ResourceOption) (*DeveloperApp, error)public DeveloperApp(string name, DeveloperAppArgs args, CustomResourceOptions? opts = null)
public DeveloperApp(String name, DeveloperAppArgs args)
public DeveloperApp(String name, DeveloperAppArgs args, CustomResourceOptions options)
type: gcp:apigee:DeveloperApp
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 DeveloperAppArgs
- 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 DeveloperAppArgs
- 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 DeveloperAppArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DeveloperAppArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DeveloperAppArgs
- 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 developerAppResource = new Gcp.Apigee.DeveloperApp("developerAppResource", new()
{
CallbackUrl = "string",
DeveloperEmail = "string",
OrgId = "string",
ApiProducts = new[]
{
"string",
},
AppFamily = "string",
Attributes = new[]
{
new Gcp.Apigee.Inputs.DeveloperAppAttributeArgs
{
Name = "string",
Value = "string",
},
},
KeyExpiresIn = "string",
Name = "string",
Scopes = new[]
{
"string",
},
Status = "string",
});
example, err := apigee.NewDeveloperApp(ctx, "developerAppResource", &apigee.DeveloperAppArgs{
CallbackUrl: pulumi.String("string"),
DeveloperEmail: pulumi.String("string"),
OrgId: pulumi.String("string"),
ApiProducts: pulumi.StringArray{
pulumi.String("string"),
},
AppFamily: pulumi.String("string"),
Attributes: apigee.DeveloperAppAttributeArray{
&apigee.DeveloperAppAttributeArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
KeyExpiresIn: pulumi.String("string"),
Name: pulumi.String("string"),
Scopes: pulumi.StringArray{
pulumi.String("string"),
},
Status: pulumi.String("string"),
})
var developerAppResource = new DeveloperApp("developerAppResource", DeveloperAppArgs.builder()
.callbackUrl("string")
.developerEmail("string")
.orgId("string")
.apiProducts("string")
.appFamily("string")
.attributes(DeveloperAppAttributeArgs.builder()
.name("string")
.value("string")
.build())
.keyExpiresIn("string")
.name("string")
.scopes("string")
.status("string")
.build());
developer_app_resource = gcp.apigee.DeveloperApp("developerAppResource",
callback_url="string",
developer_email="string",
org_id="string",
api_products=["string"],
app_family="string",
attributes=[{
"name": "string",
"value": "string",
}],
key_expires_in="string",
name="string",
scopes=["string"],
status="string")
const developerAppResource = new gcp.apigee.DeveloperApp("developerAppResource", {
callbackUrl: "string",
developerEmail: "string",
orgId: "string",
apiProducts: ["string"],
appFamily: "string",
attributes: [{
name: "string",
value: "string",
}],
keyExpiresIn: "string",
name: "string",
scopes: ["string"],
status: "string",
});
type: gcp:apigee:DeveloperApp
properties:
apiProducts:
- string
appFamily: string
attributes:
- name: string
value: string
callbackUrl: string
developerEmail: string
keyExpiresIn: string
name: string
orgId: string
scopes:
- string
status: string
DeveloperApp 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 DeveloperApp resource accepts the following input properties:
- Callback
Url string - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- Developer
Email string - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- Org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - Api
Products List<string> - List of API products associated with the developer app.
- App
Family string - Developer app family.
- Attributes
List<Developer
App Attribute> - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- Key
Expires stringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- Name string
- Name of the developer app.
- Scopes List<string>
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- Status string
- Status of the credential. Valid values include approved or revoked.
- Callback
Url string - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- Developer
Email string - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- Org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - Api
Products []string - List of API products associated with the developer app.
- App
Family string - Developer app family.
- Attributes
[]Developer
App Attribute Args - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- Key
Expires stringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- Name string
- Name of the developer app.
- Scopes []string
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- Status string
- Status of the credential. Valid values include approved or revoked.
- callback
Url String - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- developer
Email String - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- org
Id String - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - api
Products List<String> - List of API products associated with the developer app.
- app
Family String - Developer app family.
- attributes
List<Developer
App Attribute> - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- key
Expires StringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- name String
- Name of the developer app.
- scopes List<String>
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status String
- Status of the credential. Valid values include approved or revoked.
- callback
Url string - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- developer
Email string - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - api
Products string[] - List of API products associated with the developer app.
- app
Family string - Developer app family.
- attributes
Developer
App Attribute[] - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- key
Expires stringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- name string
- Name of the developer app.
- scopes string[]
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status string
- Status of the credential. Valid values include approved or revoked.
- callback_
url str - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- developer_
email str - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- org_
id str - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - api_
products Sequence[str] - List of API products associated with the developer app.
- app_
family str - Developer app family.
- attributes
Sequence[Developer
App Attribute Args] - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- key_
expires_ strin - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- name str
- Name of the developer app.
- scopes Sequence[str]
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status str
- Status of the credential. Valid values include approved or revoked.
- callback
Url String - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- developer
Email String - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- org
Id String - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - api
Products List<String> - List of API products associated with the developer app.
- app
Family String - Developer app family.
- attributes List<Property Map>
- Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- key
Expires StringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- name String
- Name of the developer app.
- scopes List<String>
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status String
- Status of the credential. Valid values include approved or revoked.
Outputs
All input properties are implicitly available as output properties. Additionally, the DeveloperApp resource produces the following output properties:
- App
Id string - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- Created
At string - Time at which the developer was created in milliseconds since epoch.
- Credentials
List<Developer
App Credential> - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- Developer
Id string - ID of the developer.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt - Time at which the developer was last modified in milliseconds since epoch.
- App
Id string - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- Created
At string - Time at which the developer was created in milliseconds since epoch.
- Credentials
[]Developer
App Credential - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- Developer
Id string - ID of the developer.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Modified stringAt - Time at which the developer was last modified in milliseconds since epoch.
- app
Id String - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- created
At String - Time at which the developer was created in milliseconds since epoch.
- credentials
List<Developer
App Credential> - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- developer
Id String - ID of the developer.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringAt - Time at which the developer was last modified in milliseconds since epoch.
- app
Id string - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- created
At string - Time at which the developer was created in milliseconds since epoch.
- credentials
Developer
App Credential[] - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- developer
Id string - ID of the developer.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Modified stringAt - Time at which the developer was last modified in milliseconds since epoch.
- app_
id str - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- created_
at str - Time at which the developer was created in milliseconds since epoch.
- credentials
Sequence[Developer
App Credential] - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- developer_
id str - ID of the developer.
- id str
- The provider-assigned unique ID for this managed resource.
- last_
modified_ strat - Time at which the developer was last modified in milliseconds since epoch.
- app
Id String - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- created
At String - Time at which the developer was created in milliseconds since epoch.
- credentials List<Property Map>
- Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- developer
Id String - ID of the developer.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Modified StringAt - Time at which the developer was last modified in milliseconds since epoch.
Look up Existing DeveloperApp Resource
Get an existing DeveloperApp 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?: DeveloperAppState, opts?: CustomResourceOptions): DeveloperApp@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_products: Optional[Sequence[str]] = None,
app_family: Optional[str] = None,
app_id: Optional[str] = None,
attributes: Optional[Sequence[DeveloperAppAttributeArgs]] = None,
callback_url: Optional[str] = None,
created_at: Optional[str] = None,
credentials: Optional[Sequence[DeveloperAppCredentialArgs]] = None,
developer_email: Optional[str] = None,
developer_id: Optional[str] = None,
key_expires_in: Optional[str] = None,
last_modified_at: Optional[str] = None,
name: Optional[str] = None,
org_id: Optional[str] = None,
scopes: Optional[Sequence[str]] = None,
status: Optional[str] = None) -> DeveloperAppfunc GetDeveloperApp(ctx *Context, name string, id IDInput, state *DeveloperAppState, opts ...ResourceOption) (*DeveloperApp, error)public static DeveloperApp Get(string name, Input<string> id, DeveloperAppState? state, CustomResourceOptions? opts = null)public static DeveloperApp get(String name, Output<String> id, DeveloperAppState state, CustomResourceOptions options)resources: _: type: gcp:apigee:DeveloperApp 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.
- Api
Products List<string> - List of API products associated with the developer app.
- App
Family string - Developer app family.
- App
Id string - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- Attributes
List<Developer
App Attribute> - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- Callback
Url string - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- Created
At string - Time at which the developer was created in milliseconds since epoch.
- Credentials
List<Developer
App Credential> - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- Developer
Email string - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- Developer
Id string - ID of the developer.
- Key
Expires stringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- Last
Modified stringAt - Time at which the developer was last modified in milliseconds since epoch.
- Name string
- Name of the developer app.
- Org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - Scopes List<string>
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- Status string
- Status of the credential. Valid values include approved or revoked.
- Api
Products []string - List of API products associated with the developer app.
- App
Family string - Developer app family.
- App
Id string - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- Attributes
[]Developer
App Attribute Args - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- Callback
Url string - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- Created
At string - Time at which the developer was created in milliseconds since epoch.
- Credentials
[]Developer
App Credential Args - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- Developer
Email string - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- Developer
Id string - ID of the developer.
- Key
Expires stringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- Last
Modified stringAt - Time at which the developer was last modified in milliseconds since epoch.
- Name string
- Name of the developer app.
- Org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - Scopes []string
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- Status string
- Status of the credential. Valid values include approved or revoked.
- api
Products List<String> - List of API products associated with the developer app.
- app
Family String - Developer app family.
- app
Id String - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- attributes
List<Developer
App Attribute> - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- callback
Url String - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- created
At String - Time at which the developer was created in milliseconds since epoch.
- credentials
List<Developer
App Credential> - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- developer
Email String - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- developer
Id String - ID of the developer.
- key
Expires StringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- last
Modified StringAt - Time at which the developer was last modified in milliseconds since epoch.
- name String
- Name of the developer app.
- org
Id String - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - scopes List<String>
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status String
- Status of the credential. Valid values include approved or revoked.
- api
Products string[] - List of API products associated with the developer app.
- app
Family string - Developer app family.
- app
Id string - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- attributes
Developer
App Attribute[] - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- callback
Url string - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- created
At string - Time at which the developer was created in milliseconds since epoch.
- credentials
Developer
App Credential[] - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- developer
Email string - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- developer
Id string - ID of the developer.
- key
Expires stringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- last
Modified stringAt - Time at which the developer was last modified in milliseconds since epoch.
- name string
- Name of the developer app.
- org
Id string - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - scopes string[]
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status string
- Status of the credential. Valid values include approved or revoked.
- api_
products Sequence[str] - List of API products associated with the developer app.
- app_
family str - Developer app family.
- app_
id str - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- attributes
Sequence[Developer
App Attribute Args] - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- callback_
url str - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- created_
at str - Time at which the developer was created in milliseconds since epoch.
- credentials
Sequence[Developer
App Credential Args] - Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- developer_
email str - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- developer_
id str - ID of the developer.
- key_
expires_ strin - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- last_
modified_ strat - Time at which the developer was last modified in milliseconds since epoch.
- name str
- Name of the developer app.
- org_
id str - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - scopes Sequence[str]
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status str
- Status of the credential. Valid values include approved or revoked.
- api
Products List<String> - List of API products associated with the developer app.
- app
Family String - Developer app family.
- app
Id String - ID of the developer app. This ID is not user specified but is automatically generated on app creation. appId is a UUID.
- attributes List<Property Map>
- Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- callback
Url String - Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps.
- created
At String - Time at which the developer was created in milliseconds since epoch.
- credentials List<Property Map>
- Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. Structure is documented below.
- developer
Email String - Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
- developer
Id String - ID of the developer.
- key
Expires StringIn - Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of -1, the API key never expires. The expiration time can't be updated after it is set.
- last
Modified StringAt - Time at which the developer was last modified in milliseconds since epoch.
- name String
- Name of the developer app.
- org
Id String - The Apigee Organization associated with the Apigee instance,
in the format
organizations/{{org_name}}. - scopes List<String>
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status String
- Status of the credential. Valid values include approved or revoked.
Supporting Types
DeveloperAppAttribute, DeveloperAppAttributeArgs
DeveloperAppCredential, DeveloperAppCredentialArgs
- Api
Products List<DeveloperApp Credential Api Product> - List of API products associated with the developer app.
- Attributes
List<Developer
App Credential Attribute> - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- Consumer
Key string - (Output) Consumer key.
- Consumer
Secret string - (Output) Secret key. Note: This property is sensitive and will not be displayed in the plan.
- Expires
At string - (Output) Time the credential will expire in milliseconds since epoch.
- Issued
At string - (Output) Time the credential was issued in milliseconds since epoch.
- Scopes List<string>
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- Status string
- Status of the credential. Valid values include approved or revoked.
- Api
Products []DeveloperApp Credential Api Product - List of API products associated with the developer app.
- Attributes
[]Developer
App Credential Attribute - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- Consumer
Key string - (Output) Consumer key.
- Consumer
Secret string - (Output) Secret key. Note: This property is sensitive and will not be displayed in the plan.
- Expires
At string - (Output) Time the credential will expire in milliseconds since epoch.
- Issued
At string - (Output) Time the credential was issued in milliseconds since epoch.
- Scopes []string
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- Status string
- Status of the credential. Valid values include approved or revoked.
- api
Products List<DeveloperApp Credential Api Product> - List of API products associated with the developer app.
- attributes
List<Developer
App Credential Attribute> - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- consumer
Key String - (Output) Consumer key.
- consumer
Secret String - (Output) Secret key. Note: This property is sensitive and will not be displayed in the plan.
- expires
At String - (Output) Time the credential will expire in milliseconds since epoch.
- issued
At String - (Output) Time the credential was issued in milliseconds since epoch.
- scopes List<String>
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status String
- Status of the credential. Valid values include approved or revoked.
- api
Products DeveloperApp Credential Api Product[] - List of API products associated with the developer app.
- attributes
Developer
App Credential Attribute[] - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- consumer
Key string - (Output) Consumer key.
- consumer
Secret string - (Output) Secret key. Note: This property is sensitive and will not be displayed in the plan.
- expires
At string - (Output) Time the credential will expire in milliseconds since epoch.
- issued
At string - (Output) Time the credential was issued in milliseconds since epoch.
- scopes string[]
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status string
- Status of the credential. Valid values include approved or revoked.
- api_
products Sequence[DeveloperApp Credential Api Product] - List of API products associated with the developer app.
- attributes
Sequence[Developer
App Credential Attribute] - Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- consumer_
key str - (Output) Consumer key.
- consumer_
secret str - (Output) Secret key. Note: This property is sensitive and will not be displayed in the plan.
- expires_
at str - (Output) Time the credential will expire in milliseconds since epoch.
- issued_
at str - (Output) Time the credential was issued in milliseconds since epoch.
- scopes Sequence[str]
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status str
- Status of the credential. Valid values include approved or revoked.
- api
Products List<Property Map> - List of API products associated with the developer app.
- attributes List<Property Map>
- Developer attributes (name/value pairs). The custom attribute limit is 18. Structure is documented below.
- consumer
Key String - (Output) Consumer key.
- consumer
Secret String - (Output) Secret key. Note: This property is sensitive and will not be displayed in the plan.
- expires
At String - (Output) Time the credential will expire in milliseconds since epoch.
- issued
At String - (Output) Time the credential was issued in milliseconds since epoch.
- scopes List<String>
- Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
- status String
- Status of the credential. Valid values include approved or revoked.
DeveloperAppCredentialApiProduct, DeveloperAppCredentialApiProductArgs
- Apiproduct string
- (Output) Name of the API product.
- Status string
- Status of the credential. Valid values include approved or revoked.
- Apiproduct string
- (Output) Name of the API product.
- Status string
- Status of the credential. Valid values include approved or revoked.
- apiproduct String
- (Output) Name of the API product.
- status String
- Status of the credential. Valid values include approved or revoked.
- apiproduct string
- (Output) Name of the API product.
- status string
- Status of the credential. Valid values include approved or revoked.
- apiproduct str
- (Output) Name of the API product.
- status str
- Status of the credential. Valid values include approved or revoked.
- apiproduct String
- (Output) Name of the API product.
- status String
- Status of the credential. Valid values include approved or revoked.
DeveloperAppCredentialAttribute, DeveloperAppCredentialAttributeArgs
Import
DeveloperApp can be imported using any of these accepted formats:
{{org_id}}/developers/{{developer_email}}/apps/{{name}}{{org_id}}/{{developer_email}}/{{name}}
When using the pulumi import command, DeveloperApp can be imported using one of the formats above. For example:
$ pulumi import gcp:apigee/developerApp:DeveloperApp default {{org_id}}/developers/{{developer_email}}/apps/{{name}}
$ pulumi import gcp:apigee/developerApp:DeveloperApp default {{org_id}}/{{developer_email}}/{{name}}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Google Cloud (GCP) Classic pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.
