listOrganizationRolesWithHttpInfo method

Future<Response> listOrganizationRolesWithHttpInfo({ String? query, String? orderBy, int? limit, int? offset, })

Get a list of organization roles

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

Note: This method returns the HTTP Response.

Parameters:

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

• String orderBy: Allows to return organization roles in a particular order. At the moment, you can order the returned organization roles 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 organization roles 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<http.Response> listOrganizationRolesWithHttpInfo({
  String? query,
  String? orderBy,
  int? limit,
  int? offset,
}) async {
  // ignore: prefer_const_declarations
  final path = r'/organization_roles';

  // ignore: prefer_final_locals
  Object? postBody;

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

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

  const contentTypes = <String>[];

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