0%

Augmentt API

Get Posture Report

Represents the Posture Report from Secure->Security Posture in the Augmentt Portal for a specific tenant, including Posture Recommendations, Configuration Status, Security Checks, and their respective statuses, License Requirements, and Compliance details.

Properties

Property name

Description

postureRecommendations

Contains the Count and Total Number of posture recommendations for the tenant.

configurationStatus

Provides the status of posture configurations in the tenant.

securityChecks

Array collection of security checks and their details in the tenant.

postureRecommendations values

Member

Description

count

Count of active Posture Recommendations.

total

Total count of Posture Recommendations.

configurationStatus values

Member

Description

configured

Count of Postures with Configured status.

partiallyConfigured

Count of Postures with Partially Configured status.

notConfigured

Count of Postures with Not Configured status.

notMeasured

Count of Postures with Not Measured status.

resolved

Count of Postures with Resolved status.

securityChecks values

Member

Description

allMonitored

Array collection of monitored Security Postures in the tenant.*

configured

Array collection of Configured Security Postures in the tenant.*

partiallyConfigured

Array collection of Partially Configured Security Postures in the tenant.*

notConfigured

Array collection of Not Configured Security Postures in the tenant.*

notMeasured

Array collection of Not Measured Security Postures in the tenant.*

ignored

Array collection of Ignored Security Postures in the tenant.*

resolved

Array collection of Resolved Security Postures in the tenant.*

*Each array from the securityChecks values property includes details such as security check, check ID, source, category, status, license, MS Secure Score, configuration issues, and compliance details. See the reference table below.

*securityChecks arrays values

Member

Description

securityCheck

The name of the security check.

checkId

Unique identifier of the security check.

source

The source of the security check.

category

The category of the security check.

status

The status of the security check.

license

The required Microsoft license to monitor and/or manage the security check.

msSecureScore

An object containing the Microsoft Secure Score details such as:

  • scoreControlName: Microsoft's score control name.

  • scoreControlState: Microsoft's score control state.

  • scoreControlComment: Microsoft's score control comment.

  • currentScore: Microsoft's current score per control.

  • maxScore: Microsoft's Maximum control score.

configurationIssues

An object containing details of any configuration issues, such as:

  • missingScopesInIntegration: Array with missing scopes in the integration user's permissions.

  • missingGDAPInIntegration: Array with missing roles in the GDAP integration for this tenant.

compliance

An object with the points reference for the Augmentt Secure Score, including the sub-properties:

  • compliant: Points for compliant settings.

  • nonCompliant: Points for non-compliant settings (to be deducted from total).

  • total: Total possible compliance points count.

HTTP request

GET - /v1/reports/posture/:customerId

Request headers

Name

Description

AccessKeyId

Access Key ID provided by our team

AccessKeySecret

Access Key Secret provided by our team

Request body

Don't supply a request body for this method

Response

A successful return is a 200 OK response code and a collection of posture recommendations and configuration status for the specific customer.

Example

Request

GET https://api.augmentt.com/v1/reports/posture/123

Response
0%