class OrganizationsDevelopersApps extends Resource (View source)

The "apps" collection of methods.

Typical usage is:

 $apigeeService = new Google\Service\Apigee(...);
 $apps = $apigeeService->organizations_developers_apps;

Methods

attributes(string $name, GoogleCloudApigeeV1Attributes $postBody, array $optParams = [])

Updates attributes for a developer app. This API replaces the current attributes with those specified in the request. (apps.attributes)

create(string $parent, GoogleCloudApigeeV1DeveloperApp $postBody, array $optParams = [])

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. (apps.create)

delete(string $name, array $optParams = [])

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. (apps.delete)

generateKeyPairOrUpdateDeveloperAppStatus(string $name, GoogleCloudApigeeV1DeveloperApp $postBody, array $optParams = [])

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.

get(string $name, array $optParams = [])

Returns the details for a developer app. (apps.get)

listOrganizationsDevelopersApps(string $parent, array $optParams = [])

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.

update(string $name, GoogleCloudApigeeV1DeveloperApp $postBody, array $optParams = [])

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. (apps.update)

Details

GoogleCloudApigeeV1Attributes attributes(string $name, GoogleCloudApigeeV1Attributes $postBody, array $optParams = [])

Updates attributes for a developer app. This API replaces the current attributes with those specified in the request. (apps.attributes)

Parameters

string $name

Required. Name of the developer app. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}

GoogleCloudApigeeV1Attributes $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1Attributes

Exceptions

Exception

GoogleCloudApigeeV1DeveloperApp create(string $parent, GoogleCloudApigeeV1DeveloperApp $postBody, array $optParams = [])

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. (apps.create)

Parameters

string $parent

Required. Name of the developer. Use the following structure in your request: organizations/{org}/developers/{developer_email}

GoogleCloudApigeeV1DeveloperApp $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeveloperApp

Exceptions

Exception

GoogleCloudApigeeV1DeveloperApp delete(string $name, array $optParams = [])

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. (apps.delete)

Parameters

string $name

Required. Name of the developer app. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeveloperApp

Exceptions

Exception

GoogleCloudApigeeV1DeveloperApp generateKeyPairOrUpdateDeveloperAppStatus(string $name, GoogleCloudApigeeV1DeveloperApp $postBody, array $optParams = [])

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. (apps.generateKeyPairOrUpdateDeveloperAppStatus)

Parameters

string $name

Required. Name of the developer app. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}

GoogleCloudApigeeV1DeveloperApp $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeveloperApp

Exceptions

Exception

GoogleCloudApigeeV1DeveloperApp get(string $name, array $optParams = [])

Returns the details for a developer app. (apps.get)

Parameters

string $name

Required. Name of the developer app. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeveloperApp

Exceptions

Exception

GoogleCloudApigeeV1ListDeveloperAppsResponse listOrganizationsDevelopersApps(string $parent, array $optParams = [])

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.

(apps.listOrganizationsDevelopersApps)

Parameters

string $parent

Required. Name of the developer. Use the following structure in your request: organizations/{org}/developers/{developer_email}

array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1ListDeveloperAppsResponse

Exceptions

Exception

GoogleCloudApigeeV1DeveloperApp update(string $name, GoogleCloudApigeeV1DeveloperApp $postBody, array $optParams = [])

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. (apps.update)

Parameters

string $name

Required. Name of the developer app. Use the following structure in your request: organizations/{org}/developers/{developer_email}/apps/{app}

GoogleCloudApigeeV1DeveloperApp $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudApigeeV1DeveloperApp

Exceptions

Exception