listRoleSets method

Future<RoleSets?> listRoleSets({ String? query, String? orderBy, int? limit, int? offset, })

Get a list of role sets

Returns a list of role sets for the instance. Results can be paginated using the optional limit and offset query parameters. The role sets are ordered by descending creation date by default.

Parameters:

• String query: Returns role sets with ID, name, or key that match the given query. Uses exact match for role set ID and partial match for name and key.

• String orderBy: Allows to return role sets in a particular order. At the moment, you can order the returned role sets by their created_at, name, or key. In order to specify the direction, you can use the +/- symbols prepended in the property to order by. For example, if you want role sets to be returned in descending order according to their created_at property, you can use -created_at. If you don't use + or -, then + is implied. Defaults to -created_at.

• int limit: Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

• int offset: Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Implementation

Future<RoleSets?> listRoleSets({
  String? query,
  String? orderBy,
  int? limit,
  int? offset,
}) async {
  final response = await listRoleSetsWithHttpInfo(
    query: query,
    orderBy: orderBy,
    limit: limit,
    offset: offset,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty &&
      response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'RoleSets',
    ) as RoleSets;
  }
  return null;
}