Module organization_api

Source

Enums§

CreateOrganizationError
struct for typed errors of method create_organization
DeleteOrganizationError
struct for typed errors of method delete_organization
GetOrganizationError
struct for typed errors of method get_organization
GetOrganizationUsageError
struct for typed errors of method get_organization_usage
GetOrganizationUsersError
struct for typed errors of method get_organization_users
UpdateAllOrgDatasetConfigsError
struct for typed errors of method update_all_org_dataset_configs
UpdateOrganizationError
struct for typed errors of method update_organization

Functions§

create_organization
Create a new organization. The auth’ed user who creates the organization will be the default owner of the organization.
delete_organization
Delete an organization by its id. The auth’ed user must be an owner of the organization to delete it.
get_organization
Fetch the details of an organization by its id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
get_organization_usage
Fetch the current usage specification of an organization by its id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
get_organization_users
Fetch the users of an organization by its id. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.
update_all_org_dataset_configs
Update the configurations for all datasets in an organization. Only the specified keys in the configuration object will be changed per dataset such that you can preserve dataset unique values. Auth’ed user or api key must have an owner role for the specified organization.
update_organization
Update an organization. Only the owner of the organization can update it.