Google Cloud Native is in preview. Google Cloud Classic is fully supported.
google-native.apigee/v1.getDeveloperAppKey
Explore with Pulumi AI
Google Cloud Native is in preview. Google Cloud Classic is fully supported.
Gets details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.
Using getDeveloperAppKey
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDeveloperAppKey(args: GetDeveloperAppKeyArgs, opts?: InvokeOptions): Promise<GetDeveloperAppKeyResult>
function getDeveloperAppKeyOutput(args: GetDeveloperAppKeyOutputArgs, opts?: InvokeOptions): Output<GetDeveloperAppKeyResult>def get_developer_app_key(app_id: Optional[str] = None,
                          developer_id: Optional[str] = None,
                          key_id: Optional[str] = None,
                          organization_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetDeveloperAppKeyResult
def get_developer_app_key_output(app_id: Optional[pulumi.Input[str]] = None,
                          developer_id: Optional[pulumi.Input[str]] = None,
                          key_id: Optional[pulumi.Input[str]] = None,
                          organization_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetDeveloperAppKeyResult]func GetDeveloperAppKey(ctx *Context, args *GetDeveloperAppKeyArgs, opts ...InvokeOption) (*GetDeveloperAppKeyResult, error)
func GetDeveloperAppKeyOutput(ctx *Context, args *GetDeveloperAppKeyOutputArgs, opts ...InvokeOption) GetDeveloperAppKeyResultOutput> Note: This function is named GetDeveloperAppKey in the Go SDK.
public static class GetDeveloperAppKey 
{
    public static Task<GetDeveloperAppKeyResult> InvokeAsync(GetDeveloperAppKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetDeveloperAppKeyResult> Invoke(GetDeveloperAppKeyInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetDeveloperAppKeyResult> getDeveloperAppKey(GetDeveloperAppKeyArgs args, InvokeOptions options)
public static Output<GetDeveloperAppKeyResult> getDeveloperAppKey(GetDeveloperAppKeyArgs args, InvokeOptions options)
fn::invoke:
  function: google-native:apigee/v1:getDeveloperAppKey
  arguments:
    # arguments dictionaryThe following arguments are supported:
- AppId string
- DeveloperId string
- KeyId string
- OrganizationId string
- AppId string
- DeveloperId string
- KeyId string
- OrganizationId string
- appId String
- developerId String
- keyId String
- organizationId String
- appId string
- developerId string
- keyId string
- organizationId string
- app_id str
- developer_id str
- key_id str
- organization_id str
- appId String
- developerId String
- keyId String
- organizationId String
getDeveloperAppKey Result
The following output properties are available:
- ApiProducts List<object>
- List of API products for which the credential can be used. Note: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.
- Attributes
List<Pulumi.Google Native. Apigee. V1. Outputs. Google Cloud Apigee V1Attribute Response> 
- List of attributes associated with the credential.
- ConsumerKey string
- Consumer key.
- ConsumerSecret string
- Secret key.
- ExpiresAt string
- Time the developer app expires in milliseconds since epoch.
- ExpiresIn stringSeconds 
- Input only. Expiration time, in seconds, for the consumer key. 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.
- IssuedAt string
- Time the developer app was created in milliseconds since epoch.
- Scopes List<string>
- Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
- Status string
- Status of the credential. Valid values include approvedorrevoked.
- ApiProducts []interface{}
- List of API products for which the credential can be used. Note: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.
- Attributes
[]GoogleCloud Apigee V1Attribute Response 
- List of attributes associated with the credential.
- ConsumerKey string
- Consumer key.
- ConsumerSecret string
- Secret key.
- ExpiresAt string
- Time the developer app expires in milliseconds since epoch.
- ExpiresIn stringSeconds 
- Input only. Expiration time, in seconds, for the consumer key. 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.
- IssuedAt string
- Time the developer app was created in milliseconds since epoch.
- Scopes []string
- Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
- Status string
- Status of the credential. Valid values include approvedorrevoked.
- apiProducts List<Object>
- List of API products for which the credential can be used. Note: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.
- attributes
List<GoogleCloud Apigee V1Attribute Response> 
- List of attributes associated with the credential.
- consumerKey String
- Consumer key.
- consumerSecret String
- Secret key.
- expiresAt String
- Time the developer app expires in milliseconds since epoch.
- expiresIn StringSeconds 
- Input only. Expiration time, in seconds, for the consumer key. 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.
- issuedAt String
- Time the developer app was created in milliseconds since epoch.
- scopes List<String>
- Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
- status String
- Status of the credential. Valid values include approvedorrevoked.
- apiProducts any[]
- List of API products for which the credential can be used. Note: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.
- attributes
GoogleCloud Apigee V1Attribute Response[] 
- List of attributes associated with the credential.
- consumerKey string
- Consumer key.
- consumerSecret string
- Secret key.
- expiresAt string
- Time the developer app expires in milliseconds since epoch.
- expiresIn stringSeconds 
- Input only. Expiration time, in seconds, for the consumer key. 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.
- issuedAt string
- Time the developer app was created in milliseconds since epoch.
- scopes string[]
- Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
- status string
- Status of the credential. Valid values include approvedorrevoked.
- api_products Sequence[Any]
- List of API products for which the credential can be used. Note: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.
- attributes
Sequence[GoogleCloud Apigee V1Attribute Response] 
- List of attributes associated with the credential.
- consumer_key str
- Consumer key.
- consumer_secret str
- Secret key.
- expires_at str
- Time the developer app expires in milliseconds since epoch.
- expires_in_ strseconds 
- Input only. Expiration time, in seconds, for the consumer key. 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.
- issued_at str
- Time the developer app was created in milliseconds since epoch.
- scopes Sequence[str]
- Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
- status str
- Status of the credential. Valid values include approvedorrevoked.
- apiProducts List<Any>
- List of API products for which the credential can be used. Note: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.
- attributes List<Property Map>
- List of attributes associated with the credential.
- consumerKey String
- Consumer key.
- consumerSecret String
- Secret key.
- expiresAt String
- Time the developer app expires in milliseconds since epoch.
- expiresIn StringSeconds 
- Input only. Expiration time, in seconds, for the consumer key. 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.
- issuedAt String
- Time the developer app was created in milliseconds since epoch.
- scopes List<String>
- Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
- status String
- Status of the credential. Valid values include approvedorrevoked.
Supporting Types
GoogleCloudApigeeV1AttributeResponse    
Package Details
- Repository
- Google Cloud Native pulumi/pulumi-google-native
- License
- Apache-2.0
Google Cloud Native is in preview. Google Cloud Classic is fully supported.