Google Native

v0.27.0 published on Friday, Oct 21, 2022 by Pulumi

getKey

Gets details for a consumer key for a developer app, including the key and secret value, associated API products, and other information.

Using getKey

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 getKey(args: GetKeyArgs, opts?: InvokeOptions): Promise<GetKeyResult>
function getKeyOutput(args: GetKeyOutputArgs, opts?: InvokeOptions): Output<GetKeyResult>
def get_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) -> GetKeyResult
def get_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[GetKeyResult]
func GetKey(ctx *Context, args *GetKeyArgs, opts ...InvokeOption) (*GetKeyResult, error)
func GetKeyOutput(ctx *Context, args *GetKeyOutputArgs, opts ...InvokeOption) GetKeyResultOutput

> Note: This function is named GetKey in the Go SDK.

public static class GetKey 
{
    public static Task<GetKeyResult> InvokeAsync(GetKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetKeyResult> Invoke(GetKeyInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKeyResult> getKey(GetKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: google-native:apigee/v1:getKey
  arguments:
    # arguments dictionary

The 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
appId String
developerId String
keyId String
organizationId String

getKey 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.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1AttributeResponse>

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.

ExpiresInSeconds string

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 approved or revoked.

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 []GoogleCloudApigeeV1AttributeResponse

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.

ExpiresInSeconds string

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 approved or revoked.

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<GoogleCloudApigeeV1AttributeResponse>

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.

expiresInSeconds String

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 approved or revoked.

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 GoogleCloudApigeeV1AttributeResponse[]

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.

expiresInSeconds string

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 approved or revoked.

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[GoogleCloudApigeeV1AttributeResponse]

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_seconds str

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 approved or revoked.

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.

expiresInSeconds String

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 approved or revoked.

Supporting Types

GoogleCloudApigeeV1AttributeResponse

Name string

API key of the attribute.

Value string

Value of the attribute.

Name string

API key of the attribute.

Value string

Value of the attribute.

name String

API key of the attribute.

value String

Value of the attribute.

name string

API key of the attribute.

value string

Value of the attribute.

name str

API key of the attribute.

value str

Value of the attribute.

name String

API key of the attribute.

value String

Value of the attribute.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0