Module: Metabase::Endpoint::Session

Included in:

Metabase::Endpoint

Defined in:

lib/metabase/endpoint/session.rb

Instance Method Summary

• #login(**params) ⇒ String

  Login to Metabase.

• #logout(**params) ⇒ true

  Always returns true.

Instance Method Details

#login(**params) ⇒ String

Login to Metabase.

Parameters:

• params (Hash) —

  Request body

Returns:

• (String) —

  Session token

See Also:

• https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#post-apisession

# File 'lib/metabase/endpoint/session.rb', line 11

def login(**params)
  params = { username: @username, password: @password }.merge(params)
  response = post('/api/session', params)
  @token = response['id']
end

#logout(**params) ⇒ true

Returns Always returns true.

Parameters:

• params (Hash) —

  Request body

Returns:

• (true) —

  Always returns true

See Also:

• https://github.com/metabase/metabase/blob/master/docs/api-documentation.md#delete-apisession

# File 'lib/metabase/endpoint/session.rb', line 21

def logout(**params)
  params = { session_id: @token }.merge(params)
  delete('/api/session', params)
  @token = nil
  true
end