createGuest method

Future<User> createGuest(
  1. DirectoryUsersCreateGuestRequest request, {
  2. String? $fields,
})

Create a guest user with access to a subset of Workspace capabilities.

This feature is currently in Alpha. Please reach out to support if you are interested in trying this feature.

request - The metadata request object.

Request parameters:

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

Completes with a User.

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<User> createGuest(
  DirectoryUsersCreateGuestRequest request, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    'fields': ?$fields == null ? null : [$fields],
  };

  const url_ = 'admin/directory/v1/users:createGuest';

  final response_ = await _requester.request(
    url_,
    'POST',
    body: body_,
    queryParams: queryParams_,
  );
  return User.fromJson(response_ as core.Map<core.String, core.dynamic>);
}