Organizations - MindBridge Documentation

Organizations represent each business/client/company/entity that you analyze with MindBridge. Organizations house all of your client’s engagements (audit/analysis), account mappings, and any other data imported into MindBridge for that client. See Get Started for how to use the Python SDK with a Server.

Create a new organization

As in the web application, you can create a new organization using the Python SDK.

organization = mbapi.OrganizationItem(name="The Organization Name")  # (1)!
organization = server.organizations.create(organization)  # (2)!
print(f"{organization.id=}\n{organization.name=}")
#> organization.id='6793acbf7bd84f04412b114e'
#> organization.name='The Organization Name'

It is assumed you have imported the module with import mindbridgeapi as mbapi.
See Get Started for how to create the server.

The organization is now created in the web application, and the create action returns information about the created organization, including its id.

Retrieving an organization by ID

You can retrieve an existing organization by id. The example below uses the id of the organization you created above.

organization = server.organizations.get_by_id("6793acbf7bd84f04412b114e")
print(f"{organization.id=}\n{organization.name=}")
#> organization.id='6793acbf7bd84f04412b114e'
#> organization.name='The Organization Name'

Querying organizations

Query organizations, optionally applying a filter. Organizations can be searched using the MindBridge Query Language, as described in the MindBridge API Reference. The get function returns a generator, allowing you to iterate over search results or use the next() function.

try:
    organization = next(server.organizations.get({"name": "The Organization Name"}))
    print(f"{organization.id=}\n{organization.name=}")
except StopIteration:
    print("No matching organization found.")

⌘I