Apigee API . organizations . apps

Instance Methods

close()

Close httplib2 connections.

get(name, x__xgafv=None)

Gets the app profile for the specified app ID.

list(parent, apiProduct=None, startKey=None, includeCred=None, expand=None, keyStatus=None, apptype=None, ids=None, rows=None, status=None, x__xgafv=None)

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).

Method Details

close()
Close httplib2 connections.
get(name, x__xgafv=None)
Gets the app profile for the specified app ID.

Args:
  name: string, Required. App ID in the following format: `organizations/{org}/apps/{app}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "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
    "scopes": [ # Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.
      "A String",
    ],
    "developerId": "A String", # ID of the developer.
    "lastModifiedAt": "A String", # Output only. Last modified time as milliseconds since epoch.
    "status": "A String", # Status of the credential.
    "credentials": [ # Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.
      {
        "attributes": [ # List of attributes associated with this credential.
          { # Key-value pair to store extra metadata.
            "value": "A String", # Value of the attribute.
            "name": "A String", # API key of the attribute.
          },
        ],
        "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
          "A String",
        ],
        "apiProducts": [ # List of API products this credential can be used for.
          {
            "status": "A String", # Status of the API product.
            "apiproduct": "A String", # Name of the API product.
          },
        ],
        "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
        "status": "A String", # Status of the credential.
        "consumerSecret": "A String", # Secret key.
        "consumerKey": "A String", # Consumer key.
        "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
      },
    ],
    "apiProducts": [ # List of API products associated with the app.
      {
        "status": "A String", # Status of the API product.
        "apiproduct": "A String", # Name of the API product.
      },
    ],
    "attributes": [ # List of attributes.
      { # Key-value pair to store extra metadata.
        "value": "A String", # Value of the attribute.
        "name": "A String", # API key of the attribute.
      },
    ],
    "companyName": "A String", # Name of the company that owns the app.
    "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.
    "appId": "A String", # ID of the app.
    "name": "A String", # Name of the app.
    "createdAt": "A String", # Output only. Unix time when the app was created.
  }
list(parent, apiProduct=None, startKey=None, includeCred=None, expand=None, keyStatus=None, apptype=None, ids=None, rows=None, status=None, x__xgafv=None)
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).

Args:
  parent: string, Required. Resource path of the parent in the following format: `organizations/{org}` (required)
  apiProduct: string, API product.
  startKey: string, Returns the list of apps starting from the specified app ID.
  includeCred: boolean, Optional. Flag that specifies whether to include credentials in the response.
  expand: boolean, Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to `false`.
  keyStatus: string, Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`.
  apptype: string, Optional. Filter by the type of the app. Valid values are `company` or `developer`. Defaults to `developer`.
  ids: string, Optional. Comma-separated list of app IDs on which to filter.
  rows: string, Optional. Maximum number of app IDs to return. Defaults to 10000.
  status: string, Optional. Filter by the status of the app. Valid values are `approved` or `revoked`. Defaults to `approved`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
    "app": [
      {
        "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
        "scopes": [ # Scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app.
          "A String",
        ],
        "developerId": "A String", # ID of the developer.
        "lastModifiedAt": "A String", # Output only. Last modified time as milliseconds since epoch.
        "status": "A String", # Status of the credential.
        "credentials": [ # Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.
          {
            "attributes": [ # List of attributes associated with this credential.
              { # Key-value pair to store extra metadata.
                "value": "A String", # Value of the attribute.
                "name": "A String", # API key of the attribute.
              },
            ],
            "scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
              "A String",
            ],
            "apiProducts": [ # List of API products this credential can be used for.
              {
                "status": "A String", # Status of the API product.
                "apiproduct": "A String", # Name of the API product.
              },
            ],
            "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
            "status": "A String", # Status of the credential.
            "consumerSecret": "A String", # Secret key.
            "consumerKey": "A String", # Consumer key.
            "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
          },
        ],
        "apiProducts": [ # List of API products associated with the app.
          {
            "status": "A String", # Status of the API product.
            "apiproduct": "A String", # Name of the API product.
          },
        ],
        "attributes": [ # List of attributes.
          { # Key-value pair to store extra metadata.
            "value": "A String", # Value of the attribute.
            "name": "A String", # API key of the attribute.
          },
        ],
        "companyName": "A String", # Name of the company that owns the app.
        "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.
        "appId": "A String", # ID of the app.
        "name": "A String", # Name of the app.
        "createdAt": "A String", # Output only. Unix time when the app was created.
      },
    ],
  }