Package org.jenkinsci.plugins.octoperf.account

Interface AccountApi

public interface AccountApi
This REST Api allows to register, login and logout a user on the REST server.
Author:
jerome

  • Method Summary

    Modifier and Type
    Method
    Description
    retrofit2.Call<SecurityToken>
    login(String username, String password)
    Logs in the user and sends back SecurityToken if login is successful.

  • Method Details

    • login

      @POST("/public/users/login") @FormUrlEncoded retrofit2.Call<SecurityToken> login(@Field("username") String username, @Field("password") String password)
      Logs in the user and sends back SecurityToken if login is successful.
      Parameters:
      username - user username
      password - user password
      Returns:
      credentials if success, else Optional.absent()