google_api_o_auth2 v0.12.0 GoogleApi.OAuth2.V2.Api.Userinfo View Source

API calls for all endpoints tagged Userinfo.

Link to this section Summary

Functions

Parameters

  • connection (type: GoogleApi.OAuth2.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

Parameters

  • connection (type: GoogleApi.OAuth2.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

Link to this section Functions

Link to this function

oauth2_userinfo_get(connection, optional_params \\ [], opts \\ [])

View Source
oauth2_userinfo_get(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.OAuth2.V2.Model.Userinfo.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Parameters

  • connection (type: GoogleApi.OAuth2.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OAuth2.V2.Model.Userinfo{}} on success
  • {:error, info} on failure
Link to this function

oauth2_userinfo_v2_me_get(connection, optional_params \\ [], opts \\ [])

View Source
oauth2_userinfo_v2_me_get(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.OAuth2.V2.Model.Userinfo.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, any()}

Parameters

  • connection (type: GoogleApi.OAuth2.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters

    • :alt (type: String.t) - Data format for the response.
    • :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) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • :userIp (type: String.t) - Deprecated. Please use quotaUser instead.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.OAuth2.V2.Model.Userinfo{}} on success
  • {:error, info} on failure