listOAuthApplicationsWithHttpInfo method

Future<Response> listOAuthApplicationsWithHttpInfo({ int? limit, int? offset, String? orderBy, String? nameQuery, })

Get a list of OAuth applications for an instance

This request returns the list of OAuth applications for an instance. Results can be paginated using the optional limit and offset query parameters. The OAuth applications are ordered by descending creation date. Most recent OAuth applications will be returned first.

Note: This method returns the HTTP Response.

Parameters:

• 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.

• String orderBy: Allows to return OAuth applications in a particular order. At the moment, you can order the returned OAuth applications by their created_at and name. In order to specify the direction, you can use the +/- symbols prepended in the property to order by. For example, if you want OAuth applications 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. We only support one order_by parameter, and if multiple order_by parameters are provided, we will only keep the first one. For example, if you pass order_by=name&order_by=created_at, we will consider only the first order_by parameter, which is name. The created_at parameter will be ignored in this case.

• String nameQuery: Returns OAuth applications with names that match the given query, via case-insensitive partial match.

Implementation

Future<http.Response> listOAuthApplicationsWithHttpInfo({
  int? limit,
  int? offset,
  String? orderBy,
  String? nameQuery,
}) async {
  // ignore: prefer_const_declarations
  final path = r'/oauth_applications';

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  if (limit != null) {
    queryParams.addAll(_queryParams('', 'limit', limit));
  }
  if (offset != null) {
    queryParams.addAll(_queryParams('', 'offset', offset));
  }
  if (orderBy != null) {
    queryParams.addAll(_queryParams('', 'order_by', orderBy));
  }
  if (nameQuery != null) {
    queryParams.addAll(_queryParams('', 'name_query', nameQuery));
  }

  const contentTypes = <String>[];

  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}