2023-07-01
▼ ▲ apigee.organizations.appgroups.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns the AppGroup details for the provided AppGroup name in the request URI.
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}
Path: v1/{+name}
Parameter Order: name
HTTP Method: GET
Parameters:
name
Location: path
Type: string
Pattern: ^organizations/[^/]+/appgroups/[^/]+$
Required: Yes
Description: Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}`
▼ ▲ apigee.organizations.appgroups.list
Description: 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.
Parameter Order: parent
Parameters:
parent
Location: path
Type: string
Pattern: ^organizations/[^/]+$
Description: Required. Name of the Apigee organization. Use the following structure in your request: `organizations/{org}`.
Required: Yes
pageToken
Location: query
Description: The starting index record for listing the AppGroups.
Type: string
filter
Description: The filter expression to be used to get the list of AppGroups, where filtering can be done on name, correlationID or channelID of the app group. Example: filter = "name = foobar"
Type: string
Location: query
pageSize
Type: integer
Format: int32
Location: query
Description: Count of AppGroups a single page can have in the response. If unspecified, at most 1000 AppGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
HTTP Method: GET
Flat Path: v1/organizations/{organizationsId}/appgroups
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/appgroups
▼ ▲ apigee.organizations.appgroups.update
HTTP Method: PUT
Path: v1/{+name}
Parameters:
action
Location: query
Type: string
Description: Activate or de-activate the appGroup by setting the action as `active` or `inactive`. The `Content-Type` header must be set to `application/octet-stream`, with empty body.
name
Type: string
Required: Yes
Description: Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}`
Location: path
Pattern: ^organizations/[^/]+/appgroups/[^/]+$
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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. The custom attribute limit is 1000, and is how `__apigee_reserved__developer_details` can be updated. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.
▼ ▲ apigee.organizations.appgroups.create
Parameter Order: parent
Description: 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`. The attribute `Attribute` with key `attribute_name` as `__apigee_reserved__developer_details` can be used to store developers and their roles. The JSON format expected is: [ { "developer_id":"", "roles":[ "" ] } ] and is dealt in base64encoded format. Etag will be available in attribute `Attribute` with key `attribute_name` as `__apigee_reserved__developer_details_etag` for that AppGroup.
Flat Path: v1/organizations/{organizationsId}/appgroups
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Path: v1/{+parent}/appgroups
Parameters:
parent
Location: path
Type: string
Required: Yes
Pattern: ^organizations/[^/]+$
Description: Required. Name of the Apigee organization in which the AppGroup is created. Use the following structure in your request: `organizations/{org}`.
▼ ▲ apigee.organizations.appgroups.delete
HTTP Method: DELETE
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Required: Yes
Location: path
Description: Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}`
Type: string
Pattern: ^organizations/[^/]+/appgroups/[^/]+$
Description: 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.
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}
Parameter Order: name
▼ ▲ apigee.organizations.appgroups.apps.keys.apiproducts.updateAppGroupAppKeyApiProduct
Parameter Order: name
Description: Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to `revoked` will not allow access to the API.
Path: v1/{+name}
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Required. Name of the API product in the developer app key in the following format: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`
Required: Yes
Location: path
Pattern: ^organizations/[^/]+/appgroups/[^/]+/apps/[^/]+/keys/[^/]+/apiproducts/[^/]+$
Type: string
action
Location: query
Type: string
Description: Approve or revoke the consumer key by setting this value to `approve` or `revoke` respectively. The `Content-Type` header, if set, must be set to `application/octet-stream`, with empty body.
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}
▼ ▲ apigee.organizations.appgroups.apps.keys.apiproducts.delete
HTTP Method: DELETE
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}/apiproducts/{apiproductsId}
Parameters:
name
Description: Required. Parent of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}/apiproducts/{apiproduct}`
Type: string
Location: path
Pattern: ^organizations/[^/]+/appgroups/[^/]+/apps/[^/]+/keys/[^/]+/apiproducts/[^/]+$
Required: Yes
Description: Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. **Note**: The consumer key is not removed, only its association with the API product.
Path: v1/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ apigee.organizations.appgroups.apps.keys.get
HTTP Method: GET
Description: Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information.
Parameters:
name
Pattern: ^organizations/[^/]+/appgroups/[^/]+/apps/[^/]+/keys/[^/]+$
Required: Yes
Type: string
Description: Required. Name of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}`
Location: path
Path: v1/{+name}
Parameter Order: name
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}
▼ ▲ apigee.organizations.appgroups.apps.keys.create
HTTP Method: POST
Description: Creates a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the ProductizeAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.
Path: v1/{+parent}/keys
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys
Parameters:
parent
Type: string
Pattern: ^organizations/[^/]+/appgroups/[^/]+/apps/[^/]+$
Description: Required. Parent of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys`
Location: path
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
▼ ▲ apigee.organizations.appgroups.apps.keys.delete
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Description: Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs.
Parameters:
name
Type: string
Description: Required. Name of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}`
Location: path
Pattern: ^organizations/[^/]+/appgroups/[^/]+/apps/[^/]+/keys/[^/]+$
Required: Yes
▼ ▲ apigee.organizations.appgroups.apps.keys.updateAppGroupAppKey
Parameter Order: name
Path: v1/{+name}
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^organizations/[^/]+/appgroups/[^/]+/apps/[^/]+/keys/[^/]+$
Description: Required. Name of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}`
HTTP Method: POST
Description: Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes to the AppGroupAppKey. 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. You can use the same key to access all API products associated with the app.
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}/keys/{keysId}
▼ ▲ apigee.organizations.appgroups.apps.update
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}
Parameters:
action
Location: query
Description: Approve or revoke the consumer key by setting this value to `approve` or `revoke`. The `Content-Type` header must be set to `application/octet-stream`, with empty body.
Type: string
name
Type: string
Location: path
Description: Required. Name of the AppGroup app. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}`
Required: Yes
Pattern: ^organizations/[^/]+/appgroups/[^/]+/apps/[^/]+$
HTTP Method: PUT
Description: 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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1/{+name}
▼ ▲ apigee.organizations.appgroups.apps.get
HTTP Method: GET
Path: v1/{+name}
Description: Returns the details for an AppGroup app.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Type: string
Description: Required. Name of the AppGroup app. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}`
Location: path
Pattern: ^organizations/[^/]+/appgroups/[^/]+/apps/[^/]+$
Required: Yes
Parameter Order: name
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}
▼ ▲ apigee.organizations.appgroups.apps.list
Parameter Order: parent
Description: 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.
Parameters:
pageToken
Type: string
Description: Optional. Page token. If provides, must be a valid AppGroup app returned from a previous call that can be used to retrieve the next page.
Location: query
parent
Type: string
Description: Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}`
Pattern: ^organizations/[^/]+/appgroups/[^/]+$
Location: path
Required: Yes
pageSize
Format: int32
Type: integer
Location: query
Description: Optional. Maximum number entries to return. If unspecified, at most 1000 entries will be returned.
HTTP Method: GET
Path: v1/{+parent}/apps
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps
▼ ▲ apigee.organizations.appgroups.apps.delete
Path: v1/{+name}
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps/{appsId}
Parameter Order: name
Parameters:
name
Pattern: ^organizations/[^/]+/appgroups/[^/]+/apps/[^/]+$
Description: Required. Name of the AppGroup app. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}`
Required: Yes
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
HTTP Method: DELETE
▼ ▲ apigee.organizations.appgroups.apps.create
Parameter Order: parent
Description: 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.
HTTP Method: POST
Parameters:
parent
Description: Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}`
Pattern: ^organizations/[^/]+/appgroups/[^/]+$
Location: path
Type: string
Required: Yes
Path: v1/{+parent}/apps
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/organizations/{organizationsId}/appgroups/{appgroupsId}/apps
▼ ▲ apigee.organizations.apps.list
Parameters:
filter
Description: Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName and appType. Examples: "developerEmail=foo@bar.com", "appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and above.
Type: string
Location: query
pageToken
Type: string
Description: Optional. The starting index record for listing the developers. "page_token" is supported from ver 1.10.0 and above.
Location: query
pageSize
Description: Optional. Count of apps a single page can have in the response. If unspecified, at most 100 apps will be returned. The maximum value is 100; values above 100 will be coerced to 100. "page_size" is supported from ver 1.10.0 and above.
Type: integer
Format: int32
Location: query