signOut method

Future<void> signOut(
  1. String userKey, {
  2. String? $fields,
})

Signs a user out of all web and device sessions and reset their sign-in cookies.

User will have to sign in by authenticating again.

Request parameters:

userKey - Identifies the target user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.

$fields - Selector specifying which fields to include in a partial response.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<void> signOut(
  core.String userKey, {
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'admin/directory/v1/users/' +
      commons.escapeVariable('$userKey') +
      '/signOut';

  await _requester.request(
    url_,
    'POST',
    queryParams: queryParams_,
    downloadOptions: null,
  );
}