Version: 11 - 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

Property Description Type Import/Export

active A flag if the organization is active. Output only. Boolean() export only

address_line_1 The billing address. String(length=1024) both

address_line_2 The billing address. String(length=1024) both

allow_excess_usage If executions are allowed to run when the allowance of productive connections in a month is already exceeded. Boolean() export only

bundle_id Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, LDAP_CONFIG, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id UUID(as_uuid=False) both

bundle_name The name of the bundle. Will look up the bundle and set bundle_id. String(length=128) neither

city The billing address. String(length=1024) both

commit_message The commit message for this change. Text() import only

country The billing address. String(length=1024) both

created_at DateTime(timezone=True) export only

created_by UUID(as_uuid=False) export only

deleted_at DateTime(timezone=True) export only

deleted_by UUID(as_uuid=False) export only

description A multiline description of what this record is and does. Text() both

has_deprecation Boolean() export only

has_syntax_error Boolean() export only

id UUID(as_uuid=False) neither

is_bundle_content A flag to control if the resource is considered bundle content. Changes in bundle content mark the bundle as modified. Updating the bundle will modify the bundle content. Boolean() both

is_bundle_readonly Boolean() neither

is_deleted Boolean() export only

is_project_readonly Boolean() neither

is_readonly A flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, 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, WORKSPACE Boolean() both

is_trial_account If the organization is currently a trial account. Output only. Boolean() export only

last_notification_state_connection_usage_percent The state of connection usage percentage during the last notification check. Text() export only

last_notification_state_diskspace_free_bytes The state of free diskspace bytes during the last notification check. Text() export only

last_notification_state_diskspace_usage_percent The state of diskspace usage percentage during the last notification check. Text() export only

last_notification_state_storage_usage_percent The state of storage usage percentage during the last notification check. Text() export only

last_reset_at DateTime(timezone=True) export only

location_inheritance

Controls the project/bundle association of a newly created record when no project_id/project_name/bundle_id/bundle_name is specified in the create request. Depending on the record type different options are available:

location_inheritance	record types	description
`created_by`	all	use the same location as the identity which creates the record
`default`	all	use the "Default project" where applicable or "Workspace" for record types which cannot be in a project
`wrapped_resource`	execution	use the same location as the innermost resource which is wrapped
`resource`	execution	use the same location as the resource on which the execution is based on

Notes:

If a project_id/project_name/bundle_id/bundle_name is specified in the request, it always takes precedence.
The options wrapped_resource and resource only work with executions which are based on a resource, not with ad-hoc connections or executions of type "SCRIPT". If used with ad-hoc connections or "SCRIPT" it will fall back to default.
If the record being created cannot be associated with the specified location, the fallback to default will be used.
If location_inheritance is unset, the default value used depends on the type of identity which creates the record as well as the type of record which is created. If an execution is created by any identity which is not an execution, it defaults to wrapped_resource. In all other cases it defaults to created_by.

String(length=128)

neither

modified_at DateTime(timezone=True) export only

modified_by UUID(as_uuid=False) export only

name The name of this record. Must be unique across a workspace. String(length=128) both

organization_id UUID(as_uuid=False) export only

payment_type The chosen payment type. Enum('INVOICE', name='paymenttype') both

primary_contact The name of the primary contact person. Used for invoices. String(length=1024) both

project_id Reference to the project this record is associated with. Allowed for CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, 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_name The name of the project. Will look up the project and set project_id. String(length=128) neither

record_type Enum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'DEVOLUTIONS_CONFIG', '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

region The billing address. String(length=1024) both

repository_path The path to the storing repository, relative to GIT_REPOSITORY_SAVE_PATH String(length=256) neither

resource_type Enum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'DEVOLUTIONS_CONFIG', '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_version String(length=128) both

usage_allowance_connection_productive The number of productive connections which can be started each month. Integer() export only

usage_allowance_db_size_bytes BigInteger() export only

usage_count_cde_minutes The number of minutes of CDE usage this month. Integer() export only

usage_count_connection_dev Integer() export only

usage_count_connection_productive The number of productive connections which were started this month. Integer() export only

usage_count_flow_dev Integer() export only

usage_count_flow_productive Integer() export only

usage_db_size_bytes The total database size of all workspaces in organization in bytes. BigInteger() export only

vat_number The VAT ID. Used for invoices. String(length=1024) both

workspace_id UUID(as_uuid=False) export only

zip The billing address. String(length=128) both