Google Admin SDK Admin Sdk Admin Reports Channels API

openapi: 3.1.0
info:
  title: Admin SDK API Channels API
  version: reports_v1
  description: Generated from Google's published Discovery document for Admin SDK API (admin reports_v1, revision 20261109).
    1 operation(s).
  contact:
    name: Google
    url: https://developers.google.com/
  termsOfService: https://developers.google.com/terms
externalDocs:
  url: https://developers.google.com/workspace/admin/
servers:
- url: https://admin.googleapis.com
paths:
  /admin/reports_v1/channels/stop:
    post:
      operationId: admin.channels.stop
      summary: Stop channels
      description: Stop watching resources through this channel.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Channel'
      responses:
        '200':
          description: Successful response
        4XX:
          content: &id001
            application/json:
              schema:
                $ref: '#/components/schemas/GoogleRpcError'
          description: 'Client error (google.rpc.Status: INVALID_ARGUMENT, PERMISSION_DENIED, NOT_FOUND ...)'
        default:
          content: *id001
          description: Error response (google.rpc.Status)
      security:
      - oauth2:
        - https://www.googleapis.com/auth/admin.reports.audit.readonly
      - apiKey: []
      tags:
      - Channels
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: query
      name: key
      description: API key; accepted by methods that do not need user data.
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/admin.reports.usage.readonly: View usage reports for your Google Workspace domain
            https://www.googleapis.com/auth/admin.reports.audit.readonly: View audit reports for your Google Workspace domain
  schemas:
    Channel:
      properties:
        kind:
          default: api#channel
          description: Identifies this as a notification channel used to watch for changes to a resource, which is "`api#channel`".
          type: string
        address:
          description: The address where notifications are delivered for this channel.
          type: string
        token:
          description: An arbitrary string delivered to the target address with each notification delivered over this channel.
            Optional.
          type: string
        id:
          type: string
          description: A UUID or similar unique string that identifies this channel.
        payload:
          type: boolean
          description: A Boolean value to indicate whether payload is wanted. A payload is data that is sent in the body of
            an HTTP POST, PUT, or PATCH message and contains important information about the request. Optional.
        params:
          additionalProperties:
            type: string
          description: Additional parameters controlling delivery channel behavior. Optional.
          type: object
        resourceUri:
          description: A version-specific identifier for the watched resource.
          type: string
        type:
          description: The type of delivery mechanism used for this channel. The value should be set to `"web_hook"`.
          type: string
        expiration:
          type: string
          description: Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
          format: int64
        resourceId:
          type: string
          description: An opaque ID that identifies the resource being watched on this channel. Stable across different API
            versions.
      description: A notification channel used to watch for resource changes.
      type: object
    GoogleRpcError:
      type: object
      description: The error envelope every Google API returns.
      properties:
        error:
          type: object
          properties:
            code:
              type: integer
            message:
              type: string
            status:
              type: string
            details:
              type: array
              items:
                type: object
x-provenance:
  method: harvested
  publisher: Google
  source: https://admin.googleapis.com/$discovery/rest?version=reports_v1
  note: converted by discovery-to-openapi.py from Google's Discovery document (revision 20261109)