Struct Organization 

pub struct Organization {

    pub id: Option<Uuid>,
    pub identifier: Option<String>,
    pub name: Option<String>,
    pub business_name: Option<String>,
    pub business_address1: Option<String>,
    pub business_address2: Option<String>,
    pub business_address3: Option<String>,
    pub business_country: Option<String>,
    pub business_tax_number: Option<String>,
    pub billing_email: Option<String>,
    pub plan: Option<String>,
    pub plan_type: Option<PlanType>,
    pub seats: Option<i32>,
    pub max_collections: Option<i32>,
    pub use_policies: Option<bool>,
    pub use_sso: Option<bool>,
    pub use_key_connector: Option<bool>,
    pub use_scim: Option<bool>,
    pub use_groups: Option<bool>,
    pub use_directory: Option<bool>,
    pub use_events: Option<bool>,
    pub use_totp: Option<bool>,
    pub use2fa: Option<bool>,
    pub use_api: Option<bool>,
    pub use_reset_password: Option<bool>,
    pub use_secrets_manager: Option<bool>,
    pub self_host: Option<bool>,
    pub users_get_premium: Option<bool>,
    pub use_custom_permissions: Option<bool>,
    pub storage: Option<i64>,
    pub max_storage_gb: Option<i32>,
    pub gateway: Option<GatewayType>,
    pub gateway_customer_id: Option<String>,
    pub gateway_subscription_id: Option<String>,
    pub reference_data: Option<String>,
    pub enabled: Option<bool>,
    pub license_key: Option<String>,
    pub public_key: Option<String>,
    pub private_key: Option<String>,
    pub two_factor_providers: Option<String>,
    pub expiration_date: Option<String>,
    pub creation_date: Option<String>,
    pub revision_date: Option<String>,
    pub max_autoscale_seats: Option<i32>,
    pub owners_notified_of_autoscaling: Option<String>,
    pub status: Option<OrganizationStatusType>,
    pub use_password_manager: Option<bool>,
    pub sm_seats: Option<i32>,
    pub sm_service_accounts: Option<i32>,
    pub max_autoscale_sm_seats: Option<i32>,
    pub max_autoscale_sm_service_accounts: Option<i32>,
    pub limit_collection_creation: Option<bool>,
    pub limit_collection_deletion: Option<bool>,
    pub allow_admin_access_to_all_collection_items: Option<bool>,
    pub limit_item_deletion: Option<bool>,
    pub use_risk_insights: Option<bool>,
    pub use_organization_domains: Option<bool>,
    pub use_admin_sponsored_families: Option<bool>,
    pub sync_seats: Option<bool>,
    pub use_automatic_user_confirmation: Option<bool>,
    pub use_disable_sm_ads_for_users: Option<bool>,
    pub use_phishing_blocker: Option<bool>,
    pub use_my_items: Option<bool>,
    pub use_invite_links: Option<bool>,
    pub exempt_from_billing_automation: Option<bool>,
}

Organization : An organization is an entity that allows users to share vault items and manage billing, access control, and other enterprise features depending on the plan.

Fields

id: Option<Uuid>

A unique identifier for the organization.

identifier: Option<String>

A unique, human-readable identifier used to specify the organization during SSO login.

name: Option<String>

This value is HTML encoded. For display purposes use the method DisplayName() instead.

business_name: Option<String>

This value is HTML encoded. For display purposes use the method DisplayBusinessName() instead.

business_address1: Option<String>

The first line of the organization’s business address.

business_address2: Option<String>

The second line of the organization’s business address.

business_address3: Option<String>

The third line of the organization’s business address.

business_country: Option<String>

The two-letter ISO country code of the organization’s business address.

business_tax_number: Option<String>

The organization’s tax identification number.

billing_email: Option<String>

The billing email address for the organization.

plan: Option<String>

The name of the plan the organization is subscribed to. It is unclear why this is stored and what it is used for - do not use it. Use the Bit.Core.AdminConsole.Entities.Organization.PlanType instead.

plan_type: Option<PlanType>

seats: Option<i32>

The number of user seats included in the organization’s subscription. NULL if the plan has no seat limit.

max_collections: Option<i32>

The maximum number of collections the organization can create. NULL if the plan has no collection limit.

use_policies: Option<bool>

If true, the organization has access to the Policies feature.

use_sso: Option<bool>

If true, the organization has access to the SSO (Single Sign-On) feature.

use_key_connector: Option<bool>

If true, the organization has access to the Key Connector feature, which allows SSO without master passwords.

use_scim: Option<bool>

If true, the organization has access to the SCIM (System for Cross-domain Identity Management) feature. This is used for automatic user provisioning.

use_groups: Option<bool>

If true, the organization has access to the Groups feature.

use_directory: Option<bool>

If true, the organization can use Directory Connector. This is a standalone app used for automatic user provisioning.

use_events: Option<bool>

If true, the organization has access to the event logs feature.

use_totp: Option<bool>

If true, the organization has access to the TOTP feature for vault items.

use2fa: Option<bool>

If true, the organization has access to organization-level two-factor authentication.

use_api: Option<bool>

If true, the organization has access to the public API.

use_reset_password: Option<bool>

If true, the organization has access to the account recovery (admin password reset) feature.

use_secrets_manager: Option<bool>

If true, the organization is subscribed to the Secrets Manager product.

self_host: Option<bool>

