Skip to Content
Fuzzball Entity ManagementOrganization ManagementOverview

Organization Management

After Fuzzball has been deployed on your system, you will first need to create an organization before you are able to add Fuzzball users.

Note

Local organization (v3.3.0+): Fuzzball now supports a built-in local organization that does not require Keycloak. When deploying with the local organization feature, the initial organization and its root administrator are created automatically as part of the bootstrap process — no manual organization creation step is required. See your deployment's initial configuration output for the admin credentials.

For on-premises deployments backed by Keycloak, organization creation uses the fuzzball-admin CLI. The fuzzball-admin CLI can be accessed in the fuzzball-admin-0 pod which is running on the server node as part of Fuzzball Orchestrate.

Warning

The fuzzball-admin pod-based interface is the legacy approach for on-premises Keycloak-backed deployments. New deployments should prefer the local organization feature described above, which removes the dependency on Keycloak for identity management.

The command below shows all the fuzzball-admin subcommands which can be run.

$ kubectl exec -n fuzzball fuzzball-admin-0 -- /app/fuzzball-admin --help
This CLI allows you to interface with internal fuzzball service endpoints directly via a preexisting port-forward.

Usage:
  fuzzball-admin [command]

Available Commands:
  audit        Manage audit data
  completion   Generate the autocompletion script for the specified shell
  help         Help about any command
  organization Manage organization
  provision    Mangage the provision service
  schedule     Mangage the scheduler

Flags:
  -h, --help   help for fuzzball-admin

Use "fuzzball-admin [command] --help" for more information about a command.

The next section will focus on the fuzzball-admin subcommand organization which will be used to create your organization.

Listing Organization Members

You can list members of an organization using the fuzzball organization member list command.

Filtering by Role

The --owner flag controls filtering by member role:

# List all members (owners and non-owners)
$ fuzzball organization member list <org-name>

# List only owners
$ fuzzball organization member list <org-name> --owner

# List only non-owners
$ fuzzball organization member list <org-name> --owner=false
Note

Default behavior: When no flag is provided, the command lists all members (both owners and non-owners).

Deprecated Flag

The --relationship flag is deprecated in favor of --owner. If you have scripts using the old flag, update them to use the new syntax:

Old syntaxNew syntax
--relationship=all(omit flag)
--relationship=owner--owner
--relationship=member--owner=false
Warning

The --relationship flag will be removed in a future release. Update your scripts to use --owner.

OverviewCreating Organizations