whitelisted-endpoints.yml

passwords:
  endpoints:
  - /passwords
  - /passwords/:id
  - /organizations/:id/relationships/passwords
  - /organizations/:id/relationships/passwords/:id
  methods: 
  - GET
  - POST
  - PATCH
  allowed_parameters:
  - filter[id]
  - filter[name]
  - filter[organization_id]
  - filter[password_category_id]
  - filter[url]
  - filter[cached_resource_name]
  - sort
  - page[number]
  - page[size]
  required_parameters:
  - show_passwords: "false"
  createbody:
    data:
    - type: string
      attributes:
        name: string
        username: string
        password: string
        url: string
        notes: string
        resource_id: int
        resource_type: string
        password-category-id: int 
        password-category-name: string
  returnbody:
    data:
    - type: string
      id: int
      attributes:
        username: string
        name: string
        organization-id: int
        url: string
        notes: string
        created-at: datetime
        updated-at: datetime
        password-updated-at: datetime

organizations:
  endpoints:
  - /organizations
  - /organizations/:id
  methods:
  - GET
  allowed_parameters:
  - filter[id]
  - filter[name]
  - filter[organization_type_id]
  - filter[organization_status_id]
  - filter[psa_id]
  - sort
  - page[number]
  - page[size]
  returnbody:
    data:
    - type: string
      id: int
      attributes:
        name: string
        organization-type-id: int
        organization-type-name: string
        updated-at: datetime
        created-at: datetime

configurations:
  endpoints:
  - /configurations
  - /configurations/:id
  - /organizations/:id/relationships/configurations
  - /organizations/:id/relationships/configurations/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[name]
  - filter[psa_id]
  - filter[serial_number]
  - page[number]
  - page[size]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        organization-id: int
        name: string
        hostname: string
        configuration-type-id: string
        configuration-status-id: string
        manufacturer-id: string
        model-id: string
        primary-ip: string
        serial-number: string
        mac-address: string
        asset-tag: string
        notes: string
      relationships:
        configuration-interfaces:
          data:
          - id: int
            type: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        name: string
        hostname: string
        serial-number: string
        asset-tag: string
        notes: string
      relationships:
        configuration-interfaces:
          data:
          - id: int
            type: string

flexible_assets:
  endpoints:
  - /flexible_assets
  - /flexible_assets/:id
  methods:
  - GET
  - PATCH
  - POST
  allowed_parameters:
  - filter[flexible_asset_type_id]
  - filter[name]
  - filter[organization_id]
  - page[number]
  - page[size]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        id: int
        organization-id: int
        flexible-asset-type-id: int
        traits:
          ### Used for "Device logbook - Autodoc"
          device-name: string
          events: string
          user-profiles: string
          installed-updates: string
          installed-software: string
          device: int
          ### ADDS Documentation
          domain-name: string
          forest-summary: string
          site-summary: string
          domain-controllers: string
          fsmo-roles: string
          optional-features: string
          upn-suffixes: string
          default-password-policies: string
          domain-admins: string
          user-count: string
          ### Used for "Unifi - Sites"
          site-name: string
          wan: string
          lan: string
          vpn: string
          wi-fi: string
          port-forwards: string
          switches: string
          ### Used for "ITGLue AutoDoc - SQL Server"
          instance-name: string
          instance-settings: string
          databases: string
          tagged-devices: [int]
          ### User for "Fileshare"
          name: string
          share-name: string
          share-path: string
          full-control-permissions: string
          read-permissions: string
          modify-permissions: string
          deny-permissions: string
          #tagged-devices: string #duplicate
          csv-file:
            content: base64file
            file_name: string
          # Used for "Hyper-v AutoDoc v2"
          host-name: string
          virtual-machines: string
          network-settings: string
          replication-settings: string
          host-settings: string
  returnbody:
    errors: list
    data:
    - id: int
      type: string
      attributes:
        organization-id: int
        flexible-asset-type-id: int
        name: string
        traits:
          device-name: string
          domain-name: string
          instance-name: string
          device: int
          name: string
          host-name: string
        created-at: datetime
        updated-at: datetime

flexible_asset_types:
  endpoints:
  - /flexible_asset_types
  - /flexible_asset_types/:id
  methods:
  - GET
  - POST
  allowed_parameters:
  - filter[enabled]
  - filter[id]
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
        description: string
        icon: string
        show-in-menu: bool
      relationships:
        flexible-asset-fields:
          data:
          - type: string
            attributes:
              order: int
              name: string
              kind: string
              hint: string
              tag-type: string
              required: bool
              options: string
              use-for-title: bool
              show-in-list: bool
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        description: string
        created-at: datetime
        updated-at: datetime
        icon: string
        show-in-menu: bool
      relationships:
        flexible-asset-fields:
          data:
          - id: int
            type: string

configuration_types:
  endpoints:
  - /configuration_types
  - /configuration_types/:id
  methods:
  - GET
  - POST
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        configurations-count: int
        created-at: datetime
        updated-at: datetime

models:
  endpoints:
  - /models
  - /models/:id
  methods:
  - GET
  - POST
  allowed_parameters:
  - filter[id]
  - page[number]
  - page[size]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        id: int
        name: string
        manufacturer-id: int
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime

manufacturers:
  endpoints:
  - /manufacturers
  - /manufacturers/:id
  methods:
  - GET
  - POST
  allowed_parameters:
  - filter[name]
  required_parameters:
  createbody:
    data:
    - type: string
      attributes:
        name: string
  returnbody:
    data:
    - id: int
      type: string
      attributes:
        name: string
        created-at: datetime
        updated-at: datetime