login abstract method

  1. @Get()
Future<Response<AlifResponse<LoginBody>>> login({
  1. @Query() String? username,
  2. @Query() String? password,
  3. @Query('v') int version = 1,
  4. @Query() String method = 'login',
})

Requires a valid AIM user's login credentials to be presented in the first request. The API will return an authentication code, which must be passed in all future requests. This authentication code can be re-used until a logout request is made, at which point the authentication code will no longer be valid.

The concept of an 'anonymous user' can apply to the API. If no login username and password are provided, the API will return an authentication token for the anonymous user (either the same one as for the OSD, or else an 'anonymous API user' account can be created).

Implementation

@Get()
Future<Response<AlifResponse<LoginBody>>> login({
  @Query() String? username,
  @Query() String? password,

  /// The AIM API version this request is designed for
  @Query('v') int version = 1,

  /// The remote procedure to call. Do not edit this
  @Query() String method = 'login',
});