appgroups

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

Overview

Name	appgroups
Type	Resource
Id	google.apigee.appgroups

Fields

Name	Datatype	Description
name	string	Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._-$ %.
appGroupId	string	Output only. Internal identifier that cannot be edited
attributes	array	A list of attributes
channelId	string	channel identifier identifies the owner maintaing this grouping.
channelUri	string	A reference to the associated storefront/marketplace.
createdAt	string	Output only. Created time as milliseconds since epoch.
displayName	string	app group name displayed in the UI
lastModifiedAt	string	Output only. Modified time as milliseconds since epoch.
organization	string	Immutable. the org the app group is created
status	string	Valid values are active or inactive. Note that the status of the AppGroup should be updated via UpdateAppGroupRequest by setting the action as active or inactive.

Methods

Name	Accessible by	Required Params	Description
organizations_appgroups_get	SELECT	appgroupsId, organizationsId	Returns the AppGroup details for the provided AppGroup name in the request URI.
organizations_appgroups_list	SELECT	organizationsId	Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.
organizations_appgroups_create	INSERT	organizationsId	Creates an AppGroup. Once created, user can register apps under the AppGroup to obtain secret key and password. At creation time, the AppGroup's state is set as active.
organizations_appgroups_delete	DELETE	appgroupsId, organizationsId	Deletes an AppGroup. All app and API keys associations with the AppGroup are also removed. Warning: This API will permanently delete the AppGroup and related artifacts. Note: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as apps and API keys, may take anywhere from a few seconds to a few minutes to be deleted.
organizations_appgroups_update	REPLACE	appgroupsId, organizationsId	Updates an AppGroup. This API replaces the existing AppGroup details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. Note that the state of the AppGroup should be updated using action, and not via AppGroup.

SELECT examples

Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.

SELECT
name,
appGroupId,
attributes,
channelId,
channelUri,
createdAt,
displayName,
lastModifiedAt,
organization,
status
FROM google.apigee.appgroups
WHERE organizationsId = '{{ organizationsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.apigee.appgroups (
organizationsId,
name,
displayName,
status,
channelUri,
channelId,
organization,
attributes
)
SELECT 
'{{ organizationsId }}',
'{{ name }}',
'{{ displayName }}',
'{{ status }}',
'{{ channelUri }}',
'{{ channelId }}',
'{{ organization }}',
'{{ attributes }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: name
      value: string
    - name: displayName
      value: string
    - name: status
      value: string
    - name: appGroupId
      value: string
    - name: createdAt
      value: string
    - name: lastModifiedAt
      value: string
    - name: channelUri
      value: string
    - name: channelId
      value: string
    - name: organization
      value: string
    - name: attributes
      value:
        - - name: name
            value: string
          - name: value
            value: string

REPLACE example

Replaces all fields in the specified appgroups resource.

/*+ update */
REPLACE google.apigee.appgroups
SET 
name = '{{ name }}',
displayName = '{{ displayName }}',
status = '{{ status }}',
channelUri = '{{ channelUri }}',
channelId = '{{ channelId }}',
organization = '{{ organization }}',
attributes = '{{ attributes }}'
WHERE 
appgroupsId = '{{ appgroupsId }}'
AND organizationsId = '{{ organizationsId }}';

DELETE example

Deletes the specified appgroups resource.

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