Organization
class flow_api.organization.Organization
(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, address_line_1=<class 'flow_api.system.NotSet'>, address_line_2=<class 'flow_api.system.NotSet'>, bundle_id=<class 'flow_api.system.NotSet'>, bundle_name=<class 'flow_api.system.NotSet'>, city=<class 'flow_api.system.NotSet'>, commit_message=<class 'flow_api.system.NotSet'>, country=<class 'flow_api.system.NotSet'>, description=<class 'flow_api.system.NotSet'>, is_readonly=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, payment_type=<class 'flow_api.system.NotSet'>, primary_contact=<class 'flow_api.system.NotSet'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, region=<class 'flow_api.system.NotSet'>, vat_number=<class 'flow_api.system.NotSet'>, zip=<class 'flow_api.system.NotSet'>, debug=False
)
Base class: Resource
Information about your organization, license, and billing.
Organization resources cannot be created or deleted.
See the corresponding Resources class at Organization
Parameters
Name | Type | Description |
---|---|---|
address_line_1 | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The billing address. |
address_line_2 | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The billing address. |
allow_deleted | bool | |
allow_normal | bool | |
bundle_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, 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_id |
bundle_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the bundle. Will look up the bundle and set bundle_id. |
by | str | |
city | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The billing address. |
cls | typing.Union[ type, NoneType ] | |
commit_message | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The commit message for this change. |
country | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The billing address. |
debug | bool | if set, the content of the data being written will be logged. |
description | typing.Union[ flow_api.system.NotSet, str, NoneType ] | A multiline description of what this record is and does. |
init | typing.Union[ dict, NoneType ] | |
is_readonly | typing.Union[ flow_api.system.NotSet, bool ] | 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 |
name | typing.Union[ flow_api.system.NotSet, str ] | The name of this record. Must be unique across a workspace. |
payment_type | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The chosen payment type. |
primary_contact | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the primary contact person. Used for invoices. |
project_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | 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. |
project_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the project. Will look up the project and set project_id. |
region | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The billing address. |
select | typing.Union[ str, NoneType ] | |
vat_number | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The VAT ID. Used for invoices. |
zip | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The billing address. |