- JSON representation
- ListFindingsResult
- Resource
- GcpMetadata
- Folder
- AwsMetadata
- AwsOrganization
- AwsOrganizationalUnit
- AwsAccount
- AzureMetadata
- AzureManagementGroup
- AzureSubscription
- AzureResourceGroup
- AzureTenant
- ResourcePath
- ResourcePathNode
- ResourcePathNodeType
Response message for listing findings.
JSON representation |
---|
{
"listFindingsResults"
:
[
{
object (
|
Fields | |
---|---|
listFindingsResults[]
|
Findings matching the list request. |
nextPageToken
|
Token to retrieve the next page of results, or empty if there are no more results. |
totalSize
|
The total number of findings matching the query. |
ListFindingsResult
Result containing the Finding.
JSON representation |
---|
{ "finding" : { object ( |
Fields | |
---|---|
finding
|
Finding matching the search request. |
resource
|
Output only. Resource that is associated with this finding. |
Resource
Information related to the Google Cloud resource that is associated with this finding.
JSON representation |
---|
{ "name" : string , "displayName" : string , "type" : string , "cloudProvider" : enum ( |
name
string
The full resource name of the resource. See: https://cloud.google.com/apis/design/resource_names#full_resource_name
displayName
string
The human readable name of the resource.
type
string
The full resource type of the resource.
cloudProvider
enum (
CloudProvider
)
Indicates which cloud provider the finding is from.
service
string
The service or resource provider associated with the resource.
location
string
The region or location of the service (if applicable).
resourcePath
object (
ResourcePath
)
Provides the path to the resource within the resource hierarchy.
resourcePathString
string
A string representation of the resource path. For Google Cloud, it has the format of organizations/{organizationId}/folders/{folder_id}/folders/{folder_id}/projects/{projectId}
where there can be any number of folders. For AWS, it has the format of org/{organizationId}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{accountId}
where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscriptionId}/rg/{resource_group_name}
where there can be any number of management groups.
GcpMetadata
Google Cloud metadata associated with the resource. Only applicable if the finding's cloud provider is Google Cloud.
JSON representation |
---|
{
"project"
:
string
,
"projectDisplayName"
:
string
,
"parent"
:
string
,
"parentDisplayName"
:
string
,
"folders"
:
[
{
object (
|
Fields | |
---|---|
project
|
The full resource name of project that the resource belongs to. |
projectDisplayName
|
The project ID that the resource belongs to. |
parent
|
The full resource name of resource's parent. |
parentDisplayName
|
The human readable name of resource's parent. |
folders[]
|
Output only. Contains a Folder message for each folder in the assets ancestry. The first folder is the deepest nested folder, and the last folder is the folder directly under the Organization. |
organization
|
The name of the organization that the resource belongs to. |
Folder
Message that contains the resource name and display name of a folder resource.
JSON representation |
---|
{ "resourceFolder" : string , "resourceFolderDisplayName" : string } |
Fields | |
---|---|
resourceFolder
|
Full resource name of this folder. See: https://cloud.google.com/apis/design/resource_names#full_resource_name |
resourceFolderDisplayName
|
The user defined display name for this folder. |
AwsMetadata
AWS metadata associated with the resource, only applicable if the finding's cloud provider is Amazon Web Services.
JSON representation |
---|
{ "organization" : { object ( |
Fields | |
---|---|
organization
|
The AWS organization associated with the resource. |
organizationalUnits[]
|
A list of AWS organizational units associated with the resource, ordered from lowest level (closest to the account) to highest level. |
account
|
The AWS account associated with the resource. |
AwsOrganization
An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies.
JSON representation |
---|
{ "id" : string } |
Fields | |
---|---|
id
|
The unique identifier (ID) for the organization. The regex pattern for an organization ID string requires "o-" followed by from 10 to 32 lowercase letters or digits. |
AwsOrganizationalUnit
An Organizational Unit (OU) is a container of AWS accounts within a root of an organization. Policies that are attached to an OU apply to all accounts contained in that OU and in any child OUs.
JSON representation |
---|
{ "id" : string , "name" : string } |
Fields | |
---|---|
id
|
The unique identifier (ID) associated with this OU. The regex pattern for an organizational unit ID string requires "ou-" followed by from 4 to 32 lowercase letters or digits (the ID of the root that contains the OU). This string is followed by a second "-" dash and from 8 to 32 additional lowercase letters or digits. For example, "ou-ab12-cd34ef56". |
name
|
The friendly name of the OU. |
AwsAccount
An AWS account that is a member of an organization.
JSON representation |
---|
{ "id" : string , "name" : string } |
Fields | |
---|---|
id
|
The unique identifier (ID) of the account, containing exactly 12 digits. |
name
|
The friendly name of this account. |
AzureMetadata
Azure metadata associated with the resource, only applicable if the finding's cloud provider is Microsoft Azure.
JSON representation |
---|
{ "managementGroups" : [ { object ( |
Fields | |
---|---|
managementGroups[]
|
A list of Azure management groups associated with the resource, ordered from lowest level (closest to the subscription) to highest level. |
subscription
|
The Azure subscription associated with the resource. |
resourceGroup
|
The Azure resource group associated with the resource. |
tenant
|
The Azure Entra tenant associated with the resource. |
AzureManagementGroup
Represents an Azure management group.
JSON representation |
---|
{ "id" : string , "displayName" : string } |
Fields | |
---|---|
id
|
The UUID of the Azure management group, for example, |
displayName
|
The display name of the Azure management group. |
AzureSubscription
Represents an Azure subscription.
JSON representation |
---|
{ "id" : string , "displayName" : string } |
Fields | |
---|---|
id
|
The UUID of the Azure subscription, for example, |
displayName
|
The display name of the Azure subscription. |
AzureResourceGroup
Represents an Azure resource group.
JSON representation |
---|
{ "id" : string , "name" : string } |
Fields | |
---|---|
id
|
The ID of the Azure resource group. |
name
|
The name of the Azure resource group. This is not a UUID. |
AzureTenant
Represents a Microsoft Entra tenant.
JSON representation |
---|
{ "id" : string , "displayName" : string } |
Fields | |
---|---|
id
|
The ID of the Microsoft Entra tenant, for example, "a11aaa11-aa11-1aa1-11aa-1aaa11a". |
displayName
|
The display name of the Azure tenant. |
ResourcePath
Represents the path of resources leading up to the resource this finding is about.
JSON representation |
---|
{
"nodes"
:
[
{
object (
|
Fields | |
---|---|
nodes[]
|
The list of nodes that make the up resource path, ordered from lowest level to highest level. |
ResourcePathNode
A node within the resource path. Each node represents a resource within the resource hierarchy.
JSON representation |
---|
{
"nodeType"
:
enum (
|
Fields | |
---|---|
nodeType
|
The type of resource this node represents. |
id
|
The ID of the resource this node represents. |
displayName
|
The display name of the resource this node represents. |
ResourcePathNodeType
The type of resource the node represents.
Enums | |
---|---|
RESOURCE_PATH_NODE_TYPE_UNSPECIFIED
|
Node type is unspecified. |
GCP_ORGANIZATION
|
The node represents a Google Cloud organization. |
GCP_FOLDER
|
The node represents a Google Cloud folder. |
GCP_PROJECT
|
The node represents a Google Cloud project. |
AWS_ORGANIZATION
|
The node represents an AWS organization. |
AWS_ORGANIZATIONAL_UNIT
|
The node represents an AWS organizational unit. |
AWS_ACCOUNT
|
The node represents an AWS account. |
AZURE_MANAGEMENT_GROUP
|
The node represents an Azure management group. |
AZURE_SUBSCRIPTION
|
The node represents an Azure subscription. |
AZURE_RESOURCE_GROUP
|
The node represents an Azure resource group. |