Docs Packages
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. getAppGroupAppKey

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.apigee/v1.getAppGroupAppKey

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

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

    Using getAppGroupAppKey

    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 getAppGroupAppKey(args: GetAppGroupAppKeyArgs, opts?: InvokeOptions): Promise<GetAppGroupAppKeyResult>
function getAppGroupAppKeyOutput(args: GetAppGroupAppKeyOutputArgs, opts?: InvokeOptions): Output<GetAppGroupAppKeyResult>
    def get_app_group_app_key(app_id: Optional[str] = None,
                          appgroup_id: Optional[str] = None,
                          key_id: Optional[str] = None,
                          organization_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetAppGroupAppKeyResult
def get_app_group_app_key_output(app_id: Optional[pulumi.Input[str]] = None,
                          appgroup_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[GetAppGroupAppKeyResult]
    func GetAppGroupAppKey(ctx *Context, args *GetAppGroupAppKeyArgs, opts ...InvokeOption) (*GetAppGroupAppKeyResult, error)
func GetAppGroupAppKeyOutput(ctx *Context, args *GetAppGroupAppKeyOutputArgs, opts ...InvokeOption) GetAppGroupAppKeyResultOutput

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

    public static class GetAppGroupAppKey 
{
    public static Task<GetAppGroupAppKeyResult> InvokeAsync(GetAppGroupAppKeyArgs args, InvokeOptions? opts = null)
    public static Output<GetAppGroupAppKeyResult> Invoke(GetAppGroupAppKeyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetAppGroupAppKeyResult> getAppGroupAppKey(GetAppGroupAppKeyArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:apigee/v1:getAppGroupAppKey
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AppId string
    AppgroupId string
    KeyId string
    OrganizationId string
    AppId string
    AppgroupId string
    KeyId string
    OrganizationId string
    appId String
    appgroupId String
    keyId String
    organizationId String
    appId string
    appgroupId string
    keyId string
    organizationId string
    appId String
    appgroupId String
    keyId String
    organizationId String

    getAppGroupAppKey Result

    The following output properties are available:

    ApiProducts List<Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1APIProductAssociationResponse>
    List of API products and its status for which the credential can be used. Note: Use UpdateAppGroupAppKeyApiProductRequest 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
    Immutable. Consumer key.
    ConsumerSecret string
    Secret key.
    ExpiresAt string
    Time the AppGroup app expires in milliseconds since epoch.
    ExpiresInSeconds string
    Immutable. 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 AppGroup 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 []GoogleCloudApigeeV1APIProductAssociationResponse
    List of API products and its status for which the credential can be used. Note: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
    Attributes []GoogleCloudApigeeV1AttributeResponse
    List of attributes associated with the credential.
    ConsumerKey string
    Immutable. Consumer key.
    ConsumerSecret string
    Secret key.
    ExpiresAt string
    Time the AppGroup app expires in milliseconds since epoch.
    ExpiresInSeconds string
    Immutable. 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 AppGroup 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<GoogleCloudApigeeV1APIProductAssociationResponse>
    List of API products and its status for which the credential can be used. Note: Use UpdateAppGroupAppKeyApiProductRequest 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
    Immutable. Consumer key.
    consumerSecret String
    Secret key.
    expiresAt String
    Time the AppGroup app expires in milliseconds since epoch.
    expiresInSeconds String
    Immutable. 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 AppGroup 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 GoogleCloudApigeeV1APIProductAssociationResponse[]
    List of API products and its status for which the credential can be used. Note: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
    attributes GoogleCloudApigeeV1AttributeResponse[]
    List of attributes associated with the credential.
    consumerKey string
    Immutable. Consumer key.
    consumerSecret string
    Secret key.
    expiresAt string
    Time the AppGroup app expires in milliseconds since epoch.
    expiresInSeconds string
    Immutable. 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 AppGroup 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[GoogleCloudApigeeV1APIProductAssociationResponse]
    List of API products and its status for which the credential can be used. Note: Use UpdateAppGroupAppKeyApiProductRequest 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
    Immutable. Consumer key.
    consumer_secret str
    Secret key.
    expires_at str
    Time the AppGroup app expires in milliseconds since epoch.
    expires_in_seconds str
    Immutable. 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 AppGroup 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<Property Map>
    List of API products and its status for which the credential can be used. Note: Use UpdateAppGroupAppKeyApiProductRequest 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
    Immutable. Consumer key.
    consumerSecret String
    Secret key.
    expiresAt String
    Time the AppGroup app expires in milliseconds since epoch.
    expiresInSeconds String
    Immutable. 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 AppGroup 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

    GoogleCloudApigeeV1APIProductAssociationResponse

    Apiproduct string
    API product to be associated with the credential.
    Status string
    The API product credential associated status. Valid values are approved or revoked.
    Apiproduct string
    API product to be associated with the credential.
    Status string
    The API product credential associated status. Valid values are approved or revoked.
    apiproduct String
    API product to be associated with the credential.
    status String
    The API product credential associated status. Valid values are approved or revoked.
    apiproduct string
    API product to be associated with the credential.
    status string
    The API product credential associated status. Valid values are approved or revoked.
    apiproduct str
    API product to be associated with the credential.
    status str
    The API product credential associated status. Valid values are approved or revoked.
    apiproduct String
    API product to be associated with the credential.
    status String
    The API product credential associated status. Valid values are approved or revoked.

    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
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native