GoogleApi.Apigee.V1.Api.Organizations.apigee_organizations_developers_list

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

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

View Source

Specs

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

Lists all developers in an organization by email address. By default, the response does not include company developers. Set the includeCompany query parameter to true to include company developers. Note: A maximum of 1000 developers are returned in the response. You paginate the list of developers returned using the startKey and count query parameters.

Parameters

  • connection (type: GoogleApi.Apigee.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Name of the Apigee organization. Use the following structure in your request: 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").
    • :app (type: String.t) - Optional. List only Developers that are associated with the app. Note that start_key, count are not applicable for this filter criteria.
    • :count (type: String.t) - Optional. Number of developers to return in the API call. Use with the startKey parameter to provide more targeted filtering. The limit is 1000.
    • :expand (type: boolean()) - 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.
    • :ids (type: String.t) - Optional. List of IDs to include, separated by commas.
    • :includeCompany (type: boolean()) - Flag that specifies whether to include company details in the response.
    • :startKey (type: String.t) - Note: Must be used in conjunction with the count parameter. Email address of the developer from which to start displaying the list of developers. For example, if the an unfiltered list returns: westley@example.com fezzik@example.com buttercup@example.com and your startKey is fezzik@example.com, the list returned will be fezzik@example.com buttercup@example.com
  • opts (type: keyword()) - Call options

Returns

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