D2lvalenceElixir.Utils.Service.get_whoami

You're seeing just the function get_whoami, go back to D2lvalenceElixir.Utils.Service module for more information.
Link to this function

get_whoami(user_context, options \\ [])

View Source

Specs

get_whoami(
  %D2lvalenceElixir.Auth.D2LUserContext{
    anonymous: term(),
    app_id: term(),
    app_key: term(),
    encrypt_requests: term(),
    host: term(),
    scheme: term(),
    server_skew: term(),
    user_id: term(),
    user_key: term()
  },
  %{serializers: %{}, ver: String.t()}
) ::
  {:error, String.t()}
  | {:ok,
     %D2lvalenceElixir.Data.WhoAmIUser{
       first_name: term(),
       identifier: term(),
       last_name: term(),
       profile_identifier: term(),
       unique_name: term()
     }}

Calls the Whoami service of Brightspace.

Returns

{:error, cause} when an error is caused.

{:ok, %D2lvalenceElixir.Data.WhoAmIUser{}} the result contains the information of the logged user.

Options

version: version of the component to verify. If not specified, will get the version of the component. serializers: Map of availaber serializers. application/json recommended. body: Options to pass to the body of the request.