Apigee API . organizations . apps

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:

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

list(parent, apiProduct=None, apptype=None, expand=None, ids=None, includeCred=None, keyStatus=None, rows=None, startKey=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.
  apptype: string, Optional. Filter by the type of the app. Valid values are `company` or `developer`. Defaults to `developer`.
  expand: boolean, Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to `false`.
  ids: string, Optional. Comma-separated list of app IDs on which to filter.
  includeCred: boolean, Optional. Flag that specifies whether to include credentials in the response.
  keyStatus: string, Optional. Key status of the app. Valid values include `approved` or `revoked`. Defaults to `approved`.
  rows: string, Optional. Maximum number of app IDs to return. Defaults to 10000.
  startKey: string, Returns the list of apps starting from the specified app ID.
  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": [
    {
      "apiProducts": [ # List of API products associated with the app.
        {
          "apiproduct": "A String", # Name of the API product.
          "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`.
        },
      ],
      "appId": "A String", # ID of the app.
      "attributes": [ # List of attributes.
        { # Key-value pair to store extra metadata.
          "name": "A String", # API key of the attribute.
          "value": "A String", # Value of the attribute.
        },
      ],
      "callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to apps.
      "companyName": "A String", # Name of the company that owns the app.
      "createdAt": "A String", # Output only. Unix time when the app was created.
      "credentials": [ # Output only. Set of credentials for the app. Credentials are API key/secret pairs associated with API products.
        {
          "apiProducts": [ # List of API products this credential can be used for.
            {
              "apiproduct": "A String", # Name of the API product.
              "status": "A String", # Status of the API product. Valid values are `approved` or `revoked`.
            },
          ],
          "attributes": [ # List of attributes associated with this credential.
            { # Key-value pair to store extra metadata.
              "name": "A String", # API key of the attribute.
              "value": "A String", # Value of the attribute.
            },
          ],
          "consumerKey": "A String", # Consumer key.
          "consumerSecret": "A String", # Secret key.
          "expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
          "issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
          "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",
          ],
          "status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
        },
      ],
      "developerId": "A String", # ID of the developer.
      "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
      "lastModifiedAt": "A String", # Output only. Last modified time as milliseconds since epoch.
      "name": "A String", # Name of the app.
      "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",
      ],
      "status": "A String", # Status of the credential.
    },
  ],
}