$confirmUserPassword_Request method

@experimental Request $confirmUserPassword_Request({ required String password, bool? oCSAPIRequest, })

Confirm the user password.

Returns a DynamiteRequest backing the confirmUserPassword operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

• password The password of the user.
• oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

• 200: Password confirmation succeeded
• 403: Password confirmation failed

See:

• confirmUserPassword for a method executing this request and parsing the response.
• $confirmUserPassword_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $confirmUserPassword_Request({
  required String password,
  bool? oCSAPIRequest,
}) {
  final _parameters = <String, Object?>{};
  final $password = _$jsonSerializers.serialize(password, specifiedType: const FullType(String));
  _parameters['password'] = $password;

  final _path = _i5.UriTemplate('/ocs/v2.php/core/apppassword/confirm{?password*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('put', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for bearer_auth or basic_auth');
  }

// coverage:ignore-end
  var $oCSAPIRequest = _$jsonSerializers.serialize(oCSAPIRequest, specifiedType: const FullType(bool));
  $oCSAPIRequest ??= true;
  _request.headers['OCS-APIRequest'] = const _i4.HeaderEncoder().convert($oCSAPIRequest);

  return _request;
}