list method

Future<ListInboundSamlSsoProfilesResponse> list({
  1. String? filter,
  2. int? pageSize,
  3. String? pageToken,
  4. String? $fields,
})

Lists InboundSamlSsoProfiles for a customer.

Request parameters:

filter - A Common Expression Language expression to filter the results. The only supported filter is filtering by customer. For example: customer=="customers/C0123abc". Omitting the filter or specifying a filter of customer=="customers/my_customer" will return the profiles for the customer that the caller (authenticated user) belongs to.

pageSize - The maximum number of InboundSamlSsoProfiles to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100. Requests with page_size greater than that will be silently interpreted as having this maximum value.

pageToken - A page token, received from a previous ListInboundSamlSsoProfiles call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListInboundSamlSsoProfiles must match the call that provided the page token.

$fields - Selector specifying which fields to include in a partial response.

Completes with a ListInboundSamlSsoProfilesResponse.

Completes with a commons.ApiRequestError if the API endpoint returned an error.

If the used http.Client completes with an error when making a REST call, this method will complete with the same error.

Implementation

async.Future<ListInboundSamlSsoProfilesResponse> list({
  core.String? filter,
  core.int? pageSize,
  core.String? pageToken,
  core.String? $fields,
}) async {
  final queryParams_ = <core.String, core.List<core.String>>{
    if (filter != null) 'filter': [filter],
    if (pageSize != null) 'pageSize': ['${pageSize}'],
    if (pageToken != null) 'pageToken': [pageToken],
    if ($fields != null) 'fields': [$fields],
  };

  const url_ = 'v1/inboundSamlSsoProfiles';

  final response_ = await _requester.request(
    url_,
    'GET',
    queryParams: queryParams_,
  );
  return ListInboundSamlSsoProfilesResponse.fromJson(
      response_ as core.Map<core.String, core.dynamic>);
}