2026-09-09
▼ ▲ auditmanager.folders.locations.enrollResource
Flat Path : v1/folders/{foldersId}/locations/{locationsId}:enrollResource
Scopes :
Parameter Order : scope
Path : v1/{+scope}:enrollResource
HTTP Method : POST
Parameters :
scope
Type : string
Location : path
Required : Yes
Description : Required. Organization, folder, or project to enroll in Audit Manager, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Pattern : ^folders/[^/]+/locations/[^/]+$
Description : Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.
▼ ▲ auditmanager.folders.locations.operationIds.get
HTTP Method : GET
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/operationIds/{operationIdsId}
Parameters :
name
Type : string
Pattern : ^folders/[^/]+/locations/[^/]+/operationIds/[^/]+$
Required : Yes
Description : The name of the operation resource.
Location : path
Description : Gets details about the long-running operation to generate audit reports.
Parameter Order : name
Path : v1/{+name}
Scopes :
▼ ▲ auditmanager.folders.locations.auditReports.get
HTTP Method : GET
Parameters :
name
Required : Yes
Type : string
Pattern : ^folders/[^/]+/locations/[^/]+/auditReports/[^/]+$
Location : path
Description : Required. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
Scopes :
Path : v1/{+name}
Parameter Order : name
Description : Gets the full metadata and findings for an audit report.
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/auditReports/{auditReportsId}
▼ ▲ auditmanager.folders.locations.auditReports.generate
Parameters :
scope
Description : Required. Organization, folder, or project that the audit applies to, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Pattern : ^folders/[^/]+/locations/[^/]+$
Required : Yes
Type : string
Location : path
Path : v1/{+scope}/auditReports:generate
HTTP Method : POST
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/auditReports:generate
Scopes :
Description : Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.
Parameter Order : scope
▼ ▲ auditmanager.folders.locations.auditReports.list
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/auditReports
Parameters :
pageToken
Location : query
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
Type : string
pageSize
Type : integer
Format : int32
Location : query
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
parent
Location : path
Type : string
Pattern : ^folders/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. Parent organization, folder, or project to list reports for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
HTTP Method : GET
Scopes :
Description : Lists the audit reports for the organization, folder, or project that you specify as the parent scope.
Parameter Order : parent
Path : v1/{+parent}/auditReports
▼ ▲ auditmanager.folders.locations.standards.controls.list
Path : v1/{+parent}/controls
Description : Lists the controls that you must implement to become compliant to a regulatory standard.
Parameter Order : parent
Parameters :
parent
Type : string
Pattern : ^folders/[^/]+/locations/[^/]+/standards/[^/]+$
Required : Yes
Description : Required. Standard to list controls for, in one of the following formats: * `projects/{project}/locations/{location}/standards/{standard}` * `folders/{folder}/locations/{location}/standards/{standard}` * `organizations/{organization}/locations/{location}/standards/{standard}`
Location : path
pageSize
Location : query
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Type : integer
Format : int32
pageToken
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
Type : string
Location : query
Scopes :
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/standards/{standardsId}/controls
HTTP Method : GET
▼ ▲ auditmanager.folders.locations.operationDetails.get
HTTP Method : GET
Path : v1/{+name}
Parameters :
name
Location : path
Type : string
Required : Yes
Pattern : ^folders/[^/]+/locations/[^/]+/operationDetails/[^/]+$
Description : The name of the operation resource.
Scopes :
Parameter Order : name
Description : Gets details about the long-running operation to generate audit reports.
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/operationDetails/{operationDetailsId}
▼ ▲ auditmanager.folders.locations.auditScopeReports.generate
Description : Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.
Parameter Order : scope
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/auditScopeReports:generate
Path : v1/{+scope}/auditScopeReports:generate
HTTP Method : POST
Scopes :
Parameters :
scope
Description : Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Location : path
Type : string
Pattern : ^folders/[^/]+/locations/[^/]+$
Required : Yes
▼ ▲ auditmanager.folders.locations.resourceEnrollmentStatuses.get
Path : v1/{+name}
Parameter Order : name
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/resourceEnrollmentStatuses/{resourceEnrollmentStatusesId}
Parameters :
name
Pattern : ^folders/[^/]+/locations/[^/]+/resourceEnrollmentStatuses/[^/]+$
Required : Yes
Description : Required. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
Type : string
Location : path
Description : Gets a resource and its enrollment status.
Scopes :
HTTP Method : GET
▼ ▲ auditmanager.folders.locations.resourceEnrollmentStatuses.list
Scopes :
Flat Path : v1/folders/{foldersId}/locations/{locationsId}/resourceEnrollmentStatuses
Parameter Order : parent
HTTP Method : GET
Description : Lists all the folders and projects in an organization or folder, along with their enrollments.
Parameters :
parent
Location : path
Pattern : ^folders/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. Parent organization or folder to list enrollment statuses for, in one of the following formats: * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Type : string
pageToken
Location : query
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
Type : string
pageSize
Location : query
Type : integer
Format : int32
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Path : v1/{+parent}/resourceEnrollmentStatuses
▼ ▲ auditmanager.projects.locations.auditReports.get
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/auditReports/[^/]+$
Description : Required. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
Required : Yes
Type : string
HTTP Method : GET
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/auditReports/{auditReportsId}
Path : v1/{+name}
Scopes :
Description : Gets the full metadata and findings for an audit report.
▼ ▲ auditmanager.projects.locations.auditReports.list
Description : Lists the audit reports for the organization, folder, or project that you specify as the parent scope.
Parameters :
pageToken
Location : query
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
Type : string
parent
Required : Yes
Location : path
Description : Required. Parent organization, folder, or project to list reports for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Pattern : ^projects/[^/]+/locations/[^/]+$
Type : string
pageSize
Type : integer
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Location : query
Format : int32
HTTP Method : GET
Path : v1/{+parent}/auditReports
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/auditReports
Scopes :
Parameter Order : parent
▼ ▲ auditmanager.projects.locations.auditReports.generate
HTTP Method : POST
Path : v1/{+scope}/auditReports:generate
Parameters :
scope
Pattern : ^projects/[^/]+/locations/[^/]+$
Required : Yes
Description : Required. Organization, folder, or project that the audit applies to, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Location : path
Type : string
Description : Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/auditReports:generate
Scopes :
Parameter Order : scope
▼ ▲ auditmanager.projects.locations.operations.list
Parameter Order : name
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
Path : v1/{+name}/operations
HTTP Method : GET
Parameters :
returnPartialSuccess
Location : query
Type : boolean
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
pageToken
Location : query
Description : The standard list page token.
Type : string
name
Required : Yes
Type : string
Location : path
Description : The name of the operation's parent resource.
Pattern : ^projects/[^/]+/locations/[^/]+$
filter
Type : string
Location : query
Description : The standard list filter.
pageSize
Format : int32
Description : The standard list page size.
Location : query
Type : integer
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations
Scopes :
▼ ▲ auditmanager.projects.locations.operations.cancel
Parameter Order : name
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
HTTP Method : POST
Path : v1/{+name}:cancel
Scopes :
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Type : string
Description : The name of the operation resource to be cancelled.
▼ ▲ auditmanager.projects.locations.operations.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes :
Path : v1/{+name}
HTTP Method : GET
Parameters :
name
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource.
Type : string
Required : Yes
Parameter Order : name
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
▼ ▲ auditmanager.projects.locations.operations.delete
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Scopes :
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Path : v1/{+name}
Parameter Order : name
Parameters :
name
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type : string
Description : The name of the operation resource to be deleted.
Location : path
HTTP Method : DELETE
▼ ▲ auditmanager.projects.locations.resourceEnrollmentStatuses.get
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/resourceEnrollmentStatuses/{resourceEnrollmentStatusesId}
HTTP Method : GET
Description : Gets a resource and its enrollment status.
Parameters :
name
Type : string
Location : path
Description : Required. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/resourceEnrollmentStatuses/[^/]+$
Scopes :
Path : v1/{+name}
Parameter Order : name
▼ ▲ auditmanager.projects.locations.auditScopeReports.generate
HTTP Method : POST
Parameters :
scope
Required : Yes
Description : Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+$
Parameter Order : scope
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/auditScopeReports:generate
Path : v1/{+scope}/auditScopeReports:generate
Description : Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.
Scopes :
▼ ▲ auditmanager.projects.locations.operationDetails.get
Description : Gets details about the long-running operation to generate audit reports.
Path : v1/{+name}
Parameters :
name
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operationDetails/[^/]+$
Description : The name of the operation resource.
Location : path
HTTP Method : GET
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operationDetails/{operationDetailsId}
Scopes :
▼ ▲ auditmanager.projects.locations.operationIds.get
Description : Gets details about the long-running operation to generate audit reports.
HTTP Method : GET
Parameter Order : name
Parameters :
name
Location : path
Description : The name of the operation resource.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+/operationIds/[^/]+$
Scopes :
Path : v1/{+name}
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/operationIds/{operationIdsId}
▼ ▲ auditmanager.projects.locations.standards.controls.list
Scopes :
Path : v1/{+parent}/controls
Parameter Order : parent
HTTP Method : GET
Flat Path : v1/projects/{projectsId}/locations/{locationsId}/standards/{standardsId}/controls
Parameters :
pageToken
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
Location : query
Type : string
pageSize
Type : integer
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Format : int32
Location : query
parent
Location : path
Description : Required. Standard to list controls for, in one of the following formats: * `projects/{project}/locations/{location}/standards/{standard}` * `folders/{folder}/locations/{location}/standards/{standard}` * `organizations/{organization}/locations/{location}/standards/{standard}`
Required : Yes
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/standards/[^/]+$
Description : Lists the controls that you must implement to become compliant to a regulatory standard.
▼ ▲ auditmanager.projects.locations.enrollResource
Parameter Order : scope
Flat Path : v1/projects/{projectsId}/locations/{locationsId}:enrollResource
Description : Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.
Parameters :
scope
Description : Required. Organization, folder, or project to enroll in Audit Manager, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Type : string
Location : path
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
HTTP Method : POST
Scopes :
Path : v1/{+scope}:enrollResource
▼ ▲ auditmanager.projects.locations.get
Parameter Order : name
Flat Path : v1/projects/{projectsId}/locations/{locationsId}
Scopes :
Path : v1/{+name}
HTTP Method : GET
Description : Gets information about a location.
Parameters :
name
Description : Resource name for the location.
Type : string
Required : Yes
Pattern : ^projects/[^/]+/locations/[^/]+$
Location : path
▼ ▲ auditmanager.projects.locations.list
Path : v1/{+name}/locations
Scopes :
Flat Path : v1/projects/{projectsId}/locations
Parameters :
name
Type : string
Description : The resource that owns the locations collection, if applicable.
Pattern : ^projects/[^/]+$
Required : Yes
Location : path
filter
Location : query
Type : string
Description : A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
pageToken
Type : string
Description : A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
Location : query
pageSize
Location : query
Type : integer
Description : The maximum number of results to return. If not set, the service selects a default.
Format : int32
extraLocationTypes
Description : Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.
Repeated : Yes
Type : string
Location : query
HTTP Method : GET
Description : Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
Parameter Order : name
▼ ▲ auditmanager.organizations.locations.enrollResource
Path : v1/{+scope}:enrollResource
Description : Adds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required permissions to the service agent. If you make this request on a workload that's already enrolled, then this method overrides the existing set of destinations.
Parameter Order : scope
Scopes :
Parameters :
scope
Description : Required. Organization, folder, or project to enroll in Audit Manager, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Type : string
Required : Yes
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
HTTP Method : POST
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}:enrollResource
▼ ▲ auditmanager.organizations.locations.standards.controls.list
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/standards/{standardsId}/controls
Scopes :
Description : Lists the controls that you must implement to become compliant to a regulatory standard.
Parameters :
pageToken
Type : string
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
Location : query
parent
Location : path
Description : Required. Standard to list controls for, in one of the following formats: * `projects/{project}/locations/{location}/standards/{standard}` * `folders/{folder}/locations/{location}/standards/{standard}` * `organizations/{organization}/locations/{location}/standards/{standard}`
Pattern : ^organizations/[^/]+/locations/[^/]+/standards/[^/]+$
Type : string
Required : Yes
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Parameter Order : parent
Path : v1/{+parent}/controls
HTTP Method : GET
▼ ▲ auditmanager.organizations.locations.resourceEnrollmentStatuses.list
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/resourceEnrollmentStatuses
Parameters :
pageToken
Location : query
Type : string
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
parent
Location : path
Type : string
Description : Required. Parent organization or folder to list enrollment statuses for, in one of the following formats: * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Required : Yes
Pattern : ^organizations/[^/]+/locations/[^/]+$
pageSize
Format : int32
Type : integer
Location : query
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Description : Lists all the folders and projects in an organization or folder, along with their enrollments.
HTTP Method : GET
Scopes :
Parameter Order : parent
Path : v1/{+parent}/resourceEnrollmentStatuses
▼ ▲ auditmanager.organizations.locations.resourceEnrollmentStatuses.get
Parameter Order : name
Path : v1/{+name}
HTTP Method : GET
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/resourceEnrollmentStatuses/{resourceEnrollmentStatusesId}
Parameters :
name
Location : path
Type : string
Required : Yes
Description : Required. Name of the resource enrollment status, in one of the following formats: * `folders/{folder}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `projects/{project}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}` * `organizations/{organization}/locations/{location}/resourceEnrollmentStatuses/{resource_enrollment_status}`
Pattern : ^organizations/[^/]+/locations/[^/]+/resourceEnrollmentStatuses/[^/]+$
Description : Gets a resource and its enrollment status.
Scopes :
▼ ▲ auditmanager.organizations.locations.auditScopeReports.generate
Path : v1/{+scope}/auditScopeReports:generate
Description : Generates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses to verify your compliance with a framework. * A list of Google Cloud services and resources that are within the scope of the framework.
Parameter Order : scope
Parameters :
scope
Description : Required. Project or folder that the audit scope report is generated for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Type : string
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+$
Required : Yes
HTTP Method : POST
Scopes :
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/auditScopeReports:generate
▼ ▲ auditmanager.organizations.locations.operationDetails.get
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operationDetails/{operationDetailsId}
Path : v1/{+name}
Parameters :
name
Pattern : ^organizations/[^/]+/locations/[^/]+/operationDetails/[^/]+$
Location : path
Description : The name of the operation resource.
Type : string
Required : Yes
Scopes :
HTTP Method : GET
Parameter Order : name
Description : Gets details about the long-running operation to generate audit reports.
▼ ▲ auditmanager.organizations.locations.auditReports.list
Description : Lists the audit reports for the organization, folder, or project that you specify as the parent scope.
Path : v1/{+parent}/auditReports
Parameter Order : parent
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/auditReports
HTTP Method : GET
Scopes :
Parameters :
parent
Required : Yes
Type : string
Pattern : ^organizations/[^/]+/locations/[^/]+$
Description : Required. Parent organization, folder, or project to list reports for, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Location : path
pageSize
Description : Optional. Maximum number of items to return in a single page. The service might return fewer items than this value. If unspecified, the service picks an appropriate default. The maximum value is 100; values above 100 are reduced to 100.
Location : query
Format : int32
Type : integer
pageToken
Location : query
Description : Optional. A page token, received from a previous call, to retrieve the next page of results.
Type : string
▼ ▲ auditmanager.organizations.locations.auditReports.generate
Path : v1/{+scope}/auditReports:generate
Parameters :
scope
Location : path
Type : string
Required : Yes
Description : Required. Organization, folder, or project that the audit applies to, in one of the following formats: * `projects/{project}/locations/{location}` * `folders/{folder}/locations/{location}` * `organizations/{organization}/locations/{location}`
Pattern : ^organizations/[^/]+/locations/[^/]+$
HTTP Method : POST
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/auditReports:generate
Scopes :
Parameter Order : scope
Description : Registers audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.
▼ ▲ auditmanager.organizations.locations.auditReports.get
HTTP Method : GET
Parameters :
name
Pattern : ^organizations/[^/]+/locations/[^/]+/auditReports/[^/]+$
Location : path
Type : string
Required : Yes
Description : Required. Name of the audit report, in one of the following formats: * `projects/{project}/locations/{location}/auditReports/{audit_report}` * `folders/{folder}/locations/{location}/auditReports/{audit_report}` * `organizations/{organization}/locations/{location}/auditReports/{audit_report}`
Description : Gets the full metadata and findings for an audit report.
Path : v1/{+name}
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/auditReports/{auditReportsId}
Scopes :
Parameter Order : name
▼ ▲ auditmanager.organizations.locations.operationIds.get
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operationIds/{operationIdsId}
Path : v1/{+name}
Description : Gets details about the long-running operation to generate audit reports.
HTTP Method : GET
Parameters :
name
Location : path
Type : string
Description : The name of the operation resource.
Pattern : ^organizations/[^/]+/locations/[^/]+/operationIds/[^/]+$
Required : Yes
Scopes :
Parameter Order : name
▼ ▲ auditmanager.organizations.locations.operations.get
Parameter Order : name
Scopes :
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
HTTP Method : GET
Parameters :
name
Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Description : The name of the operation resource.
Type : string
Required : Yes
Description : Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Path : v1/{+name}
▼ ▲ auditmanager.organizations.locations.operations.list
Path : v1/{+name}/operations
HTTP Method : GET
Parameters :
pageSize
Format : int32
Location : query
Description : The standard list page size.
Type : integer
name
Type : string
Description : The name of the operation's parent resource.
Required : Yes
Pattern : ^organizations/[^/]+/locations/[^/]+$
Location : path
returnPartialSuccess
Type : boolean
Description : When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
Location : query
filter
Type : string
Description : The standard list filter.
Location : query
pageToken
Description : The standard list page token.
Location : query
Type : string
Scopes :
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations
Parameter Order : name
Description : Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
▼ ▲ auditmanager.organizations.locations.operations.delete
HTTP Method : DELETE
Description : Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameters :
name
Description : The name of the operation resource to be deleted.
Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Location : path
Required : Yes
Type : string
Parameter Order : name
Path : v1/{+name}
Scopes :
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ auditmanager.organizations.locations.operations.cancel
Description : Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.
Flat Path : v1/organizations/{organizationsId}/locations/{locationsId}/operations/{operationsId}:cancel
Parameters :
name
Type : string
Location : path
Pattern : ^organizations/[^/]+/locations/[^/]+/operations/[^/]+$
Description : The name of the operation resource to be cancelled.
Required : Yes
HTTP Method : POST
Scopes :
Path : v1/{+name}:cancel
Parameter Order : name