If true, the organization can export a license file which is used to create the organization on a self-hosted instance. It does not indicate whether this organization is self-hosted.

users_get_premium: Option<bool>

If true, all members of the organization are granted premium features.

use_custom_permissions: Option<bool>

If true, the organization has access to custom user roles with fine-grained permissions.

storage: Option<i64>

The number of bytes of file attachment storage the organization has used.

max_storage_gb: Option<i32>

The maximum number of gigabytes of file attachment storage available to the organization.

gateway: Option<GatewayType>

gateway_customer_id: Option<String>

The organization’s customer ID in the payment gateway.

gateway_subscription_id: Option<String>

The organization’s subscription ID in the payment gateway.

reference_data: Option<String>

A JSON blob of reference data, e.g. the signup source.

enabled: Option<bool>

If true, the organization is active. If false, the organization is disabled and access to its vault and features are restricted.

license_key: Option<String>

The license key for the organization. Used by self-hosted instances to validate the license.

public_key: Option<String>

The organization’s asymmetric public key, used to enrol members in account recovery.

private_key: Option<String>

The organization’s asymmetric private key, encrypted with the organization’s symmetric key.

two_factor_providers: Option<String>

A JSON blob of the organization’s two-factor authentication provider configurations. Use M:Bit.Core.AdminConsole.Entities.Organization.GetTwoFactorProviders and M:Bit.Core.AdminConsole.Entities.Organization.SetTwoFactorProviders(System.Collections. Generic.Dictionary{Bit.Core.Auth.Enums.TwoFactorProviderType,Bit.Core.Auth.Models. TwoFactorProvider}) to read and write this field.

expiration_date: Option<String>

The date the organization’s license expires. NULL if the license does not expire.

creation_date: Option<String>

The date the organization was created.

revision_date: Option<String>

The date the organization was last updated.

max_autoscale_seats: Option<i32>

The maximum number of seats the organization can autoscale to. NULL if autoscaling is not limited.

owners_notified_of_autoscaling: Option<String>

The date the organization’s owners were last notified that the organization had autoscaled. NULL if owners have not been notified.

status: Option<OrganizationStatusType>

use_password_manager: Option<bool>

If true, the organization has access to the Password Manager product. This is intended for future use if we separate Password Manager from Secrets Manager (and other products). For now, all organizations and users implicitly have access to Password Manager.

sm_seats: Option<i32>

The number of Secrets Manager seats included in the organization’s subscription. NULL if the organization does not have access to Secrets Manager.

sm_service_accounts: Option<i32>

The number of Secrets Manager machine accounts (service accounts) included in the organization’s subscription. NULL if the organization does not have access to Secrets Manager.

max_autoscale_sm_seats: Option<i32>

The maximum number of Secrets Manager seats the organization can autoscale to. NULL if autoscaling is not limited.

max_autoscale_sm_service_accounts: Option<i32>

The maximum number of Secrets Manager machine accounts the organization can autoscale to. NULL if autoscaling is not limited.

limit_collection_creation: Option<bool>

If set to true, only owners, admins, and some custom users can create and delete collections. If set to false, any organization member can create a collection, and any member can delete a collection that they have Can Manage permissions for.

limit_collection_deletion: Option<bool>

If set to true, only owners, admins, and some custom users can delete collections. If set to false, any member can delete a collection that they have Can Manage permissions for.

allow_admin_access_to_all_collection_items: Option<bool>

If set to true, admins, owners, and some custom users can read/write all collections and items in the Admin Console. If set to false, users generally need collection-level permissions to read/write a collection or its items.

limit_item_deletion: Option<bool>

If set to true, members can only delete items when they have a Can Manage permission over the collection. If set to false, members can delete items when they have a Can Manage OR Can Edit permission over the collection.

use_risk_insights: Option<bool>

If true, the organization can use the Risk Insights feature. This is a reporting feature that provides insights into the security of an organization.

use_organization_domains: Option<bool>

If true, the organization can claim domains, which unlocks additional enterprise features.

use_admin_sponsored_families: Option<bool>

If set to true, admins can initiate organization-issued sponsorships.

sync_seats: Option<bool>

If set to true, organization needs their seat count synced with their subscription.

use_automatic_user_confirmation: Option<bool>

If set to true, the organization can use the automatic user confirmation feature. This automatically confirms users in the Accepted state without requiring manual admin intervention. There are significant security risks to this and access is manually controlled by our internal teams.

use_disable_sm_ads_for_users: Option<bool>

If set to true, disables Secrets Manager ads for users in the organization

use_phishing_blocker: Option<bool>

If set to true, the organization can use the phishing blocker feature.

use_my_items: Option<bool>

If set to true, My Items collections will be created automatically when the Organization Data Ownership policy is enabled.

use_invite_links: Option<bool>

If set to true, the organization can generate reusable sharable invite links to invite users to the organization.

exempt_from_billing_automation: Option<bool>

When set to true, the organization is excluded from automated billing lifecycle operations such as subscription cancellation and disabling for non-payment.

Implementations

impl Organization

pub fn new() -> Organization

An organization is an entity that allows users to share vault items and manage billing, access control, and other enterprise features depending on the plan.

Trait Implementations

impl Clone for Organization

fn clone(&self) -> Organization

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Organization

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Organization

fn default() -> Organization

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Organization

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Organization

fn eq(&self, other: &Organization) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Organization

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Organization