$$show_Request method

  1. @experimental
Request $$show_Request({
  1. required String configID,
  2. ConfigapiShowShowPassword? showPassword,
  3. bool? oCSAPIRequest,
})

Get a configuration.

Output can look like this: . This endpoint requires admin access.

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

Parameters:

  • configID ID of the config.
  • showPassword Whether to show the password. Defaults to 0.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Config returned
  • 404: Config not found

See:

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

Implementation

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

  var __showPassword =
      _$jsonSerializers.serialize(showPassword, specifiedType: const FullType(ConfigapiShowShowPassword));
  __showPassword ??= 0;
  _parameters['showPassword'] = __showPassword;

  final _path =
      _i6.UriTemplate('/ocs/v2.php/apps/user_ldap/api/v1/config/{configID}{?showPassword*}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i4.IterableExtension(_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 _i5.HeaderEncoder().convert(__oCSAPIRequest);

  return _request;
}