storj.io/minio@v0.0.0-20230509071714-0cbc90f649b1/cmd/config/identity/openid/help.go (about)

     1  /*
     2   * MinIO Cloud Storage, (C) 2019 MinIO, Inc.
     3   *
     4   * Licensed under the Apache License, Version 2.0 (the "License");
     5   * you may not use this file except in compliance with the License.
     6   * You may obtain a copy of the License at
     7   *
     8   *     http://www.apache.org/licenses/LICENSE-2.0
     9   *
    10   * Unless required by applicable law or agreed to in writing, software
    11   * distributed under the License is distributed on an "AS IS" BASIS,
    12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   * See the License for the specific language governing permissions and
    14   * limitations under the License.
    15   */
    16  
    17  package openid
    18  
    19  import "storj.io/minio/cmd/config"
    20  
    21  // Help template for OpenID identity feature.
    22  var (
    23  	Help = config.HelpKVS{
    24  		config.HelpKV{
    25  			Key:         ConfigURL,
    26  			Description: `openid discovery document e.g. "https://accounts.google.com/.well-known/openid-configuration"`,
    27  			Type:        "url",
    28  		},
    29  		config.HelpKV{
    30  			Key:         ClientID,
    31  			Description: `unique public identifier for apps e.g. "292085223830.apps.googleusercontent.com"`,
    32  			Type:        "string",
    33  			Optional:    true,
    34  		},
    35  		config.HelpKV{
    36  			Key:         ClaimName,
    37  			Description: `JWT canned policy claim name, defaults to "policy"`,
    38  			Optional:    true,
    39  			Type:        "string",
    40  		},
    41  		config.HelpKV{
    42  			Key:         ClaimPrefix,
    43  			Description: `JWT claim namespace prefix e.g. "customer1/"`,
    44  			Optional:    true,
    45  			Type:        "string",
    46  		},
    47  		config.HelpKV{
    48  			Key:         Scopes,
    49  			Description: `Comma separated list of OpenID scopes for server, defaults to advertised scopes from discovery document e.g. "email,admin"`,
    50  			Optional:    true,
    51  			Type:        "csv",
    52  		},
    53  		config.HelpKV{
    54  			Key:         config.Comment,
    55  			Description: config.DefaultComment,
    56  			Optional:    true,
    57  			Type:        "sentence",
    58  		},
    59  	}
    60  )