attributes

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

Overview

Name	attributes
Type	Resource
Id	google.apigee.attributes

Fields

The following fields are returned by SELECT queries:

organizations_developers_apps_attributes_get

Successful response

Name	Datatype	Description
name	string	API key of the attribute.
value	string	Value of the attribute.

organizations_apiproducts_attributes_get

Successful response

Name	Datatype	Description
name	string	API key of the attribute.
value	string	Value of the attribute.

organizations_developers_apps_attributes_list

Successful response

Name	Datatype	Description
attribute	array	List of attributes.

organizations_developers_attributes_get

Successful response

Name	Datatype	Description
name	string	API key of the attribute.
value	string	Value of the attribute.

organizations_apiproducts_attributes_list

Successful response

Name	Datatype	Description
attribute	array	List of attributes.

organizations_developers_attributes_list

Successful response

Name	Datatype	Description
attribute	array	List of attributes.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_developers_apps_attributes_get	select	organizationsId, developersId, appsId, attributesId		Returns a developer app attribute.
organizations_apiproducts_attributes_get	select	organizationsId, apiproductsId, attributesId		Gets the value of an API product attribute.
organizations_developers_apps_attributes_list	select	organizationsId, developersId, appsId		Returns a list of all developer app attributes.
organizations_developers_attributes_get	select	organizationsId, developersId, attributesId		Returns the value of the specified developer attribute.
organizations_apiproducts_attributes_list	select	organizationsId, apiproductsId		Lists all API product attributes.
organizations_developers_attributes_list	select	organizationsId, developersId		Returns a list of all developer attributes.
organizations_developers_apps_attributes_delete	delete	organizationsId, developersId, appsId, attributesId		Deletes a developer app attribute.
organizations_apiproducts_attributes_delete	delete	organizationsId, apiproductsId, attributesId		Deletes an API product attribute.
organizations_developers_attributes_delete	delete	organizationsId, developersId, attributesId		Deletes a developer attribute.
organizations_apiproducts_attributes_update_api_product_attribute	exec	organizationsId, apiproductsId, attributesId		Updates the value of an API product attribute. 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 entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.
organizations_developers_apps_attributes_update_developer_app_attribute	exec	organizationsId, developersId, appsId, attributesId		Updates a developer app attribute. 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.
organizations_developers_attributes_update_developer_attribute	exec	organizationsId, developersId, attributesId		Updates a developer attribute. 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.

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
apiproductsId	string
appsId	string
attributesId	string
developersId	string
organizationsId	string

SELECT examples

organizations_developers_apps_attributes_get

Returns a developer app attribute.

SELECT
name,
value
FROM google.apigee.attributes
WHERE organizationsId = '{{ organizationsId }}' -- required
AND developersId = '{{ developersId }}' -- required
AND appsId = '{{ appsId }}' -- required
AND attributesId = '{{ attributesId }}' -- required;

organizations_apiproducts_attributes_get

Gets the value of an API product attribute.

SELECT
name,
value
FROM google.apigee.attributes
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apiproductsId = '{{ apiproductsId }}' -- required
AND attributesId = '{{ attributesId }}' -- required;

organizations_developers_apps_attributes_list

Returns a list of all developer app attributes.

SELECT
attribute
FROM google.apigee.attributes
WHERE organizationsId = '{{ organizationsId }}' -- required
AND developersId = '{{ developersId }}' -- required
AND appsId = '{{ appsId }}' -- required;

organizations_developers_attributes_get

Returns the value of the specified developer attribute.

SELECT
name,
value
FROM google.apigee.attributes
WHERE organizationsId = '{{ organizationsId }}' -- required
AND developersId = '{{ developersId }}' -- required
AND attributesId = '{{ attributesId }}' -- required;

organizations_apiproducts_attributes_list

Lists all API product attributes.

SELECT
attribute
FROM google.apigee.attributes
WHERE organizationsId = '{{ organizationsId }}' -- required
AND apiproductsId = '{{ apiproductsId }}' -- required;

organizations_developers_attributes_list

Returns a list of all developer attributes.

SELECT
attribute
FROM google.apigee.attributes
WHERE organizationsId = '{{ organizationsId }}' -- required
AND developersId = '{{ developersId }}' -- required;

DELETE examples

organizations_developers_apps_attributes_delete

Deletes a developer app attribute.

DELETE FROM google.apigee.attributes
WHERE organizationsId = '{{ organizationsId }}' --required
AND developersId = '{{ developersId }}' --required
AND appsId = '{{ appsId }}' --required
AND attributesId = '{{ attributesId }}' --required;

organizations_apiproducts_attributes_delete

Deletes an API product attribute.

DELETE FROM google.apigee.attributes
WHERE organizationsId = '{{ organizationsId }}' --required
AND apiproductsId = '{{ apiproductsId }}' --required
AND attributesId = '{{ attributesId }}' --required;

organizations_developers_attributes_delete

Deletes a developer attribute.

DELETE FROM google.apigee.attributes
WHERE organizationsId = '{{ organizationsId }}' --required
AND developersId = '{{ developersId }}' --required
AND attributesId = '{{ attributesId }}' --required;

Lifecycle Methods

organizations_apiproducts_attributes_update_api_product_attribute

Updates the value of an API product attribute. 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 entities also get cached for at least 180 seconds after entity is accessed during runtime. In this case, the ExpiresIn element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.

EXEC google.apigee.attributes.organizations_apiproducts_attributes_update_api_product_attribute 
@organizationsId='{{ organizationsId }}' --required, 
@apiproductsId='{{ apiproductsId }}' --required, 
@attributesId='{{ attributesId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"value": "{{ value }}"
}';

organizations_developers_apps_attributes_update_developer_app_attribute

Updates a developer app attribute. 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.

EXEC google.apigee.attributes.organizations_developers_apps_attributes_update_developer_app_attribute 
@organizationsId='{{ organizationsId }}' --required, 
@developersId='{{ developersId }}' --required, 
@appsId='{{ appsId }}' --required, 
@attributesId='{{ attributesId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"value": "{{ value }}"
}';

organizations_developers_attributes_update_developer_attribute

Updates a developer attribute. 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.

EXEC google.apigee.attributes.organizations_developers_attributes_update_developer_attribute 
@organizationsId='{{ organizationsId }}' --required, 
@developersId='{{ developersId }}' --required, 
@attributesId='{{ attributesId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"value": "{{ value }}"
}';