Class: Infrawrench::PostureNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.posture

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ PostureNamespace

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of PostureNamespace.

Parameters:



10369
10370
10371
10372
10373
 
# File 'lib/infrawrench/client.rb', line 10369

def initialize(transport)
  @transport = transport
  @dismissals = PostureDismissalsNamespace.new(@transport)
  @settings = PostureSettingsNamespace.new(@transport)
end

Instance Attribute Details

#dismissals ⇒ PostureDismissalsNamespace (readonly)

Returns client.posture.dismissals.

Returns:



10363
10364
10365
 
# File 'lib/infrawrench/client.rb', line 10363

def dismissals
  @dismissals
end

#settings ⇒ PostureSettingsNamespace (readonly)

Returns client.posture.settings.

Returns:



10365
10366
10367
 
# File 'lib/infrawrench/client.rb', line 10365

def settings
  @settings
end

Instance Method Details

#get(org_id: nil, request_options: nil) ⇒ Hash

List security posture findings on synced resources

Plugin-declared security checks evaluated over already-synced resource state: public buckets, 0.0.0.0/0 ingress rules, unencrypted disks, publicly reachable database endpoints, stale credentials, missing deletion/backup protection. No provider API calls are made and results reflect the last sync. Findings are sorted worst severity first, with per-severity counts. Findings the organization has dismissed are reported separately under dismissed and are excluded from findings, counts and the posture alerts.

Requires permission: resources:read.

GET /api/org/orgId/posture

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as PostureListResponse — see sig/infrawrench/sdk.rbs.

Raises:



10396
10397
10398
10399
10400
10401
10402
10403
 
# File 'lib/infrawrench/client.rb', line 10396

def get(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/posture",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end