$getGroupUsersDetails_Request method
- @experimental
Get a list of users details in the specified group.
Returns a DynamiteRequest
backing the getGroupUsersDetails operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Parameters:
groupId
ID of the group.search
Text to search for. Defaults to""
.limit
Limit the amount of groups returned.offset
Offset for searching for groups. Defaults to0
.oCSAPIRequest
Required to be true for the API request to pass. Defaults totrue
.
Status codes:
- 200: Group users details returned
See:
- getGroupUsersDetails for a method executing this request and parsing the response.
- $getGroupUsersDetails_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $getGroupUsersDetails_Request({
required String groupId,
String? search,
int? limit,
int? offset,
bool? oCSAPIRequest,
}) {
final _parameters = <String, Object?>{};
final __groupId = _$jsonSerializers.serialize(groupId, specifiedType: const FullType(String));
_i5.checkString(
__groupId,
'groupId',
pattern: RegExp(r'^.+$'),
);
_parameters['groupId'] = __groupId;
var __search = _$jsonSerializers.serialize(search, specifiedType: const FullType(String));
__search ??= '';
_parameters['search'] = __search;
final __limit = _$jsonSerializers.serialize(limit, specifiedType: const FullType(int));
_parameters['limit'] = __limit;
var __offset = _$jsonSerializers.serialize(offset, specifiedType: const FullType(int));
__offset ??= 0;
_parameters['offset'] = __offset;
final _path = _i6.UriTemplate('/ocs/v2.php/cloud/groups/{groupId}/users/details{?search*,limit*,offset*}')
.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;
}