github.com/anth0d/nomad@v0.0.0-20221214183521-ae3a0a2cad06/website/content/docs/commands/acl/auth-method/update.mdx (about)

     1  ---
     2  layout: docs
     3  page_title: 'Commands: acl auth-method update'
     4  description: The auth-method update command is used to update existing ACL Auth Methods.
     5  ---
     6  
     7  # Command: acl auth-method update
     8  
     9  The `acl auth-method update` command is used to update existing ACL Auth Methods.
    10  
    11  ## Usage
    12  
    13  ```plaintext
    14  nomad acl auth-method update [options] <auth-method_name>
    15  ```
    16  
    17  The `acl auth-method update` command requires an existing method's name.
    18  
    19  ## General Options
    20  
    21  @include 'general_options_no_namespace.mdx'
    22  
    23  ## Update Options
    24  
    25  - `-name`: Sets the human-readable name for the ACL Role. It is required and
    26    can contain alphanumeric characters, dashes, and underscores. This name must
    27    be unique and must not exceed 128 characters.
    28  
    29  - `-description`: A free form text description of the role that must not exceed
    30    256 characters.
    31  
    32  - `-policy`: Specifies a policy to associate with the role identified by their
    33    name. This flag can be specified multiple times and must be specified at
    34    least once.
    35  
    36  - `-no-merge`: Do not merge the current role information with what is provided
    37    to the command. Instead, overwrite all fields with the exception of the role
    38    ID which is immutable.
    39  
    40  - `-type`: Updates the type of the auth method. Currently the only supported
    41    type is `OIDC`.
    42  
    43  - `-max-token-ttl`: Updates the duration of time all tokens created by this auth
    44    method should be valid for.
    45  
    46  - `-token-locality`: Updates the kind of token that this auth method should
    47    produce. This can be either `local` or `global`.
    48  
    49  - `-default`: Specifies whether this auth method should be treated as a default
    50    one in case no auth method is explicitly specified for a login command.
    51  
    52  - `-config`: Auth method [configuration] in JSON format. May be prefixed with '@'
    53    to indicate that the value is a file path to load the config from. '-' may also
    54    be given to indicate that the config is available on stdin.
    55  
    56  - `-json`: Output the ACL auth method in a JSON format.
    57  
    58  - `-t`: Format and display the ACL auth method using a Go template.
    59  
    60  ## Examples
    61  
    62  Update an existing ACL auth method:
    63  
    64  ```shell-session
    65  $ nomad acl auth-method update -token-locality "global" -config @config.json example-acl-auth-method
    66  Updated ACL auth method:
    67  Name                   = example-acl-auth-method
    68  Type                   = OIDC
    69  Locality               = global
    70  MaxTokenTTL            = 1h0m0s
    71  Default                = false
    72  OIDC Discovery URL     = https://my-new-corp-app-name.auth0.com/
    73  OIDC Client ID         = V1RPi2MYptMV1RPi2MYptMV1RPi2MYpt
    74  OIDC Client Secret     = example-client-secret
    75  Bound audiences        = V1RPi2MYptMV1RPi2MYptMV1RPi2MYpt
    76  Allowed redirects URIs = http://localhost:4646/oidc/callback
    77  Discovery CA pem       = <none>
    78  Signing algorithms     = <none>
    79  Claim mappings         = {http://example.com/first_name: first_name}; {http://example.com/last_name: last_name}
    80  List claim mappings    = {http://nomad.com/groups: groups}
    81  Create Index           = 14
    82  Modify Index           = 33
    83  ```