flux principals
Principal management commands.
Principal management commands.
Sub-commands
flux principals create— Create a principal.flux principals create-key— Create an API key for a service account principal.flux principals delete— Delete a principal.flux principals disable— Disable a principal.flux principals enable— Enable a principal.flux principals grant— Grant a role to a principal.flux principals list— List all principals.flux principals list-keys— List API keys for a principal.flux principals revoke— Revoke a role from a principal.flux principals revoke-key— Revoke an API key from a principal.flux principals show— Show principal details.
flux principals create
Create a principal.
Arguments
subject(text, required)
Options
--type— (default:Sentinel.UNSET)--role— (default:Sentinel.UNSET)--issuer—--display-name—--format,-f— (default:simple)
flux principals create-key
Create an API key for a service account principal.
Arguments
subject(text, required)
Options
--key-name,-k— (default:Sentinel.UNSET)--expires,-e— Expiry in days, e.g. ‘90d’--issuer—--format,-f— (default:simple)
flux principals delete
Delete a principal.
Arguments
subject(text, required)
Options
--force— Force deletion including cascade effects--yes— Skip confirmation prompt--issuer—--format,-f— (default:simple)
flux principals disable
Disable a principal.
Arguments
subject(text, required)
Options
--issuer—--format,-f— (default:simple)
flux principals enable
Enable a principal.
Arguments
subject(text, required)
Options
--issuer—--format,-f— (default:simple)
flux principals grant
Grant a role to a principal.
Arguments
subject(text, required)
Options
--role— (default:Sentinel.UNSET)--issuer—--format,-f— (default:simple)
flux principals list
List all principals.
Options
--type—--format,-f— (default:simple)
flux principals list-keys
List API keys for a principal.
Arguments
subject(text, required)
Options
--issuer—--format,-f— (default:simple)
flux principals revoke
Revoke a role from a principal.
Arguments
subject(text, required)
Options
--role— (default:Sentinel.UNSET)--issuer—--format,-f— (default:simple)
flux principals revoke-key
Revoke an API key from a principal.
Arguments
subject(text, required)
Options
--key-name,-k— (default:Sentinel.UNSET)--issuer—--format,-f— (default:simple)
flux principals show
Show principal details.
Arguments
subject(text, required)
Options
--issuer— External issuer (defaults to ‘flux’)--format,-f— (default:simple)
Generated from flux/cli.py. Last verified against Flux 0.56.0.