Package com.io7m.idstore.user_client.api

# Interface IdUClientType

All Superinterfaces:
  `AutoCloseable`, `Closeable`, `IdUClientUsersType`

All Known Implementing Classes:
  `IdUClient`

public interface IdUClientType extends Closeable, IdUClientUsersType
The type of clients.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `IdUser`
  `login(String user, String password, URI base, Map<String,String> metadata)`
  Log in.

  ### Methods inherited from interface java.io.Closeable

  `close`

  ### Methods inherited from interface com.io7m.idstore.user_client.api.IdUClientUsersType

  `userEmailAddBegin, userEmailAddDeny, userEmailAddPermit, userEmailRemoveBegin, userEmailRemoveDeny, userEmailRemovePermit, userPasswordUpdate, userRealNameUpdate, userSelf`

- ## Method Details

  - ### login

    IdUser login(String user, String password, URI base, Map<String,String> metadata) throws IdUClientException, InterruptedException
    Log in.
    Parameters:
      `user` - The admin username
      `password` - The password
      `base` - The base URI
      `metadata` - Optional metadata to be included with the request
    Returns:
      The logged-in user
    Throws:
      `IdUClientException` - On errors
      `InterruptedException` - On interruption