Skip to main content
Version: 10 - TBD

Organization

class resources.organization.Organization

Base class: Resource

Information about your organization, license, and billing.

note

Organization resources cannot be created or deleted.

See the corresponding Flow Api class at Organization

PropertyDescriptionTypeImport/Export
activeA flag if the organization is active. Output only.Boolean()export only
address_line_1The billing address.String(length=1024)both
address_line_2The billing address.String(length=1024)both
allow_excess_usageIf executions are allowed to run when the allowance of productive connections in a month is already exceeded.Boolean()export only
bundle_idReference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, FILE, FLOW, LDAP_CONFIG, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, EXECUTION, MESSAGE, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_idUUID(as_uuid=False)both
bundle_nameThe name of the bundle. Will look up the bundle and set bundle_id.String(length=128)neither
cityThe billing address.String(length=1024)both
commit_messageThe commit message for this change.Text()import only
countryThe billing address.String(length=1024)both
created_atDateTime(timezone=True)export only
created_byUUID(as_uuid=False)export only
deleted_atDateTime(timezone=True)export only
deleted_byUUID(as_uuid=False)export only
descriptionA multiline description of what this record is and does.Text()both
idUUID(as_uuid=False)neither
is_bundle_readonlyBoolean()neither
is_deletedBoolean()export only
is_project_readonlyBoolean()neither
is_readonlyA flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, FILE, FLOW, OAUTH, OBJECT_TEMPLATE, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACEBoolean()both
is_trial_accountIf the organization is currently a trial account. Output only.Boolean()export only
last_notification_state_connection_usage_percentThe state of connection usage percentage during the last notification check.Text()export only
last_notification_state_diskspace_free_bytesThe state of free diskspace bytes during the last notification check.Text()export only
last_notification_state_diskspace_usage_percentThe state of diskspace usage percentage during the last notification check.Text()export only
last_notification_state_storage_usage_percentThe state of storage usage percentage during the last notification check.Text()export only
last_reset_atDateTime(timezone=True)export only
modified_atDateTime(timezone=True)export only
modified_byUUID(as_uuid=False)export only
nameThe name of this record. Must be unique across a workspace.String(length=128)both
organization_idUUID(as_uuid=False)export only
payment_typeThe chosen payment type.Enum('INVOICE', name='paymenttype')both
primary_contactThe name of the primary contact person. Used for invoices.String(length=1024)both
project_idReference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, EXECUTION, FILE, FLOW, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id.UUID(as_uuid=False)both
project_nameThe name of the project. Will look up the project and set project_id.String(length=128)neither
record_typeEnum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'EXECUTION', 'FILE', 'FLOW', 'LDAP_CONFIG', 'MESSAGE', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROCESS', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype')neither
regionThe billing address.String(length=1024)both
repository_pathThe path to the storing repository, relative to GIT_REPOSITORY_SAVE_PATHString(length=256)neither
resource_typeEnum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'FILE', 'FLOW', 'LDAP_CONFIG', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='resourcetype')neither
schema_versionString(length=128)both
usage_allowance_connection_productiveThe number of productive connections which can be started each month.Integer()export only
usage_allowance_db_size_bytesBigInteger()export only
usage_count_connection_devInteger()export only
usage_count_connection_productiveThe number of productive connections which were started this month.Integer()export only
usage_count_flow_devInteger()export only
usage_count_flow_productiveInteger()export only
usage_db_size_bytesThe total database size of all workspaces in organization in bytes.BigInteger()export only
vat_numberThe VAT ID. Used for invoices.String(length=1024)both
workspace_idUUID(as_uuid=False)export only
zipThe billing address.String(length=128)both