Skip to main content
  1. Docs
  2. pulumi org role edit | CLI commands

pulumi org role edit | CLI commands

Generated for Pulumi CLI v3.245.0.

    [EXPERIMENTAL] Update a custom role’s name, description, or permissions

    Synopsis

    [EXPERIMENTAL] Update a custom role’s name, description, or permissions.

    Each field follows ternary semantics: a flag that is not passed leaves the current value unchanged.

    –details-file replaces the role’s permission tree. Pass - to read from stdin. Both –output default and –output json print the updated role.

    pulumi org role edit <role-id> [flags]
    

    Examples

      # Rename a role and tweak its description
      pulumi org role edit role-123 --name auditor --description "Read-only auditor"
    
      # Replace a role's permission tree from a file
      pulumi org role edit role-123 --details-file ./updated.json
    

    Options

          --description string   Update the role's description
          --details-file -       Path to a JSON file containing the role's new permission tree (use - for stdin)
      -h, --help                 help for edit
          --name string          Rename the role
          --org string           The organization that owns the role. Defaults to the current default organization
          --output string        Output format. Supported values are: default and json (default "default")
    

    Options inherited from parent commands

          --color string                 Colorize output. Choices are: always, never, raw, auto (default "auto")
      -C, --cwd string                   Run pulumi as if it had been started in another directory
          --disable-integrity-checking   Disable integrity checking of checkpoint files
      -e, --emoji                        Enable emojis in the output
      -Q, --fully-qualify-stack-names    Show fully-qualified stack names
          --logflow                      Flow log settings to child processes (like plugins)
          --logtostderr                  Log to stderr instead of to files
          --memprofilerate int           Enable more precise (and expensive) memory allocation profiles by setting runtime.MemProfileRate
          --non-interactive              Disable interactive mode for all commands
          --otel-traces string           Export OpenTelemetry traces to the specified endpoint. Use file:// for local JSON files, grpc:// for remote collectors
          --profiling string             Emit CPU and memory profiles and an execution trace to '[filename].[pid].{cpu,mem,trace}', respectively
          --tracing file:                Emit tracing to the specified endpoint. Use the file: scheme to write tracing data to a local file
      -v, --verbose int                  Enable verbose logging (e.g., v=3); anything >3 is very verbose
    

    SEE ALSO