action exavault_get_account {
  label: "Get account settings"
  description: "Get settings for your account, such as current space usage, webhooks settings, welcome email content and IP address restrictions."
  provider: exavault
  method: GET
  path: "/account"
  encoding: json
  input: {
    type: "object"
    properties: {
      "ev-access-token": {
        type: "string"
      }
      "ev-api-key": {
        type: "string"
      }
      include: {
        type: "string"
      }
    }
    required: ["ev-access-token", "ev-api-key"]
    additionalProperties: false
  }
  output: {
    type: "object"
    properties: {
      data: {
        type: "object"
        description: "Object contains all account properties."
        properties: {
          attributes: {
            type: "object"
            properties: {
              accountName: {
                type: "string"
                description: "Name of the account"
              }
              accountOnboarding: {
                type: "boolean"
                description: "Whether the web application onboarding help is enabled for new users in the account."
              }
              allowedIp: {
                type: "array"
                description: "Range of IP addresses allowed to access this account."
                items: {
                  type: "object"
                  properties: {
                    ipEnd: {
                      type: "string"
                    }
                    ipStart: {
                      type: "string"
                    }
                  }
                }
              }
              branding: {
                type: "boolean"
                description: "Branding flag. Set to `true` if the account has branding functionality enabled."
                enum: [true, false]
              }
              brandingSettings: {
                type: "object"
                properties: {
                  companyName: {
                    type: "string"
                  }
                  customEmail: {
                    type: "string"
                    format: "email"
                  }
                  logo: {
                    type: "string"
                  }
                  logoExt: {
                    type: "string"
                  }
                  theme: {
                    type: "string"
                  }
                  verifiedDomain: {
                    type: "string"
                  }
                  verifiedDomainId: {
                    type: "string"
                  }
                  verifiedDomainValid: {
                    type: "boolean"
                  }
                }
              }
              clientId: {
                type: "integer"
                format: "int32"
                description: "(ExaVault Use Only) Internal ID of the account in CMS."
              }
              complexPasswords: {
                type: "boolean"
                description: "Flag to indicate whether the account requires complex passwords. Set to `true` to require complex passwords on all users and shares."
              }
              created: {
                type: "string"
                format: "date-time"
                description: "Timestamp of account creation."
              }
              customDomain: {
                type: "boolean"
                description: "Custom domain flag. Set to `true` if account type allows custom domain functionality."
                enum: [true, false]
              }
              customSignature: {
                type: "string"
                description: "Custom signature for all account emails users or recipients will receive."
              }
              externalDomains: {
                type: "array"
                description: "Custom domain used to brand this account."
                items: {
                  type: "string"
                }
              }
              maxUsers: {
                type: "integer"
                format: "int32"
                description: "Maximum number of users the account can have. This can be increased by contacting ExaVault Support."
              }
              modified: {
                type: "string"
                format: "date-time"
                description: "Timestamp of account modification."
              }
              planDetails: {
                type: "object"
                properties: {
                  apiKeys: {
                    type: "integer"
                  }
                  apiTokens: {
                    type: "integer"
                  }
                  colorSchema: {
                    type: "boolean"
                  }
                  customDomain: {
                    type: "boolean"
                  }
                  customName: {
                    type: "boolean"
                  }
                  directLinks: {
                    type: "boolean"
                  }
                  ipWhitelist: {
                    type: "boolean"
                  }
                  sharingOptions: {
                    type: "array"
                    items: {
                      type: "string"
                    }
                  }
                  sshKeys: {
                    type: "integer"
                  }
                  storageAddOn: {
                    type: "integer"
                  }
                  unlimitedUsers: {
                    type: "boolean"
                  }
                  userExpiration: {
                    type: "boolean"
                  }
                  userImport: {
                    type: "boolean"
                  }
                  webhookOptions: {
                    type: "object"
                    properties: {
                      amount: {
                        type: "integer"
                      }
                      includeTriggers: {
                        type: "string"
                      }
                      restrictionTypes: {
                        type: "array"
                        items: {
                          type: "string"
                        }
                      }
                    }
                  }
                }
              }
              quota: {
                type: "object"
                properties: {
                  bandwidthLimit: {
                    type: "integer"
                    format: "int64"
                    description: "Total number of bytes that can be transferred per month."
                  }
                  bandwidthUsed: {
                    type: "integer"
                    format: "int64"
                    description: "Number of bytes transferred this month."
                  }
                  diskLimit: {
                    type: "integer"
                    format: "int64"
                    description: "Amount of disk space that the account has available to it. This may be increased by upgrading to a larger plan."
                  }
                  diskUsed: {
                    type: "integer"
                    format: "int64"
                    description: "Amount of disk space currently in use."
                  }
                  noticeEnabled: {
                    type: "boolean"
                    description: "Should a quota warning be sent to the account owner when a threshold level of space utilization is reached?"
                  }
                  noticeThreshold: {
                    type: "integer"
                    format: "int32"
                    description: "Treshold that triggers a quota notification. This represents the \"percent full\" your account must be before the quota notification is generated."
                  }
                  transactionsLimit: {
                    type: "integer"
                    format: "int32"
                    description: "Total number of transactions allowed in a 24-hour period."
                  }
                  transactionsNoticeEnabled: {
                    type: "boolean"
                    description: "Whether an email should be sent to the account owner up to once per day if transaction usage exceeds `transactionsNoticeThreshold` value."
                  }
                  transactionsNoticeThreshold: {
                    type: "integer"
                    format: "int32"
                    description: "Percent of daily transactions limit that will trigger an email if activity exceeds it."
                  }
                }
              }
              secureOnly: {
                type: "boolean"
                description: "Flag to indicate whether the account disables connections via insecure protocols (e.g. FTP). Set to `true` to disable all traffic over port 21."
              }
              showReferralLinks: {
                type: "boolean"
                description: "Flag to indicate showing of referrals links in the account. Set to `true` to include marketing messages in share invitations."
              }
              status: {
                type: "integer"
                format: "int32"
                description: "Account status flag. A one (1) means the account is active; zero (0) means it is suspended."
                enum: [1, 0]
              }
              userCount: {
                type: "integer"
                format: "int32"
                description: "Current number of users on the account."
              }
              welcomeEmailContent: {
                type: "string"
                description: "Content of welcome email each new user will receive."
              }
              welcomeEmailSubject: {
                type: "string"
                description: "Subject of welcome email each new user will receive."
              }
            }
          }
          id: {
            type: "integer"
            format: "int32"
            description: "Account ID"
          }
          relationships: {
            type: "object"
            properties: {
              masterUser: {
                type: "object"
                properties: {
                  data: {
                    type: "object"
                    properties: {
                      id: {
                        type: "integer"
                        description: "ID of master user for account"
                      }
                      type: {
                        type: "string"
                        enum: ["user"]
                      }
                    }
                  }
                }
              }
            }
          }
          type: {
            type: "string"
            description: "Type of item. \"account\""
            enum: ["account"]
          }
        }
      }
      included: {
        type: "array"
        description: "Array can contain objects specified in include param of the get call e.g User object"
        items: {
          type: "object"
          description: "Object contains user properties."
          properties: {
            attributes: {
              type: "object"
              description: "Attributes of the user including expiration, home directory, and permissions. "
              required: ["status", "created", "modified", "accountName", "username", "nickname", "homeResource", "permissions", "role", "timeZone", "onboarding"]
              properties: {
                accessTimestamp: {
                  type: "string"
                  description: "Timestamp of most recent successful user login."
                }
                accountName: {
                  type: "string"
                  description: "Name of the account this user belongs to."
                }
                created: {
                  type: "string"
                  format: "date-time"
                  description: "Timestamp of user creation."
                }
                email: {
                  type: "string"
                  description: "Email address of the user."
                }
                expiration: {
                  type: "string"
                  description: "Timestamp of user expiration."
                }
                firstLogin: {
                  type: "boolean"
                  description: "`true` if the user has logged into the system."
                }
                homePath: {
                  type: "string"
                  description: "Path to the user's home folder."
                }
                locked: {
                  type: "boolean"
                  description: "`true` if the user is locked and cannot log in."
                }
                modified: {
                  type: "string"
                  format: "date-time"
                  description: "Timestamp of user modification."
                }
                nickname: {
                  type: "string"
                  description: "Nickname of the user."
                }
                onboarding: {
                  type: "boolean"
                  description: "Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user."
                }
                permissions: {
                  type: "object"
                  required: ["download", "upload", "modify", "delete", "list", "changePassword", "share", "notification", "viewFormData", "deleteFormData"]
                  properties: {
                    changePassword: {
                      type: "boolean"
                      description: "Change (own) password permission flag"
                    }
                    delete: {
                      type: "boolean"
                      description: "Delete permission flag"
                    }
                    deleteFormData: {
                      type: "boolean"
                      description: "Delete form data permission flag. If true, user can remove data that was submitted for a receive folder. This applies only to data submitted in the receive folder form, not the actual files uploaded."
                    }
                    download: {
                      type: "boolean"
                      description: "Download permission flag"
                    }
                    list: {
                      type: "boolean"
                      description: "View folder contents permission flag"
                    }
                    modify: {
                      type: "boolean"
                      description: "Modify permission flag"
                    }
                    notification: {
                      type: "boolean"
                      description: "Notifications permission flag"
                    }
                    share: {
                      type: "boolean"
                      description: "Sharing permission flag"
                    }
                    upload: {
                      type: "boolean"
                      description: "Upload permission flag"
                    }
                    viewFormData: {
                      type: "boolean"
                      description: "Access Form Data permission flag. If true, user can view submissions that have been stored for a receive folder. This includes any data submitted in the receive folder form."
                    }
                  }
                }
                role: {
                  type: "string"
                  description: "User's access level"
                  enum: ["user", "admin", "master"]
                }
                status: {
                  type: "integer"
                  format: "int32"
                  description: "Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in."
                  enum: [0, 1]
                }
                timeZone: {
                  type: "string"
                  description: "User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values."
                }
                username: {
                  type: "string"
                  description: "Username of the user."
                }
              }
            }
            id: {
              type: "integer"
              format: "int32"
              description: "ID of the user."
            }
            relationships: {
              type: "object"
              description: "Home resource and owner account relationship data for the user. "
              required: ["ownerAccount"]
              properties: {
                homeResource: {
                  type: "object"
                  properties: {
                    data: {
                      type: "object"
                      properties: {
                        id: {
                          type: "integer"
                          format: "int64"
                          description: "ID of home directory resource."
                        }
                        type: {
                          type: "string"
                          description: "Type is resource."
                          enum: ["resource"]
                        }
                      }
                    }
                  }
                }
                ownerAccount: {
                  type: "object"
                  properties: {
                    data: {
                      type: "object"
                      properties: {
                        id: {
                          type: "integer"
                          format: "int32"
                          description: "ID of the account."
                        }
                        type: {
                          type: "string"
                          description: "Type is account."
                          enum: ["account"]
                        }
                      }
                    }
                  }
                }
              }
            }
            type: {
              type: "string"
              description: "Type of object being returned. Always \"user\""
            }
          }
        }
      }
      responseStatus: {
        type: "integer"
      }
    }
  }
}