revokeSession method

Future<Session?> revokeSession(
  1. String sessionId
)

Revoke a session

Sets the status of a session as "revoked", which is an unauthenticated state. In multi-session mode, a revoked session will still be returned along with its client object, however the user will need to sign in again.

Parameters:

  • String sessionId (required): The ID of the session

Implementation

Future<Session?> revokeSession(
  String sessionId,
) async {
  final response = await revokeSessionWithHttpInfo(
    sessionId,
  );
  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) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'Session',
    ) as Session;
  }
  return null;
}