apps

Creates, updates, deletes, gets or lists a apps resource.

Overview

Name	apps
Type	Resource
Id	google.apigee.apps

Fields

Name	Datatype	Description
name	string	Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations//appgroups//apps/*).
apiProducts	array	List of API products associated with the AppGroup app.
appGroup	string	Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations//appgroups/).
appId	string	Immutable. ID of the AppGroup app.
attributes	array	List of attributes for the AppGroup app.
callbackUrl	string	Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
createdAt	string	Output only. Time the AppGroup app was created in milliseconds since epoch.
credentials	array	Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products.
keyExpiresIn	string	Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup 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.
lastModifiedAt	string	Output only. Time the AppGroup app was modified in milliseconds since epoch.
scopes	array	Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
status	string	Status of the App. Valid values include approved or revoked.

Methods

Name	Accessible by	Required Params	Description
organizations_appgroups_apps_get	SELECT	appgroupsId, appsId, organizationsId	Returns the details for an AppGroup app.
organizations_appgroups_apps_list	SELECT	appgroupsId, organizationsId	Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.
organizations_apps_get	SELECT	appsId, organizationsId	Gets the app profile for the specified app ID.
organizations_apps_list	SELECT	organizationsId	Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).
organizations_developers_apps_get	SELECT	appsId, developersId, organizationsId	Returns the details for a developer app.
organizations_developers_apps_list	SELECT	developersId, organizationsId	Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the startKey and count query parameters.
organizations_appgroups_apps_create	INSERT	appgroupsId, organizationsId	Creates an app and associates it with an AppGroup. This API associates the AppGroup 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. The name is the unique ID of the app that you can use in API calls.
organizations_developers_apps_create	INSERT	developersId, organizationsId	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. The name is the unique ID of the app that you can use in API calls. The DisplayName (set as an attribute) appears in the UI. If you don't set the DisplayName attribute, the name appears in the UI.
organizations_appgroups_apps_delete	DELETE	appgroupsId, appsId, organizationsId	Deletes an AppGroup app. Note: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.
organizations_developers_apps_delete	DELETE	appsId, developersId, organizationsId	Deletes a developer app. Note: The delete operation is asynchronous. The developer app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.
organizations_appgroups_apps_update	REPLACE	appgroupsId, appsId, organizationsId	Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.
organizations_developers_apps_update	REPLACE	appsId, developersId, organizationsId	Updates the details for a developer app. In addition, you can add an API product to a developer app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateDeveloperAppKey API. Using this API, you cannot update the following: App name as it is the primary key used to identify the app and cannot be changed. Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.
organizations_developers_apps_attributes	EXEC	appsId, developersId, organizationsId	Updates attributes for a developer app. This API replaces the current attributes with those specified in the request.
organizations_developers_apps_generate_key_pair_or_update_developer_app_status	EXEC	appsId, developersId, organizationsId	Manages access to a developer app by enabling you to: Approve or revoke a developer app Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the action query parameter to approve or revoke, respectively, and the Content-Type header to application/octet-stream. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still approved. If successful, the API call returns the following HTTP status code: 204 No Content To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (approve or revoke) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The keyExpiresIn property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to -1, the API key never expires. Notes: When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API.

SELECT examples

Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).

SELECT
name,
apiProducts,
appGroup,
appId,
attributes,
callbackUrl,
createdAt,
credentials,
keyExpiresIn,
lastModifiedAt,
scopes,
status
FROM google.apigee.apps
WHERE organizationsId = '{{ organizationsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new apps resource.

All Properties

/*+ create */
INSERT INTO google.apigee.apps (
appgroupsId,
organizationsId,
callbackUrl,
appId,
apiProducts,
scopes,
keyExpiresIn,
status,
appGroup,
name,
attributes
)
SELECT 
'{{ appgroupsId }}',
'{{ organizationsId }}',
'{{ callbackUrl }}',
'{{ appId }}',
'{{ apiProducts }}',
'{{ scopes }}',
'{{ keyExpiresIn }}',
'{{ status }}',
'{{ appGroup }}',
'{{ name }}',
'{{ attributes }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: callbackUrl
      value: string
    - name: appId
      value: string
    - name: apiProducts
      value:
        - string
    - name: scopes
      value:
        - string
    - name: keyExpiresIn
      value: string
    - name: status
      value: string
    - name: appGroup
      value: string
    - name: lastModifiedAt
      value: string
    - name: createdAt
      value: string
    - name: name
      value: string
    - name: attributes
      value:
        - - name: name
            value: string
          - name: value
            value: string
    - name: credentials
      value:
        - - name: expiresAt
            value: string
          - name: consumerSecret
            value: string
          - name: apiProducts
            value:
              - - name: status
                  value: string
                - name: apiproduct
                  value: string
          - name: scopes
            value:
              - string
          - name: issuedAt
            value: string
          - name: consumerKey
            value: string
          - name: attributes
            value:
              - - name: name
                  value: string
                - name: value
                  value: string
          - name: status
            value: string

REPLACE example

Replaces all fields in the specified apps resource.

/*+ update */
REPLACE google.apigee.apps
SET 
callbackUrl = '{{ callbackUrl }}',
appId = '{{ appId }}',
apiProducts = '{{ apiProducts }}',
scopes = '{{ scopes }}',
keyExpiresIn = '{{ keyExpiresIn }}',
status = '{{ status }}',
appGroup = '{{ appGroup }}',
name = '{{ name }}',
attributes = '{{ attributes }}'
WHERE 
appgroupsId = '{{ appgroupsId }}'
AND appsId = '{{ appsId }}'
AND organizationsId = '{{ organizationsId }}';

DELETE example

Deletes the specified apps resource.

/*+ delete */
DELETE FROM google.apigee.apps
WHERE appgroupsId = '{{ appgroupsId }}'
AND appsId = '{{ appsId }}'
AND organizationsId = '{{ organizationsId }}';