1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.developers.html">developers</a> . <a href="apigee_v1.organizations.developers.apps.html">apps</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="apigee_v1.organizations.developers.apps.attributes.html">attributes()</a></code> 79</p> 80<p class="firstline">Returns the attributes Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="apigee_v1.organizations.developers.apps.keys.html">keys()</a></code> 84</p> 85<p class="firstline">Returns the keys Resource.</p> 86 87<p class="toc_element"> 88 <code><a href="#close">close()</a></code></p> 89<p class="firstline">Close httplib2 connections.</p> 90<p class="toc_element"> 91 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 92<p class="firstline">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.</p> 93<p class="toc_element"> 94 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 95<p class="firstline">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.</p> 96<p class="toc_element"> 97 <code><a href="#generateKeyPairOrUpdateDeveloperAppStatus">generateKeyPairOrUpdateDeveloperAppStatus(name, action=None, body=None, x__xgafv=None)</a></code></p> 98<p class="firstline">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 `approved` or `revoked`, 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 (`approved` or `revoked`) 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.</p> 99<p class="toc_element"> 100 <code><a href="#get">get(name, entity=None, query=None, x__xgafv=None)</a></code></p> 101<p class="firstline">Returns the details for a developer app.</p> 102<p class="toc_element"> 103 <code><a href="#list">list(parent, count=None, expand=None, shallowExpand=None, startKey=None, x__xgafv=None)</a></code></p> 104<p class="firstline">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.</p> 105<p class="toc_element"> 106 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p> 107<p class="firstline">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.</p> 108<h3>Method Details</h3> 109<div class="method"> 110 <code class="details" id="close">close()</code> 111 <pre>Close httplib2 connections.</pre> 112</div> 113 114<div class="method"> 115 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 116 <pre>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. 117 118Args: 119 parent: string, Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}` (required) 120 body: object, The request body. 121 The object takes the form of: 122 123{ 124 "apiProducts": [ # List of API products associated with the developer app. 125 "A String", 126 ], 127 "appFamily": "A String", # Developer app family. 128 "appId": "A String", # ID of the developer app. 129 "attributes": [ # List of attributes for the developer app. 130 { # Key-value pair to store extra metadata. 131 "name": "A String", # API key of the attribute. 132 "value": "A String", # Value of the attribute. 133 }, 134 ], 135 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. 136 "createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch. 137 "credentials": [ # Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. 138 { 139 "apiProducts": [ # List of API products this credential can be used for. 140 { 141 "apiproduct": "A String", # Name of the API product. 142 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 143 }, 144 ], 145 "attributes": [ # List of attributes associated with this credential. 146 { # Key-value pair to store extra metadata. 147 "name": "A String", # API key of the attribute. 148 "value": "A String", # Value of the attribute. 149 }, 150 ], 151 "consumerKey": "A String", # Consumer key. 152 "consumerSecret": "A String", # Secret key. 153 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 154 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 155 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 156 "A String", 157 ], 158 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 159 }, 160 ], 161 "developerId": "A String", # ID of the developer. 162 "keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. 163 "lastModifiedAt": "A String", # Output only. Time the developer app was modified in milliseconds since epoch. 164 "name": "A String", # Name of the developer app. 165 "scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. 166 "A String", 167 ], 168 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 169} 170 171 x__xgafv: string, V1 error format. 172 Allowed values 173 1 - v1 error format 174 2 - v2 error format 175 176Returns: 177 An object of the form: 178 179 { 180 "apiProducts": [ # List of API products associated with the developer app. 181 "A String", 182 ], 183 "appFamily": "A String", # Developer app family. 184 "appId": "A String", # ID of the developer app. 185 "attributes": [ # List of attributes for the developer app. 186 { # Key-value pair to store extra metadata. 187 "name": "A String", # API key of the attribute. 188 "value": "A String", # Value of the attribute. 189 }, 190 ], 191 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. 192 "createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch. 193 "credentials": [ # Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. 194 { 195 "apiProducts": [ # List of API products this credential can be used for. 196 { 197 "apiproduct": "A String", # Name of the API product. 198 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 199 }, 200 ], 201 "attributes": [ # List of attributes associated with this credential. 202 { # Key-value pair to store extra metadata. 203 "name": "A String", # API key of the attribute. 204 "value": "A String", # Value of the attribute. 205 }, 206 ], 207 "consumerKey": "A String", # Consumer key. 208 "consumerSecret": "A String", # Secret key. 209 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 210 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 211 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 212 "A String", 213 ], 214 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 215 }, 216 ], 217 "developerId": "A String", # ID of the developer. 218 "keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. 219 "lastModifiedAt": "A String", # Output only. Time the developer app was modified in milliseconds since epoch. 220 "name": "A String", # Name of the developer app. 221 "scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. 222 "A String", 223 ], 224 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 225}</pre> 226</div> 227 228<div class="method"> 229 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 230 <pre>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. 231 232Args: 233 name: string, Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}` (required) 234 x__xgafv: string, V1 error format. 235 Allowed values 236 1 - v1 error format 237 2 - v2 error format 238 239Returns: 240 An object of the form: 241 242 { 243 "apiProducts": [ # List of API products associated with the developer app. 244 "A String", 245 ], 246 "appFamily": "A String", # Developer app family. 247 "appId": "A String", # ID of the developer app. 248 "attributes": [ # List of attributes for the developer app. 249 { # Key-value pair to store extra metadata. 250 "name": "A String", # API key of the attribute. 251 "value": "A String", # Value of the attribute. 252 }, 253 ], 254 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. 255 "createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch. 256 "credentials": [ # Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. 257 { 258 "apiProducts": [ # List of API products this credential can be used for. 259 { 260 "apiproduct": "A String", # Name of the API product. 261 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 262 }, 263 ], 264 "attributes": [ # List of attributes associated with this credential. 265 { # Key-value pair to store extra metadata. 266 "name": "A String", # API key of the attribute. 267 "value": "A String", # Value of the attribute. 268 }, 269 ], 270 "consumerKey": "A String", # Consumer key. 271 "consumerSecret": "A String", # Secret key. 272 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 273 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 274 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 275 "A String", 276 ], 277 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 278 }, 279 ], 280 "developerId": "A String", # ID of the developer. 281 "keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. 282 "lastModifiedAt": "A String", # Output only. Time the developer app was modified in milliseconds since epoch. 283 "name": "A String", # Name of the developer app. 284 "scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. 285 "A String", 286 ], 287 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 288}</pre> 289</div> 290 291<div class="method"> 292 <code class="details" id="generateKeyPairOrUpdateDeveloperAppStatus">generateKeyPairOrUpdateDeveloperAppStatus(name, action=None, body=None, x__xgafv=None)</code> 293 <pre>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 `approved` or `revoked`, 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 (`approved` or `revoked`) 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. 294 295Args: 296 name: string, Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}` (required) 297 body: object, The request body. 298 The object takes the form of: 299 300{ 301 "apiProducts": [ # List of API products associated with the developer app. 302 "A String", 303 ], 304 "appFamily": "A String", # Developer app family. 305 "appId": "A String", # ID of the developer app. 306 "attributes": [ # List of attributes for the developer app. 307 { # Key-value pair to store extra metadata. 308 "name": "A String", # API key of the attribute. 309 "value": "A String", # Value of the attribute. 310 }, 311 ], 312 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. 313 "createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch. 314 "credentials": [ # Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. 315 { 316 "apiProducts": [ # List of API products this credential can be used for. 317 { 318 "apiproduct": "A String", # Name of the API product. 319 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 320 }, 321 ], 322 "attributes": [ # List of attributes associated with this credential. 323 { # Key-value pair to store extra metadata. 324 "name": "A String", # API key of the attribute. 325 "value": "A String", # Value of the attribute. 326 }, 327 ], 328 "consumerKey": "A String", # Consumer key. 329 "consumerSecret": "A String", # Secret key. 330 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 331 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 332 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 333 "A String", 334 ], 335 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 336 }, 337 ], 338 "developerId": "A String", # ID of the developer. 339 "keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. 340 "lastModifiedAt": "A String", # Output only. Time the developer app was modified in milliseconds since epoch. 341 "name": "A String", # Name of the developer app. 342 "scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. 343 "A String", 344 ], 345 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 346} 347 348 action: string, Action. Valid values are `approve` or `revoke`. 349 x__xgafv: string, V1 error format. 350 Allowed values 351 1 - v1 error format 352 2 - v2 error format 353 354Returns: 355 An object of the form: 356 357 { 358 "apiProducts": [ # List of API products associated with the developer app. 359 "A String", 360 ], 361 "appFamily": "A String", # Developer app family. 362 "appId": "A String", # ID of the developer app. 363 "attributes": [ # List of attributes for the developer app. 364 { # Key-value pair to store extra metadata. 365 "name": "A String", # API key of the attribute. 366 "value": "A String", # Value of the attribute. 367 }, 368 ], 369 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. 370 "createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch. 371 "credentials": [ # Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. 372 { 373 "apiProducts": [ # List of API products this credential can be used for. 374 { 375 "apiproduct": "A String", # Name of the API product. 376 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 377 }, 378 ], 379 "attributes": [ # List of attributes associated with this credential. 380 { # Key-value pair to store extra metadata. 381 "name": "A String", # API key of the attribute. 382 "value": "A String", # Value of the attribute. 383 }, 384 ], 385 "consumerKey": "A String", # Consumer key. 386 "consumerSecret": "A String", # Secret key. 387 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 388 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 389 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 390 "A String", 391 ], 392 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 393 }, 394 ], 395 "developerId": "A String", # ID of the developer. 396 "keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. 397 "lastModifiedAt": "A String", # Output only. Time the developer app was modified in milliseconds since epoch. 398 "name": "A String", # Name of the developer app. 399 "scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. 400 "A String", 401 ], 402 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 403}</pre> 404</div> 405 406<div class="method"> 407 <code class="details" id="get">get(name, entity=None, query=None, x__xgafv=None)</code> 408 <pre>Returns the details for a developer app. 409 410Args: 411 name: string, Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}` (required) 412 entity: string, **Note**: Must be used in conjunction with the `query` parameter. Set to `apiresources` to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization. 413 query: string, **Note**: Must be used in conjunction with the `entity` parameter. Set to `count` to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization. 414 x__xgafv: string, V1 error format. 415 Allowed values 416 1 - v1 error format 417 2 - v2 error format 418 419Returns: 420 An object of the form: 421 422 { 423 "apiProducts": [ # List of API products associated with the developer app. 424 "A String", 425 ], 426 "appFamily": "A String", # Developer app family. 427 "appId": "A String", # ID of the developer app. 428 "attributes": [ # List of attributes for the developer app. 429 { # Key-value pair to store extra metadata. 430 "name": "A String", # API key of the attribute. 431 "value": "A String", # Value of the attribute. 432 }, 433 ], 434 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. 435 "createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch. 436 "credentials": [ # Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. 437 { 438 "apiProducts": [ # List of API products this credential can be used for. 439 { 440 "apiproduct": "A String", # Name of the API product. 441 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 442 }, 443 ], 444 "attributes": [ # List of attributes associated with this credential. 445 { # Key-value pair to store extra metadata. 446 "name": "A String", # API key of the attribute. 447 "value": "A String", # Value of the attribute. 448 }, 449 ], 450 "consumerKey": "A String", # Consumer key. 451 "consumerSecret": "A String", # Secret key. 452 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 453 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 454 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 455 "A String", 456 ], 457 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 458 }, 459 ], 460 "developerId": "A String", # ID of the developer. 461 "keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. 462 "lastModifiedAt": "A String", # Output only. Time the developer app was modified in milliseconds since epoch. 463 "name": "A String", # Name of the developer app. 464 "scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. 465 "A String", 466 ], 467 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 468}</pre> 469</div> 470 471<div class="method"> 472 <code class="details" id="list">list(parent, count=None, expand=None, shallowExpand=None, startKey=None, x__xgafv=None)</code> 473 <pre>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. 474 475Args: 476 parent: string, Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}` (required) 477 count: string, Number of developer apps to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000. 478 expand: boolean, Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters. 479 shallowExpand: boolean, Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode. 480 startKey: string, **Note**: Must be used in conjunction with the `count` parameter. Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the `count` query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive. 481 x__xgafv: string, V1 error format. 482 Allowed values 483 1 - v1 error format 484 2 - v2 error format 485 486Returns: 487 An object of the form: 488 489 { 490 "app": [ # List of developer apps and their credentials. 491 { 492 "apiProducts": [ # List of API products associated with the developer app. 493 "A String", 494 ], 495 "appFamily": "A String", # Developer app family. 496 "appId": "A String", # ID of the developer app. 497 "attributes": [ # List of attributes for the developer app. 498 { # Key-value pair to store extra metadata. 499 "name": "A String", # API key of the attribute. 500 "value": "A String", # Value of the attribute. 501 }, 502 ], 503 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. 504 "createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch. 505 "credentials": [ # Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. 506 { 507 "apiProducts": [ # List of API products this credential can be used for. 508 { 509 "apiproduct": "A String", # Name of the API product. 510 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 511 }, 512 ], 513 "attributes": [ # List of attributes associated with this credential. 514 { # Key-value pair to store extra metadata. 515 "name": "A String", # API key of the attribute. 516 "value": "A String", # Value of the attribute. 517 }, 518 ], 519 "consumerKey": "A String", # Consumer key. 520 "consumerSecret": "A String", # Secret key. 521 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 522 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 523 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 524 "A String", 525 ], 526 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 527 }, 528 ], 529 "developerId": "A String", # ID of the developer. 530 "keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. 531 "lastModifiedAt": "A String", # Output only. Time the developer app was modified in milliseconds since epoch. 532 "name": "A String", # Name of the developer app. 533 "scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. 534 "A String", 535 ], 536 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 537 }, 538 ], 539}</pre> 540</div> 541 542<div class="method"> 543 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code> 544 <pre>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. 545 546Args: 547 name: string, Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}` (required) 548 body: object, The request body. 549 The object takes the form of: 550 551{ 552 "apiProducts": [ # List of API products associated with the developer app. 553 "A String", 554 ], 555 "appFamily": "A String", # Developer app family. 556 "appId": "A String", # ID of the developer app. 557 "attributes": [ # List of attributes for the developer app. 558 { # Key-value pair to store extra metadata. 559 "name": "A String", # API key of the attribute. 560 "value": "A String", # Value of the attribute. 561 }, 562 ], 563 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. 564 "createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch. 565 "credentials": [ # Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. 566 { 567 "apiProducts": [ # List of API products this credential can be used for. 568 { 569 "apiproduct": "A String", # Name of the API product. 570 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 571 }, 572 ], 573 "attributes": [ # List of attributes associated with this credential. 574 { # Key-value pair to store extra metadata. 575 "name": "A String", # API key of the attribute. 576 "value": "A String", # Value of the attribute. 577 }, 578 ], 579 "consumerKey": "A String", # Consumer key. 580 "consumerSecret": "A String", # Secret key. 581 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 582 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 583 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 584 "A String", 585 ], 586 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 587 }, 588 ], 589 "developerId": "A String", # ID of the developer. 590 "keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. 591 "lastModifiedAt": "A String", # Output only. Time the developer app was modified in milliseconds since epoch. 592 "name": "A String", # Name of the developer app. 593 "scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. 594 "A String", 595 ], 596 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 597} 598 599 x__xgafv: string, V1 error format. 600 Allowed values 601 1 - v1 error format 602 2 - v2 error format 603 604Returns: 605 An object of the form: 606 607 { 608 "apiProducts": [ # List of API products associated with the developer app. 609 "A String", 610 ], 611 "appFamily": "A String", # Developer app family. 612 "appId": "A String", # ID of the developer app. 613 "attributes": [ # List of attributes for the developer app. 614 { # Key-value pair to store extra metadata. 615 "name": "A String", # API key of the attribute. 616 "value": "A String", # Value of the attribute. 617 }, 618 ], 619 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to developer apps. 620 "createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch. 621 "credentials": [ # Output only. Set of credentials for the developer app consisting of the consumer key/secret pairs associated with the API products. 622 { 623 "apiProducts": [ # List of API products this credential can be used for. 624 { 625 "apiproduct": "A String", # Name of the API product. 626 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 627 }, 628 ], 629 "attributes": [ # List of attributes associated with this credential. 630 { # Key-value pair to store extra metadata. 631 "name": "A String", # API key of the attribute. 632 "value": "A String", # Value of the attribute. 633 }, 634 ], 635 "consumerKey": "A String", # Consumer key. 636 "consumerSecret": "A String", # Secret key. 637 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 638 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 639 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 640 "A String", 641 ], 642 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 643 }, 644 ], 645 "developerId": "A String", # ID of the developer. 646 "keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set. 647 "lastModifiedAt": "A String", # Output only. Time the developer app was modified in milliseconds since epoch. 648 "name": "A String", # Name of the developer app. 649 "scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app. 650 "A String", 651 ], 652 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 653}</pre> 654</div> 655 656</body></html>