developers

Creates, updates, deletes, gets or lists a developers resource.

Overview

Name	`developers`
Type	Resource
Id	`google.apigee.developers`

Fields

The following fields are returned by SELECT queries:

organizations_developers_get
organizations_developers_list

Successful response

Name	Datatype	Description
`accessType`	`string`	Access type.
`appFamily`	`string`	Developer app family.
`apps`	`array`	List of apps associated with the developer.
`attributes`	`array`	Optional. Developer attributes (name/value pairs). The custom attribute limit is 18.
`companies`	`array`	List of companies associated with the developer.
`createdAt`	`string (int64)`	Output only. Time at which the developer was created in milliseconds since epoch.
`developerId`	`string`	ID of the developer. Note: IDs are generated internally by Apigee and are not guaranteed to stay the same over time.
`email`	`string`	Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
`firstName`	`string`	Required. First name of the developer.
`lastModifiedAt`	`string (int64)`	Output only. Time at which the developer was last modified in milliseconds since epoch.
`lastName`	`string`	Required. Last name of the developer.
`organizationName`	`string`	Output only. Name of the Apigee organization in which the developer resides.
`status`	`string`	Output only. Status of the developer. Valid values are `active` and `inactive`.
`userName`	`string`	Required. User name of the developer. Not used by Apigee hybrid.

Successful response

Name	Datatype	Description
`developer`	`array`	List of developers.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`organizations_developers_get`	`select`	`organizationsId`, `developersId`	`action`	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.
`organizations_developers_list`	`select`	`organizationsId`	`expand`, `startKey`, `count`, `ids`, `includeCompany`, `app`	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.
`organizations_developers_create`	`insert`	`organizationsId`		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.
`organizations_developers_update`	`replace`	`organizationsId`, `developersId`		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.
`organizations_developers_delete`	`delete`	`organizationsId`, `developersId`		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 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.
`organizations_developers_set_developer_status`	`exec`	`organizationsId`, `developersId`	`action`	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`
`organizations_developers_attributes`	`exec`	`organizationsId`, `developersId`		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.

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
`developersId`	`string`
`organizationsId`	`string`
`action`	`string`
`app`	`string`
`count`	`string (int64)`
`expand`	`boolean`
`ids`	`string`
`includeCompany`	`boolean`
`startKey`	`string`

`SELECT` examples

organizations_developers_get
organizations_developers_list

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.

SELECT
accessType,
appFamily,
apps,
attributes,
companies,
createdAt,
developerId,
email,
firstName,
lastModifiedAt,
lastName,
organizationName,
status,
userName
FROM google.apigee.developers
WHERE organizationsId = '{{ organizationsId }}' -- required
AND developersId = '{{ developersId }}' -- required
AND action = '{{ action }}';

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.

SELECT
developer
FROM google.apigee.developers
WHERE organizationsId = '{{ organizationsId }}' -- required
AND expand = '{{ expand }}'
AND startKey = '{{ startKey }}'
AND count = '{{ count }}'
AND ids = '{{ ids }}'
AND includeCompany = '{{ includeCompany }}'
AND app = '{{ app }}';

`INSERT` examples

organizations_developers_create
Manifest

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.

INSERT INTO google.apigee.developers (
data__email,
data__firstName,
data__lastName,
data__userName,
data__attributes,
data__apps,
data__companies,
data__developerId,
data__accessType,
data__appFamily,
organizationsId
)
SELECT 
'{{ email }}',
'{{ firstName }}',
'{{ lastName }}',
'{{ userName }}',
'{{ attributes }}',
'{{ apps }}',
'{{ companies }}',
'{{ developerId }}',
'{{ accessType }}',
'{{ appFamily }}',
'{{ organizationsId }}'
RETURNING
accessType,
appFamily,
apps,
attributes,
companies,
createdAt,
developerId,
email,
firstName,
lastModifiedAt,
lastName,
organizationName,
status,
userName
;

# Description fields are for documentation purposes
- name: developers
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the developers resource.
    - name: email
      value: string
      description: >
        Required. Email address of the developer. This value is used to uniquely identify the developer in Apigee hybrid. Note that the email address has to be in lowercase only.
        
    - name: firstName
      value: string
      description: >
        Required. First name of the developer.
        
    - name: lastName
      value: string
      description: >
        Required. Last name of the developer.
        
    - name: userName
      value: string
      description: >
        Required. User name of the developer. Not used by Apigee hybrid.
        
    - name: attributes
      value: array
      description: >
        Optional. Developer attributes (name/value pairs). The custom attribute limit is 18.
        
    - name: apps
      value: array
      description: >
        List of apps associated with the developer.
        
    - name: companies
      value: array
      description: >
        List of companies associated with the developer.
        
    - name: developerId
      value: string
      description: >
        ID of the developer. **Note**: IDs are generated internally by Apigee and are not guaranteed to stay the same over time.
        
    - name: accessType
      value: string
      description: >
        Access type.
        
    - name: appFamily
      value: string
      description: >
        Developer app family.
        

`REPLACE` examples

organizations_developers_update

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.

REPLACE google.apigee.developers
SET 
data__email = '{{ email }}',
data__firstName = '{{ firstName }}',
data__lastName = '{{ lastName }}',
data__userName = '{{ userName }}',
data__attributes = '{{ attributes }}',
data__apps = '{{ apps }}',
data__companies = '{{ companies }}',
data__developerId = '{{ developerId }}',
data__accessType = '{{ accessType }}',
data__appFamily = '{{ appFamily }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND developersId = '{{ developersId }}' --required
RETURNING
accessType,
appFamily,
apps,
attributes,
companies,
createdAt,
developerId,
email,
firstName,
lastModifiedAt,
lastName,
organizationName,
status,
userName;

`DELETE` examples

organizations_developers_delete

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 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.developers
WHERE organizationsId = '{{ organizationsId }}' --required
AND developersId = '{{ developersId }}' --required;

Lifecycle Methods

organizations_developers_set_developer_status
organizations_developers_attributes

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

EXEC google.apigee.developers.organizations_developers_set_developer_status 
@organizationsId='{{ organizationsId }}' --required, 
@developersId='{{ developersId }}' --required, 
@action='{{ action }}';

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.

EXEC google.apigee.developers.organizations_developers_attributes 
@organizationsId='{{ organizationsId }}' --required, 
@developersId='{{ developersId }}' --required 
@@json=
'{
"attribute": "{{ attribute }}"
}';

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​