GoogleApi.Apigee.V1.Api.Organizations.apigee_organizations_apps_list

You're seeing just the function apigee_organizations_apps_list, go back to GoogleApi.Apigee.V1.Api.Organizations module for more information.
Link to this function

apigee_organizations_apps_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

apigee_organizations_apps_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Resource path of the parent in the following format: organizations/{org}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :apiProduct (type: String.t) - API product.
    • :apptype (type: String.t) - Optional. Filter by the type of the app. Valid values are company or developer. Defaults to developer.
    • :expand (type: boolean()) - Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to false.
    • :ids (type: String.t) - Optional. Comma-separated list of app IDs on which to filter.
    • :includeCred (type: boolean()) - Optional. Flag that specifies whether to include credentials in the response.
    • :keyStatus (type: String.t) - Optional. Key status of the app. Valid values include approved or revoked. Defaults to approved.
    • :rows (type: String.t) - Optional. Maximum number of app IDs to return. Defaults to 10000.
    • :startKey (type: String.t) - Returns the list of apps starting from the specified app ID.
    • :status (type: String.t) - Optional. Filter by the status of the app. Valid values are approved or revoked. Defaults to approved.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ListAppsResponse{}} on success
  • {:error, info} on failure