本文へジャンプします。

ニフクラ ユーザーガイド

ニフクラ DevOps with GitLab:パラメーター

パラメーターを利用すれば、DevOpsサーバーへのアクセスを制御できます。

パラメーターグループ

パラメーターグループは、リージョン単位で作成します。
パラメーターグループのリージョンと、DevOpsサーバーのリージョンが一致する場合のみ、そのパラメーターグループをDevOpsサーバーに適用できます。
パラメーター変更時パラメーターが適用されているDevOpsサーバーは再起動されます。
パラメーターはDevOpsサーバー1台につき1つのパラメーターのみ適用できます。
作成済みのDevOpsサーバーに対してパラメーターの付替えはできません。

パラメーターのデフォルト値

パラメーターグループを新規で作成した場合すべての項目のパラメーターは空で作成されます。
すべての値が空で作成されたパラメーターグループをDevOpsサーバーに適用した場合、DevOpsサーバーはカスタマイズされずシステムデフォルトの仕様が適用されます。

設定可能なパラメーターの一覧

パラメーターグループで指定可能なパラメーター名と値は以下の表の通りです。

カスタムESS設定

DevOpsサーバーから送信されるメールのFromやReply-toをカスタマイズ可能なパラメーターです。

パラメーター名
smtp_user_name ニフクラESSのSMTPユーザー名を指定します。システムデフォルトのESSを使用する場合はsmtp_user_nameとsmtp_passwordを空に設定してください。最大文字数は50文字です。
smtp_password ニフクラESSのSMTP パスワード名を指定します。システムデフォルトのESSを使用する場合はsmtp_user_nameとsmtp_passwordを空に設定してください。最大文字数は50文字です。
gitlab_email_from ニフクラESSの認証済みメールアドレスを入力します。DevOpsサーバーから送信されるメールのFromをカスタマイズすることができます。最大文字数は320文字です。
gitlab_email_reply_to ニフクラESSの認証済みメールアドレスを入力します。DevOpsサーバーから送信されるメールのReply-Toをカスタマイズすることができます。最大文字数は320文字です。

サンプルリクエスト

{
  "smtp_user_name": "your_ess_smtp_user",
  "smtp_password": "your_ess_smtp_password",
  "gitlab_email_from": "admin@example.com",
  "gitlab_email_reply_to": "no-reply@example.com"
}
SAML認証連携

DevOpsサーバーのログインにSAML認証を追加することができるパラメーターです。

パラメーター名
omniauth_allow_single_sign_on SAML認証を有効にする場合は「saml」を指定します。SAML認証を無効にする場合は空文字を設定してください。
omniauth_auto_sign_in_with_provider Gitlabのログイン画面を表示した際に自動でSAML認証画面に遷移します。自動で遷移させる場合には「saml」を指定します。
omniauth_block_auto_created_users SAML認証でログインに成功した場合にGitlab側に自動でユーザを作成するのを防ぐことができます。自動でユーザを登録しても良い場合には「false」を設定します。
omniauth_auto_link_saml_user SAML認証でログインに成功した場合にGitlab側に存在する既存ユーザと自動的にリンクすることができます。自動でユーザをリンクさせない場合には「false」を設定します。
omniauth_providers_saml_name 「saml」を指定します。
omniauth_providers_saml_label Gitlabのログイン画面に表示されるSAML認証ボタンのラベル名を設定します。最大文字数は20文字です。
omniauth_providers_saml_assertion_consumer_service_url SAML認証を使用するアクセス元のURLを設定します。この値はDevOpsサーバーのURLに/users/auth/saml/callbackを付与したURLを設定します。最大文字数は100文字です。
omniauth_providers_saml_idp_cert_fingerprint IdPが発行するフィンガープリントを設定します。最大文字数は60文字です。
omniauth_providers_saml_idp_sso_target_url IdPが発行するSAML連携時のログインURLを設定します。最大文字数は100文字です。
omniauth_providers_saml_issuer SAML認証を使用するアクセス元のURLを設定します。この値はDevOpsサーバーのURLを設定します。最大文字数は100文字です。
omniauth_providers_saml_name_identifier_format IdPが発行するユーザ名を識別するための識別子を設定します。最大文字数は100文字です。
omniauth_providers_saml_groups_attribute SAMLログイン成功時にユーザに付与されるグループ属性を特定するためのキー情報を設定します。IdP側で設定した属性名と合わせる必要があります。最大文字数は20文字です。
omniauth_providers_saml_required_groups SAMLログイン成功時にユーザが所属していなければいけないグループを指定します。複数のグループをCSVで記載できます。最大文字数は50文字です。
omniauth_providers_saml_external_groups SAMLログイン成功時にユーザがこのグループに所蔵していると自動的に外部ユーザとして登録されます。複数のグループをCSVで記載できます。最大文字数は30文字です。
omniauth_providers_saml_admin_groups SAMLログイン成功時にユーザがこのグループに所蔵していると自動的に管理ユーザとして登録されます。複数のグループをCSVで記載できます。最大文字数は30文字です。
omniauth_providers_saml_auditor_groups SAMLログイン成功時にユーザがこのグループに所蔵していると自動的に読み込み専用ユーザとして登録されます。複数のグループをCSVで記載できます。最大文字数は30文字です。

サンプルリクエスト

{
  "omniauth_allow_single_sign_on": "saml",
  "omniauth_auto_sign_in_with_provider": "",
  "omniauth_block_auto_created_users": "false",
  "omniauth_auto_link_saml_user": "true",
  "omniauth_providers_saml_name": "saml",
  "omniauth_providers_saml_label": "Login",
  "omniauth_providers_saml_assertion_consumer_service_url": "https://test01.jp-east-1.gitlab.devops.nifcloud.com/users/auth/saml/callback",
  "omniauth_providers_saml_idp_cert_fingerprint": "xx:xx:xx:xx:xx:xx:xx:xx",
  "omniauth_providers_saml_idp_sso_target_url": "https://login.microsoftonline.com/xxxx/saml2",
  "omniauth_providers_saml_issuer": "https://test01.jp-east-1.gitlab.devops.nifcloud.com",
  "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": "Developers,Freelancers,Admins,Auditors",
  "omniauth_providers_saml_external_groups": "Freelancers",
  "omniauth_providers_saml_admin_groups": "Admins",
  "omniauth_providers_saml_auditor_groups": "Auditors"
}
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2023年2月08日時点の情報です。

推奨画面サイズ 1024×768 以上