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.apps.html">apps</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets the app profile for the specified app ID.</p> 83<p class="toc_element"> 84 <code><a href="#list">list(parent, apiProduct=None, apptype=None, expand=None, ids=None, includeCred=None, keyStatus=None, rows=None, startKey=None, status=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).</p> 86<h3>Method Details</h3> 87<div class="method"> 88 <code class="details" id="close">close()</code> 89 <pre>Close httplib2 connections.</pre> 90</div> 91 92<div class="method"> 93 <code class="details" id="get">get(name, x__xgafv=None)</code> 94 <pre>Gets the app profile for the specified app ID. 95 96Args: 97 name: string, Required. App ID in the following format: `organizations/{org}/apps/{app}` (required) 98 x__xgafv: string, V1 error format. 99 Allowed values 100 1 - v1 error format 101 2 - v2 error format 102 103Returns: 104 An object of the form: 105 106 { 107 "apiProducts": [ # List of API products associated with the app. 108 { 109 "apiproduct": "A String", # Name of the API product. 110 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 111 }, 112 ], 113 "appId": "A String", # ID of the app. 114 "attributes": [ # List of attributes. 115 { # Key-value pair to store extra metadata. 116 "name": "A String", # API key of the attribute. 117 "value": "A String", # Value of the attribute. 118 }, 119 ], 120 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. 121 "companyName": "A String", # Name of the company that owns the app. 122 "createdAt": "A String", # Output only. Unix time when the app was created. 123 "credentials": [ # Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products. 124 { 125 "apiProducts": [ # List of API products this credential can be used for. 126 { 127 "apiproduct": "A String", # Name of the API product. 128 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 129 }, 130 ], 131 "attributes": [ # List of attributes associated with this credential. 132 { # Key-value pair to store extra metadata. 133 "name": "A String", # API key of the attribute. 134 "value": "A String", # Value of the attribute. 135 }, 136 ], 137 "consumerKey": "A String", # Consumer key. 138 "consumerSecret": "A String", # Secret key. 139 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 140 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 141 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 142 "A String", 143 ], 144 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 145 }, 146 ], 147 "developerId": "A String", # ID of the developer. 148 "keyExpiresIn": "A String", # Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn 149 "lastModifiedAt": "A String", # Output only. Last modified time as milliseconds since epoch. 150 "name": "A String", # Name of the app. 151 "scopes": [ # Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app. 152 "A String", 153 ], 154 "status": "A String", # Status of the credential. 155}</pre> 156</div> 157 158<div class="method"> 159 <code class="details" id="list">list(parent, apiProduct=None, apptype=None, expand=None, ids=None, includeCred=None, keyStatus=None, rows=None, startKey=None, status=None, x__xgafv=None)</code> 160 <pre>Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company). 161 162Args: 163 parent: string, Required. Resource path of the parent in the following format: `organizations/{org}` (required) 164 apiProduct: string, API product. 165 apptype: string, Optional. Filter by the type of the app. Valid values are `company` or `developer`. Defaults to `developer`. 166 expand: boolean, Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to `false`. 167 ids: string, Optional. Comma-separated list of app IDs on which to filter. 168 includeCred: boolean, Optional. Flag that specifies whether to include credentials in the response. 169 keyStatus: string, Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`. 170 rows: string, Optional. Maximum number of app IDs to return. Defaults to 10000. 171 startKey: string, Returns the list of apps starting from the specified app ID. 172 status: string, Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`. 173 x__xgafv: string, V1 error format. 174 Allowed values 175 1 - v1 error format 176 2 - v2 error format 177 178Returns: 179 An object of the form: 180 181 { 182 "app": [ 183 { 184 "apiProducts": [ # List of API products associated with the app. 185 { 186 "apiproduct": "A String", # Name of the API product. 187 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 188 }, 189 ], 190 "appId": "A String", # ID of the app. 191 "attributes": [ # List of attributes. 192 { # Key-value pair to store extra metadata. 193 "name": "A String", # API key of the attribute. 194 "value": "A String", # Value of the attribute. 195 }, 196 ], 197 "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. 198 "companyName": "A String", # Name of the company that owns the app. 199 "createdAt": "A String", # Output only. Unix time when the app was created. 200 "credentials": [ # Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products. 201 { 202 "apiProducts": [ # List of API products this credential can be used for. 203 { 204 "apiproduct": "A String", # Name of the API product. 205 "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`. 206 }, 207 ], 208 "attributes": [ # List of attributes associated with this credential. 209 { # Key-value pair to store extra metadata. 210 "name": "A String", # API key of the attribute. 211 "value": "A String", # Value of the attribute. 212 }, 213 ], 214 "consumerKey": "A String", # Consumer key. 215 "consumerSecret": "A String", # Secret key. 216 "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch. 217 "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch. 218 "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app. 219 "A String", 220 ], 221 "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`. 222 }, 223 ], 224 "developerId": "A String", # ID of the developer. 225 "keyExpiresIn": "A String", # Duration, in milliseconds, of the consumer key that will be generated for the app. The default value, -1, indicates an infinite validity period. Once set, the expiration can't be updated. json key: keyExpiresIn 226 "lastModifiedAt": "A String", # Output only. Last modified time as milliseconds since epoch. 227 "name": "A String", # Name of the app. 228 "scopes": [ # Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app. 229 "A String", 230 ], 231 "status": "A String", # Status of the credential. 232 }, 233 ], 234}</pre> 235</div> 236 237</body></html>