Google

Audit Manager API

The Audit Manager API allows customers to manage compliance audits.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Audit Manager API allows customers to manage compliance audits.

Endpoints 14

projects.locations

  • POSTAdds your project, folder, or organization to Audit Manager/v1/:scope:enrollResourceAdds your project, folder, or organization to Audit Manager. This method creates the Audit Manager service agent in your workload and grants required…
  • GETLists information about the supported locations for this service/v1/:name/locations?extraLocationTypes=string&filter=string&pageSize=0&pageToken=stringLists information about the supported locations for this service. This method lists locations based on the resource scope provided in the…

projects.locations.auditReports

  • POSTRegisters audit report generation requests/v1/:scope/auditReports:generateRegisters audit report generation requests. This method returns the operation identifier that you can use to track the report generation progress.
  • GETLists the audit reports for the organization, folder, or project that you specify as the parent scope./v1/:parent/auditReports?pageSize=0&pageToken=stringLists the audit reports for the organization, folder, or project that you specify as the parent scope.

projects.locations.resourceEnrollmentStatuses

  • GETGets a resource and its enrollment status./v1/:nameGets a resource and its enrollment status.

projects.locations.operations

  • DELETEDeletes a long-running operation/v1/:nameDeletes 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…
  • POSTStarts asynchronous cancellation on a long-running operation/v1/:name:cancelStarts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the…
  • GETLists operations that match the specified filter in the request/v1/:name/operations?filter=string&pageSize=0&pageToken=string&returnPartialSuccess=trueLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

projects.locations.auditSchedules

  • PATCHUpdates an existing audit schedule./v1/:name?updateMask=string&validateOnly=trueUpdates an existing audit schedule.
  • GETLists audit schedules in a given project and location./v1/:parent/auditSchedules?pageSize=0&pageToken=stringLists audit schedules in a given project and location.
  • POSTCreates a new audit schedule in a given project and location./v1/:parent/auditSchedules?auditScheduleId=string&validateOnly=trueCreates a new audit schedule in a given project and location.

projects.locations.auditScopeReports

  • POSTGenerates an audit scope report for the given standard/v1/:scope/auditScopeReports:generateGenerates an audit scope report for the given standard. The report includes the following: * The technical attributes and constraints that Audit Manager uses…

organizations.locations.resourceEnrollmentStatuses

  • GETLists all the folders and projects in an organization or folder, along with their enrollments./v1/:parent/resourceEnrollmentStatuses?pageSize=0&pageToken=stringLists all the folders and projects in an organization or folder, along with their enrollments.

projects.locations.standards.controls

  • GETLists the controls that you must implement to become compliant to a regulatory standard./v1/:parent/controls?pageSize=0&pageToken=stringLists the controls that you must implement to become compliant to a regulatory standard.

API details

Base URL
https://auditmanager.googleapis.com
Authentication
OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter
Operations
14 operations on 11 pathsGET 7POST 5PATCH 1DELETE 1
Main resources
projects.locations.auditSchedules 3projects.locations.operations 3projects.locations 2projects.locations.auditReports 2organizations.locations.resourceEnrollmentStatuses 1projects.locations.auditScopeReports 1projects.locations.resourceEnrollmentStatuses 1projects.locations.standards.controls 1
Response formats
application/json
Description format
Google API Discovery, API version v1

How to test the Audit Manager API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Audit Manager API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Adds your project, folder, or organization to Audit Manager” (POST /v1/:scope:enrollResource), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Audit Manager API?

The Audit Manager API allows customers to manage compliance audits. It is listed under Developer tools and has 14 endpoints.

Who publishes the Audit Manager API?

It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Audit Manager API?

Requests go to https://auditmanager.googleapis.com. Endpoint paths are added to this base URL.

How do I authenticate with the Audit Manager API?

It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.

How many endpoints does the Audit Manager API have?

14 operations on 11 paths (7 GET, 5 POST, 1 PATCH, 1 DELETE). The largest groups are projects.locations.auditSchedules, projects.locations.operations, projects.locations, projects.locations.auditReports.

Is forking the Audit Manager API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.