openapi: 3.2.0
info:
  description: '# Welcome to CloudRanger


    Here are some instructions on how to use the API

    ## Authentication and Authorization

    * Access to the API is controlled by your API key generated in the CloudRanger dashboard and token

    * The token is returned by calling the /authorize endpoint and supplying the x-api-key header

    * All other calls use the x-api-key header and the Authorzation header with Bearer followed by your token'
  title: CloudRanger Notification Settings API
  version: '2022-12-07T16:38:31.962Z'
servers:
- url: https://api.cloudranger.com/202004
tags:
- name: Notification Settings
paths:
  /organizations/{organization_id}/notification_settings:
    put:
      description: Update notification settings for the organization.
      parameters:
      - description: Organization Id of the Organization that you are working with. This can be found by looking at the organization id in the URL of the dashboard. These are randomly generated alphanumber values
        in: path
        name: organization_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutOrganizationsNotification_settingsRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutOrganizationsNotifications_settingsResponse'
          description: 200 response
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/empty'
          description: 201 response
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 401 response
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 403 response
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: 404 response
      security:
      - API_Authorizer: []
        api_key: []
      summary: Update notification settings
      tags:
      - Notification Settings
      operationId: putOrganizationsByOrganizationIdNotificationSettings
      x-operation-id-source: derived
components:
  schemas:
    empty:
      properties: {}
      type: object
    PutOrganizationsNotifications_settingsResponse:
      items:
        properties:
          enabled:
            type: boolean
          organization_id:
            type: string
          recipients:
            type: string
          type:
            type: string
        type: object
      type: array
    PutOrganizationsNotification_settingsRequest:
      items:
        properties:
          enabled:
            type: boolean
          organization_id:
            type: string
          recipients:
            description: '[{''target'':''email@email.com'',''type'':''email''}]'
            type: string
          type:
            type: string
        type: object
      type: array
    Error:
      properties:
        message:
          type: string
      type: object
  securitySchemes:
    API_Authorizer:
      in: header
      name: Authorization
      type: apiKey
      x-amazon-apigateway-authtype: custom
    api_key:
      in: header
      name: x-api-key
      type: apiKey
x-readme:
  explorer-enabled: true
  proxy-enabled: true
  samples-enabled: true