usersBan method

Future<List<User>?> usersBan(
  1. UsersBanRequest usersBanRequest
)

Ban multiple users

Marks multiple users as banned, which means that all their sessions are revoked and they are not allowed to sign in again.

Parameters:

Implementation

Future<List<User>?> usersBan(
  UsersBanRequest usersBanRequest,
) async {
  final response = await usersBanWithHttpInfo(
    usersBanRequest,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty &&
      response.statusCode != HttpStatus.noContent) {
    final responseBody = await _decodeBodyBytes(response);
    return (await apiClient.deserializeAsync(responseBody, 'List<User>')
            as List)
        .cast<User>()
        .toList(growable: false);
  }
  return null;
}