testIamPermissions method

Future<GoogleIamV1TestIamPermissionsResponse> testIamPermissions(
  1. GoogleIamV1TestIamPermissionsRequest request,
  2. String resource, {
  3. String? $fields,
})

Returns permissions that a caller has on the specified resource.

If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

request - The metadata request object.

Request parameters:

resource - REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. Value must have pattern ^projects/\[^/\]+/locations/\[^/\]+/dataScans/\[^/\]+$.

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

Completes with a GoogleIamV1TestIamPermissionsResponse.

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<GoogleIamV1TestIamPermissionsResponse> testIamPermissions(
  GoogleIamV1TestIamPermissionsRequest request,
  core.String resource, {
  core.String? $fields,
}) async {
  final body_ = convert.json.encode(request);
  final queryParams_ = <core.String, core.List<core.String>>{
    if ($fields != null) 'fields': [$fields],
  };

  final url_ =
      'v1/' + core.Uri.encodeFull('$resource') + ':testIamPermissions';

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