UpdateParameterGroup
処理概要
指定したパラメーターグループの設定を更新します。
リクエストボディパラメーターのいずれか(changedParameterGroupName,description,parameters)は指定必須です。
更新後はインスタンスが再起動します。
リクエストURL
PUT /v1/parameterGroups/{ParameterGroupName}指定するパラメーター
パスパラメーター
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| ParameterGroupName | string |
パラメーターグループ名 |
○ |
リクエストボディ
| パラメーター | 型 | 説明 | 必須 |
|---|---|---|---|
| changedParameterGroupName | string |
パラメータ名 使用可能文字: 63文字以内の半角英数小文字と-ハイフンが利用可能(先頭と末尾の-は禁止) |
|
| description | string |
メモ 使用可能文字: 255文字以内の全角半角 |
|
| parameters | object |
|
|
| ␣smtp_user_name | string |
ニフクラESSのSMTPユーザー名を指定します。システムデフォルトのESSを使用する場合はsmtp_user_nameとsmtp_passwordを空に設定してください。 使用可能文字: 空文字の設定可能、最大文字数は50文字 |
|
| ␣smtp_password | string |
ニフクラESSのSMTP パスワード名を指定します。システムデフォルトのESSを使用する場合はsmtp_user_nameとsmtp_passwordを空に設定してください。 使用可能文字: 空文字の設定可能、最大文字数は50文字 |
|
| ␣gitlab_email_from | string |
ニフクラESSの認証済みメールアドレスを入力します。DevOpsサーバーから送信されるメールのFromをカスタマイズすることができます。 使用可能文字: 空文字の設定可能、最大文字数は320文字 |
|
| ␣gitlab_email_reply_to | string |
ニフクラESSの認証済みメールアドレスを入力します。DevOpsサーバーから送信されるメールのReply-Toをカスタマイズすることができます。 使用可能文字: 空文字の設定可能、最大文字数は320文字 |
|
| ␣omniauth_allow_single_sign_on | string |
SAML認証を有効にする場合は「saml」を指定します。SAML認証を無効にする場合は空文字を設定してください。 使用可能文字: CSV形式、空文字、saml |
|
| ␣omniauth_auto_sign_in_with_provider | string |
Gitlabのログイン画面を表示した際に自動でSAML認証画面に遷移します。自動で遷移させる場合には「saml」を指定します。 使用可能文字: 空文字の設定可能、saml |
|
| ␣omniauth_block_auto_created_users | string |
SAML認証でログインに成功した場合にGitlab側に自動でユーザを作成するのを防ぐことができます。自動でユーザを登録しても良い場合には「false」を設定します。 Default: false 使用可能文字: 空文字の設定可能、true, false |
|
| ␣omniauth_auto_link_saml_user | string |
SAML認証でログインに成功した場合にGitlab側に存在する既存ユーザと自動的にリンクすることができます。自動でユーザをリンクさせない場合には「false」を設定します。 Default: false 使用可能文字: 空文字の設定可能、true, false |
|
| ␣omniauth_providers_saml_name | string |
「saml」を指定します。 使用可能文字: 空文字の設定可能、saml |
|
| ␣omniauth_providers_saml_label | string |
Gitlabのログイン画面に表示されるSAML認証ボタンのラベル名を設定します。 使用可能文字: 空文字の設定可能、最大文字数は20文字 |
|
| ␣omniauth_providers_saml_assertion_consumer_service_url | string |
SAML認証を使用するアクセス元のURLを設定します。この値はDevOpsサーバーのURLに/users/auth/saml/callbackを付与したURLを設定します。 使用可能文字: 空文字の設定可能、最大文字数は100文字 |
|
| ␣omniauth_providers_saml_idp_cert_fingerprint | string |
IdPが発行するフィンガープリントを設定します。 使用可能文字: 空文字の設定可能、最大文字数は60文字 |
|
| ␣omniauth_providers_saml_idp_sso_target_url | string |
IdPが発行するSAML連携時のログインURLを設定します。 使用可能文字: 空文字の設定可能、最大文字数は100文字 |
|
| ␣omniauth_providers_saml_issuer | string |
SAML認証を使用するアクセス元のURLを設定します。この値はDevOpsサーバーのURLを設定します。 使用可能文字: 空文字の設定可能、最大文字数は100文字 |
|
| ␣omniauth_providers_saml_name_identifier_format | string |
IdPが発行するユーザ名を識別するための識別子を設定します。 使用可能文字: 空文字の設定可能、最大文字数は100文字 |
|
| ␣omniauth_providers_saml_groups_attribute | string |
SAMLログイン成功時にユーザに付与されるグループ属性を特定するためのキー情報を設定します。IdP側で設定した属性名と合わせる必要があります。 使用可能文字: 空文字の設定可能、最大文字数は20文字 |
|
| ␣omniauth_providers_saml_required_groups | string |
SAMLログイン成功時にユーザが所属していなければいけないグループを指定します。複数のグループをCSVで記載できます。 使用可能文字: CSV形式、空文字の設定可能、最大文字数は50文字 |
|
| ␣omniauth_providers_saml_external_groups | string |
SAMLログイン成功時にユーザがこのグループに所蔵していると自動的に外部ユーザとして登録されます。複数のグループをCSVで記載できます。 使用可能文字: CSV形式、空文字の設定可能、最大文字数は30文字 |
|
| ␣omniauth_providers_saml_admin_groups | string |
SAMLログイン成功時にユーザがこのグループに所蔵していると自動的に管理ユーザとして登録されます。複数のグループをCSVで記載できます。 使用可能文字: CSV形式、空文字の設定可能、最大文字数は30文字 |
|
| ␣omniauth_providers_saml_auditor_groups | string |
SAMLログイン成功時にユーザがこのグループに所蔵していると自動的に読み込み専用ユーザとして登録されます。複数のグループをCSVで記載できます。 使用可能文字: CSV形式、空文字の設定可能、最大文字数は30文字 |
|
| ␣ldap_enabled | string |
全体にLDAP認証を有効にする場合は「true」を指定します。全体にLDAP認証を無効にする場合は「false」を設定してください。 Default: false 使用可能文字: 空文字の設定可能、true, false |
|
| ␣ldap_servers_name | string |
連携先LDAPを一意に識別する名前を設定します。LDAP認証を個別に無効にする場合は空文字を設定してください。 使用可能文字: 空文字の設定可能、最大文字数は20文字 |
|
| ␣ldap_servers_label | string |
Gitlabのログイン画面に表示されるLDAP認証のラベル名を設定します。 使用可能文字: 空文字の設定可能、最大文字数は20文字 |
|
| ␣ldap_servers_host | string |
連携先LDAPサーバのホスト名またIPアドレスを指定します。 使用可能文字: 空文字の設定可能、最大文字数は255文字 |
|
| ␣ldap_servers_port | string |
連携先LDAPサーバのポート番号を指定します。 使用可能文字: 空文字の設定可能、0-65535 |
|
| ␣ldap_servers_uid | string |
サインインに使用するユーザー名にマップされるLDAP属性を指定します。 使用可能文字: 空文字の設定可能、最大文字数は30文字 |
|
| ␣ldap_servers_encryption | string |
暗号化方式を指定します。start_tlsやsimple_tlsを指定します。 使用可能文字: 空文字の設定可能、start_tls, simple_tls, plain |
|
| ␣ldap_servers_verify_certificates | string |
SSL 証明書の検証を有効にするかどうか指定します。falseに設定すると、LDAPサーバーのSSL証明書の検証は実行されません。 Default: false 使用可能文字: 空文字の設定可能、true, false |
|
| ␣ldap_servers_bind_dn | string |
バインドするユーザのフルDN名を指定します。 使用可能文字: 空文字の設定可能、最大文字数は100文字 |
|
| ␣ldap_servers_password | string |
連携先LDAPサーバのパスワードを指定します。 使用可能文字: 空文字の設定可能、最大文字数は50文字 |
|
| ␣ldap_servers_timeout | string |
連携先LDAPサーバと接続確認をするタイムアウト時間(秒)を指定します。 使用可能文字: 空文字の設定可能、0-3600 |
|
| ␣ldap_servers_active_directory | string |
連携先LDAPサーバがActiveDirectoryの場合はtrueを指定します。 Default: false 使用可能文字: 空文字の設定可能、true, false |
|
| ␣ldap_servers_allow_username_or_email_login | string |
trueを設定するとサインイン時に送信されたLDAPユーザー名の最初のアットマーク以後の値をすべてを無視します。 Default: false 使用可能文字: 空文字の設定可能、true, false |
|
| ␣ldap_servers_block_auto_created_users | string |
trueを設定した場合は新規で作成されたユーザは管理者が許可するまでログインできません。 Default: false 使用可能文字: 空文字の設定可能、true, false |
|
| ␣ldap_servers_base | string |
ユーザを検索するベースDN名を指定します。 使用可能文字: 空文字の設定可能、最大文字数は100文字 |
|
| ␣ldap_servers_user_filter | string |
LDAPユーザをフィルタすることができます。フォーマットはRFC4515です。 使用可能文字: 空文字の設定可能、最大文字数は200文字 |
|
| ␣ldap_servers_lowercase_usernames | string |
trueを設定するとGitLabは名前を小文字に変換します。 Default: false 使用可能文字: 空文字の設定可能、true, false |
|
| ␣ldap_servers_attributes_username | string |
Gitlabで使用されるユーザ名のLDAP属性を指定します。 使用可能文字: 空文字の設定可能、最大文字数は50文字 |
|
| ␣ldap_servers_attributes_email | string |
Gitlabで使用されるユーザ名のメールアドレスのLDAP属性を指定します。 使用可能文字: 空文字の設定可能、最大文字数は50文字 |
|
| ␣ldap_servers_attributes_name | string |
Gitlabで表示されるユーザ名のLDAP属性を指定します。 使用可能文字: 空文字の設定可能、最大文字数は20文字 |
|
| ␣ldap_servers_attributes_first_name | string |
Gitlabで表示されるユーザのファーストネームのLDAP属性を指定します。name属性が存在しない場合に使われます。 使用可能文字: 空文字の設定可能、最大文字数は20文字 |
|
| ␣ldap_servers_attributes_last_name | string |
Gitlabで表示されるユーザのラストネームのLDAP属性を指定します。name属性が存在しない場合に使われます。 使用可能文字: 空文字の設定可能、最大文字数は20文字 |
応答フィールド
| フィールド (項目) | 型 | 説明 |
|---|---|---|
| parameterGroup | object |
|
| ␣region | string |
パラメーターグループが稼働しているリージョン名 |
| ␣description | string |
メモ |
| ␣parameterGroupName | string |
パラメーターグループ名 |
| ␣instanceId | string |
パラメーターグループが適用されたDevOpsサーバー名 |
| ␣parameters[] | object[] |
|
| ␣␣allowed_values | string[] |
パラメーター値として許容する文字列のリスト |
| ␣␣data_type | string |
パラメーター値のデータ型 |
| ␣␣description | string |
メモ |
| ␣␣is_modifiable | boolean |
パラメーター値の変更可否 値:
|
| ␣␣is_secret | boolean |
パラメーター値の表示可否 値:
|
| ␣␣name | string |
パラメーター名 |
| ␣␣value | string |
パラメーター値 |
リクエストサンプル
curl -XPUT https://jp-east-1.devops.api.nifcloud.com/v1/parameterGroups/gitlab1pg
-H 'X-Amz-Date: 20230401T000000Z'
-H 'Authorization: AWS4-HMAC-SHA256 ...'
-H 'content-type:application/json'
-d '
{
"changedParameterGroupName":"gitlab1pg",
"description":"production_pg",
"parameters":{
"smtp_user_name":"user1",
"smtp_password":"xxxx",
"gitlab_email_from":"a@b",
"gitlab_email_reply_to":"c@d",
"omniauth_allow_single_sign_on":"saml",
"omniauth_auto_sign_in_with_provider":"saml",
"omniauth_block_auto_created_users":"true",
"omniauth_auto_link_saml_user":"false",
"omniauth_providers_saml_name":"saml",
"omniauth_providers_saml_label":"TestSAML",
"omniauth_providers_saml_assertion_consumer_service_url":"https://saml.assertion.consumer.service.url",
"omniauth_providers_saml_idp_cert_fingerprint":"ab:ce:ef:gh:ij:kl:mn:op:qr:st:uv:wx:yz",
"omniauth_providers_saml_idp_sso_target_url":"https://saml.idp.sso.target.url",
"omniauth_providers_saml_issuer":"issuer",
"omniauth_providers_saml_name_identifier_format":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
"omniauth_providers_saml_groups_attribute":"groups",
"omniauth_providers_saml_required_groups":"a_group,b_group,c_group,d_group",
"omniauth_providers_saml_external_groups":"a_group",
"omniauth_providers_saml_admin_groups":"b_group",
"omniauth_providers_saml_auditor_groups":"c_group",
"ldap_enabled":"true",
"ldap_servers_name":"main",
"ldap_servers_label":"Login",
"ldap_servers_host":"ldap.server.com",
"ldap_servers_port":"389",
"ldap_servers_uid":"uid",
"ldap_servers_encryption":"start_tls",
"ldap_servers_verify_certificates":"true",
"ldap_servers_bind_dn":"cn=admin,dc=my-company,dc=com",
"ldap_servers_password":"ldappassword",
"ldap_servers_timeout":"10",
"ldap_servers_active_directory":"true",
"ldap_servers_allow_username_or_email_login":"true",
"ldap_servers_block_auto_created_users":"true",
"ldap_servers_base":"dc=my-company,dc=com",
"ldap_servers_user_filter":"(employeeType=developer)",
"ldap_servers_lowercase_usernames":"true",
"ldap_servers_attributes_username":"uid,userid,sAMAccountName",
"ldap_servers_attributes_email":"mail,email,userPrincipalName",
"ldap_servers_attributes_name":"displayName",
"ldap_servers_attributes_first_name":"givenName",
"ldap_servers_attributes_last_name":"sn"
}
}'
応答サンプル
{
"parameterGroup":{
"region":"jp-east-1",
"description":"production_pg",
"parameterGroupName":"gitlab1pg",
"instanceId":"gitlab1",
"parameters":[
{
"allowed_values":[],
"data_type":"string",
"description":"SMTP server password.",
"is_modifiable":true,
"is_secret":true,
"name":"smtp_password",
"value":"********"
},
{
"allowed_values":[],
"data_type":"string",
"description":"SMTP server username.",
"is_modifiable":true,
"is_secret":false,
"name":"smtp_user_name",
"value":"user1"
},
{
"allowed_values":[],
"data_type":"string",
"description":"From address of mail sent from SMTP server.",
"is_modifiable":true,
"is_secret":false,
"name":"gitlab_email_from",
"value":"from@mail.com"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Reply-To address of mail sent from SMTP server.",
"is_modifiable":true,
"is_secret":false,
"name":"gitlab_email_reply_to",
"value":"reply-to@mail.com"
},
{
"allowed_values":[
"saml"
],
"data_type":"string",
"description":"List of authentication providers.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_allow_single_sign_on",
"value":"saml"
},
{
"allowed_values":[
"saml"
],
"data_type":"string",
"description":"Calls the authentication provider automatically when the page is refreshed.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_auto_sign_in_with_provider",
"value":"saml"
},
{
"allowed_values":[
"true",
"false"
],
"data_type":"string",
"description":"If false, user accounts will be created automatically when authentication was successful.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_block_auto_created_users",
"value":"true"
},
{
"allowed_values":[
"true",
"false"
],
"data_type":"string",
"description":"If true, automatically link SAML users with existing GitLab users.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_auto_link_saml_user",
"value":"false"
},
{
"allowed_values":[
"saml"
],
"data_type":"string",
"description":"Set 'saml' when using the saml provider.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_name",
"value":"saml"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Label name displayed on the login button.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_label",
"value":"TestSAML"
},
{
"allowed_values":[],
"data_type":"string",
"description":"HTTPS endpoint of GitLab (append users/auth/saml/callback to the HTTPS URL of your GitLab installation to generate the correct value).",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_assertion_consumer_service_url",
"value":"https://saml.assertion.consumer.service.url"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Fingerprint of saml certificate on IdP.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_idp_cert_fingerprint",
"value":"ab:ce:ef:gh:ij:kl:mn:op:qr:st:uv:wx:yz"
},
{
"allowed_values":[],
"data_type":"string",
"description":"URL for single sign-on provided by IdP.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_idp_sso_target_url",
"value":"https://saml.idp.sso.target.url"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Unique name which identifies the application to the IdP.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_issuer",
"value":"issuer"
},
{
"allowed_values":[],
"data_type":"string",
"description":"SAML NameID Format ex) urn:oasis:names:tc:SAML:2.0:nameid-format:persistent",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_name_identifier_format",
"value":"urn:oasis:names:tc:SAML:2.0:nameid-format:persistent"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Attribute name to identify the group information contained in the SAML response.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_groups_attribute",
"value":"groups"
},
{
"allowed_values":[],
"data_type":"string",
"description":"User must belong to one of the specified groups.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_required_groups",
"value":"a_group,b_group,c_group,d_group"
},
{
"allowed_values":[],
"data_type":"string",
"description":"User belonging to the specified group will be registered as external user.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_external_groups",
"value":"a_group"
},
{
"allowed_values":[],
"data_type":"string",
"description":"User belonging to the specified group will be registered as administrator.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_admin_groups",
"value":"b_group"
},
{
"allowed_values":[],
"data_type":"string",
"description":"User belonging to the specified group will be registered as readonly user.",
"is_modifiable":true,
"is_secret":false,
"name":"omniauth_providers_saml_auditor_groups",
"value":"c_group"
},
{
"allowed_values":[
"true",
"false"
],
"data_type":"string",
"description":"If true, enable LDAP integration.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_enabled",
"value":"true"
},
{
"allowed_values":[],
"data_type":"string",
"description":"The name of ldap server (ex: main, secondary).",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_name",
"value":"main"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Label name displayed on the ldap login button (max 20 characters).",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_label",
"value":"Login"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Ldap server's hostname or IP address.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_host",
"value":"ldap.server.com"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Ldap server's port.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_port",
"value":"389"
},
{
"allowed_values":[],
"data_type":"string",
"description":"The LDAP attribute that maps to the username that users use to sign in.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_uid",
"value":"uid"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Encryption method. The method key is deprecated in favor of encryption.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_encryption",
"value":"start_tls"
},
{
"allowed_values":[
"true",
"false"
],
"data_type":"string",
"description":"Enables SSL certificate verification if encryption method is start_tls or simple_tls. If set to false, no validation of the LDAP server’s SSL certificate is performed.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_verify_certificates",
"value":"true"
},
{
"allowed_values":[],
"data_type":"string",
"description":"The full DN of the user you bind with.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_bind_dn",
"value":"cn=admin,dc=my-company,dc=com"
},
{
"allowed_values":[],
"data_type":"string",
"description":"The password of the bind user.",
"is_modifiable":true,
"is_secret":true,
"name":"ldap_servers_password",
"value":"********"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Set a timeout, in seconds, for LDAP queries.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_timeout",
"value":"10"
},
{
"allowed_values":[
"true",
"false"
],
"data_type":"string",
"description":"This setting specifies if LDAP server is Active Directory LDAP server.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_active_directory",
"value":"true"
},
{
"allowed_values":[
"true",
"false"
],
"data_type":"string",
"description":"If enabled, GitLab ignores everything after the first @ in the LDAP username submitted by the user on sign-in.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_allow_username_or_email_login",
"value":"true"
},
{
"allowed_values":[
"true",
"false"
],
"data_type":"string",
"description":"To maintain tight control over the number of billable users on your GitLab installation, enable this setting to keep new users blocked until they have been cleared by an administrator.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_block_auto_created_users",
"value":"true"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Base where we can search for users.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_base",
"value":"dc=my-company,dc=com"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Filter LDAP users. (Format: RFC 4515)",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_user_filter",
"value":"(employeeType=developer)"
},
{
"allowed_values":[
"true",
"false"
],
"data_type":"string",
"description":"If enabled, GitLab converts the name to lower case.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_lowercase_usernames",
"value":"true"
},
{
"allowed_values":[],
"data_type":"string",
"description":"Used in paths for the user’s own projects and when mentioning them in issues, merge request and comments.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_attributes_username",
"value":"uid,userid,sAMAccountName"
},
{
"allowed_values":[],
"data_type":"string",
"description":"LDAP attribute for user email.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_attributes_email",
"value":"mail,email,userPrincipalName"
},
{
"allowed_values":[],
"data_type":"string",
"description":"LDAP attribute for user display name.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_attributes_name",
"value":"displayName"
},
{
"allowed_values":[],
"data_type":"string",
"description":"LDAP attribute for user first name.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_attributes_first_name",
"value":"givenName"
},
{
"allowed_values":[],
"data_type":"string",
"description":"LDAP attribute for user last name.",
"is_modifiable":true,
"is_secret":false,
"name":"ldap_servers_attributes_last_name",
"value":"sn"
}
]
}
}
