Organizations API.¶

The DeepOriginClient can be used to access the organizations API using:

from deeporigin.platform.client import DeepOriginClient

client = DeepOriginClient()

Then, the following methods can be used, for example:

# List all organizations accessible to the authenticated user
orgs = client.organizations.list()

# List users in the current organization
users = client.organizations.users()

src.platform.organizations.Organizations ¶

Organizations API wrapper.

Provides access to organizations-related endpoints through the DeepOriginClient.

Functions¶

list ¶

list() -> list[dict]

List all organizations accessible to the authenticated user.

Returns:

Type	Description
`list[dict]`	List of organization dictionaries, each containing fields like id,
`list[dict]`	orgKey, name, mfaEnabled, threshold, autoApproveMaxAmount, status,
`list[dict]`	createdAt, updatedAt, invites, roles, etc.

users ¶

users() -> list[dict]

List all users associated with the organization.

Returns:

Type	Description
`list[dict]`	List of user dictionaries, each containing fields like id, email,
`list[dict]`	firstName, lastName, authId, avatar, createdAt, updatedAt, etc.