OrganizationsDevelopers
class OrganizationsDevelopers extends Resource (View source)
The "developers" collection of methods.
Typical usage is:
$apigeeService = new Google\Service\Apigee(...);
$developers = $apigeeService->organizations_developers;Methods
Updates developer attributes. This API replaces the existing attributes with
those specified in the request. Add new attributes, and include or exclude
any existing attributes that you want to retain or remove, respectively. The
custom attribute limit is 18. Note: OAuth access tokens and Key
Management Service (KMS) entities (apps, developers, and API products) are
cached for 180 seconds (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.
Creates a developer. Once created, the developer can register an app and
obtain an API key. At creation time, a developer is set as active. To
change the developer status, use the SetDeveloperStatus API.
Deletes a developer. All apps and API keys associated with the developer are
also removed. Warning: This API will permanently delete the developer and
related artifacts. To avoid permanently deleting developers and their
artifacts, set the developer status to inactive using the
SetDeveloperStatus API. Note: The delete operation is asynchronous. The
developer 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. (developers.delete)
Returns the developer details, including the developer's name, email address, apps, and other information. Note: The response includes only the first 100 developer apps. (developers.get)
Gets the account balance for the developer. (developers.getBalance)
Gets the monetization configuration for the developer.
Lists all developers in an organization by email address. By default, the
response does not include company developers. Set the includeCompany query
parameter to true to include company developers. Note: A maximum of
1000 developers are returned in the response. You paginate the list of
developers returned using the startKey and count query parameters.
Sets the status of a developer. A developer is active by default. If you
set a developer's status to inactive, the API keys assigned to the
developer apps are no longer valid even though the API keys are set to
approved. Inactive developers can still sign in to the developer portal and
create apps; however, any new API keys generated during app creation won't
work. To set the status of a developer, set the action query parameter to
active or inactive, and the Content-Type header to application/octet- stream. If successful, the API call returns the following HTTP status code:
204 No Content (developers.setDeveloperStatus)
Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18.
Updates the monetization configuration for the developer.
Details
GoogleCloudApigeeV1Attributes
attributes(string $parent, GoogleCloudApigeeV1Attributes $postBody, array $optParams = [])
Updates developer attributes. This API replaces the existing attributes with
those specified in the request. Add new attributes, and include or exclude
any existing attributes that you want to retain or remove, respectively. The
custom attribute limit is 18. Note: OAuth access tokens and Key
Management Service (KMS) entities (apps, developers, and API products) are
cached for 180 seconds (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.
(developers.attributes)
GoogleCloudApigeeV1Developer
create(string $parent, GoogleCloudApigeeV1Developer $postBody, array $optParams = [])
Creates a developer. Once created, the developer can register an app and
obtain an API key. At creation time, a developer is set as active. To
change the developer status, use the SetDeveloperStatus API.
(developers.create)
GoogleCloudApigeeV1Developer
delete(string $name, array $optParams = [])
Deletes a developer. All apps and API keys associated with the developer are
also removed. Warning: This API will permanently delete the developer and
related artifacts. To avoid permanently deleting developers and their
artifacts, set the developer status to inactive using the
SetDeveloperStatus API. Note: The delete operation is asynchronous. The
developer 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. (developers.delete)
GoogleCloudApigeeV1Developer
get(string $name, array $optParams = [])
Returns the developer details, including the developer's name, email address, apps, and other information. Note: The response includes only the first 100 developer apps. (developers.get)
GoogleCloudApigeeV1DeveloperBalance
getBalance(string $name, array $optParams = [])
Gets the account balance for the developer. (developers.getBalance)
GoogleCloudApigeeV1DeveloperMonetizationConfig
getMonetizationConfig(string $name, array $optParams = [])
Gets the monetization configuration for the developer.
(developers.getMonetizationConfig)
GoogleCloudApigeeV1ListOfDevelopersResponse
listOrganizationsDevelopers(string $parent, array $optParams = [])
Lists all developers in an organization by email address. By default, the
response does not include company developers. Set the includeCompany query
parameter to true to include company developers. Note: A maximum of
1000 developers are returned in the response. You paginate the list of
developers returned using the startKey and count query parameters.
(developers.listOrganizationsDevelopers)
GoogleProtobufEmpty
setDeveloperStatus(string $name, array $optParams = [])
Sets the status of a developer. A developer is active by default. If you
set a developer's status to inactive, the API keys assigned to the
developer apps are no longer valid even though the API keys are set to
approved. Inactive developers can still sign in to the developer portal and
create apps; however, any new API keys generated during app creation won't
work. To set the status of a developer, set the action query parameter to
active or inactive, and the Content-Type header to application/octet- stream. If successful, the API call returns the following HTTP status code:
204 No Content (developers.setDeveloperStatus)
GoogleCloudApigeeV1Developer
update(string $name, GoogleCloudApigeeV1Developer $postBody, array $optParams = [])
Updates a developer. This API replaces the existing developer details with those specified in the request. Include or exclude any existing details that you want to retain or delete, respectively. The custom attribute limit is 18.
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. (developers.update)
GoogleCloudApigeeV1DeveloperMonetizationConfig
updateMonetizationConfig(string $name, GoogleCloudApigeeV1DeveloperMonetizationConfig $postBody, array $optParams = [])
Updates the monetization configuration for the developer.
(developers.updateMonetizationConfig)