appgroups

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

Overview

Name	appgroups
Type	Resource
Id	google.apigee.appgroups

Fields

The following fields are returned by SELECT queries:

organizations_appgroups_get

Successful response

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 (int64)	Output only. Created time as milliseconds since epoch.
displayName	string	app group name displayed in the UI
lastModifiedAt	string (int64)	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.

organizations_appgroups_list

Successful response

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 (int64)	Output only. Created time as milliseconds since epoch.
displayName	string	app group name displayed in the UI
lastModifiedAt	string (int64)	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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_appgroups_get	select	organizationsId, appgroupsId		Returns the AppGroup details for the provided AppGroup name in the request URI.
organizations_appgroups_list	select	organizationsId	filter, pageSize, pageToken	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_update	replace	organizationsId, appgroupsId	action	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.
organizations_appgroups_delete	delete	organizationsId, appgroupsId		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 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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
appgroupsId	string
organizationsId	string
action	string
filter	string
pageSize	integer (int32)
pageToken	string

SELECT examples

organizations_appgroups_get

Returns the AppGroup details for the provided AppGroup name in the request URI.

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

organizations_appgroups_list

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 }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_appgroups_create

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.

INSERT INTO google.apigee.appgroups (
data__name,
data__channelUri,
data__channelId,
data__displayName,
data__organization,
data__status,
data__attributes,
organizationsId
)
SELECT 
'{{ name }}',
'{{ channelUri }}',
'{{ channelId }}',
'{{ displayName }}',
'{{ organization }}',
'{{ status }}',
'{{ attributes }}',
'{{ organizationsId }}'
RETURNING
name,
appGroupId,
attributes,
channelId,
channelUri,
createdAt,
displayName,
lastModifiedAt,
organization,
status
;

Manifest

# Description fields are for documentation purposes
- name: appgroups
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the appgroups resource.
    - name: name
      value: string
      description: >
        Immutable. Name of the AppGroup. Characters you can use in the name are restricted to: A-Z0-9._\-$ %.
        
    - name: channelUri
      value: string
      description: >
        A reference to the associated storefront/marketplace.
        
    - name: channelId
      value: string
      description: >
        channel identifier identifies the owner maintaing this grouping.
        
    - name: displayName
      value: string
      description: >
        app group name displayed in the UI
        
    - name: organization
      value: string
      description: >
        Immutable. the org the app group is created
        
    - name: status
      value: string
      description: >
        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`.
        
    - name: attributes
      value: array
      description: >
        A list of attributes
        

REPLACE examples

organizations_appgroups_update

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.

REPLACE google.apigee.appgroups
SET 
data__name = '{{ name }}',
data__channelUri = '{{ channelUri }}',
data__channelId = '{{ channelId }}',
data__displayName = '{{ displayName }}',
data__organization = '{{ organization }}',
data__status = '{{ status }}',
data__attributes = '{{ attributes }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND appgroupsId = '{{ appgroupsId }}' --required
AND action = '{{ action}}'
RETURNING
name,
appGroupId,
attributes,
channelId,
channelUri,
createdAt,
displayName,
lastModifiedAt,
organization,
status;

DELETE examples

organizations_appgroups_delete

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

DELETE FROM google.apigee.appgroups
WHERE organizationsId = '{{ organizationsId }}' --required
AND appgroupsId = '{{ appgroupsId }}' --required;