YAMLの記述方法について

キーと値の記述

パラメータの記載は、以下のように行います。

パラメータ名

説明

設定例

iid scim attribute user default

preferredLanguage

言語

ja-JP

iid:
  scim:
    attribute:
      user:
        default:
          preferredLanguage:  'ja-JP'

パラメータ名はハッシュのキーとなります。入力する値を、キーに対する値として記述してください。

上位のキーが同一のものを複数記載するケースでは、以下のようにキーをまとめて記述してください。

パラメータ名

説明

設定例

iid




 scim




 attribute




 user




 default




preferredLanguage

言語

ja-JP

timezone

タイムゾーン

Asia/Tokyo

正しい記述例)

iid:
  scim:
    attribute:
      user:
        default:
          preferredLanguage:  'ja-JP'
          timezone:           'Asia/Tokyo'

誤った記述例)

以下のケースは、「preferredLanguage」と「timezone」のキーの階層がずれているためエラーになります。

iid:
  scim:
    attribute:
      user:
        default:
          preferredLanguage:  'ja-JP'
           timezone:           'Asia/Tokyo'  # "timezone"の前のスペースが1つ多いため、エラーになる


配列の指定

同一パラメータに配列の記述が必要なパラメータが存在します。

配列の指定は「-(ハイフン)」を利用して記述することができます。この場合、配列の要素はキーの次の行に記載します。

パラメータ名

説明

設定例

iid scim attribute user convert

externalUserName

外部 ID プロバイダでのユーザ名

例)末尾に「"@" + (AD ドメイン名)」を追加します

- pattern: '\z'
  replacement: '@example.jp'

正しい記述例)

iid:
  scim:
    attribute:
      user:
        convert:
          externalUserName:
            - pattern:     '@example.com' # キーの行を改行してから配列の要素を記述する
              replacement: '@example.jp'

誤った記述例)

iid:
  scim:
    attribute:
      user:
        convert:
          externalUserName: - pattern:     '@example.com' # キーと同じ行に配列の要素を指定しているためエラーとなる
                              replacement: '@example.jp'


複数パラメータの指定

同一パラメータに複数の配列が指定できるパラメータが存在します。

複数のパラメータを指定した場合、記載順と記載個数を揃える必要があります。

値の設定をスキップしたい場合は、値に"null"を指定してください。

パラメータ名

説明

iidscimattributeuser

default


ims
(最大10個までの配列指定)

display

インスタンスメッセンジャーの表示名

primary

このインスタンスメッセンジャーがプライマリかどうか(デフォルト値)

excludeims

(最大10個までの配列指定)

value除外するインスタンスメッセンジャーのIDなど

正しい記述例1)

iid:
  scim:
   attribute:
      user:
        default:
          ims:                                    # default で ims.primary を3つ指定
            - primary:            true
            - primary:            false
            - primary:            false
        ad_bind:                                  # ad_bind で ims.value を指定するには、default に合わせて3つ指定しなければならない
          ims:
            - value:              pager
            - value:              telephoneNumber
            - value:              pager

正しい記述例2)

iid:
  scim:
   attribute:
      user:
        default:
          ims:                                    # default で ims.display と ims.primary を3つ指定
            - display:              'display1'
              primary:            true
            - display:              'display2'
              primary:            false
            - display:              'display3'
              primary:            false
        ad_bind:                                  # ad_bind で ims.value を指定するには、default に合わせて3つ指定しなければならない
          ims:
            - value:              pager
            - value:              null            # 値の指定をスキップするため null を指定する
            - value:              pager

誤った記述例)

iid:
  scim:
    attribute:
      user:
        default:
          ims:
            - primary:    true
            - primary:    false
            - primary:    false
        ad_bind:                                   # default で ims.primary が3つ指定されているが、ad_bindでは ims.value が2つしか指定されていないためエラーとなる
          ims:
            - value:      pager
            - value:      telephoneNumber


Active Directoryの属性に複数の値がある場合の指定

Active Directoryでは、userCertificate属性のように1個の属性に対して配列で複数の値を指定できる属性があります。

このような属性を指定する場合は、配列の番号を指定することができます。

パラメータ名

説明

iid


scim


attribute


user


default




x509Certificates
(最大20個までの配列指定)

display

X509証明書の表示名(デフォルト値)

typeX509証明書のタイプ(デフォルト値)
primary

X509証明書がプライマリかどうか(デフォルト値)

emails
(最大5個までの配列指定)
primary通知先メールアドレスがプライマリかどうか(デフォルト値)
ad_bindx509Certificates

(最大20個までの配列指定)

valueユーザのX509証明書

emails
(最大5個までの配列指定)

value通知先メールアドレス

記述例1)

iid:
  scim:
    attribute:
      user:
        default:
          x509Certificates:
            - display:      'Office Cert'
              type:         'work'
              primary:      true
            - display:      'Home Cert'
              type:         'home'
              primary:      false
        ad_bind:
          x509Certificates:
            - value:        userCertificate[0] # userCertificate属性の配列1番目の値
            - value:        userCertificate[1] # userCertificate属性の配列2番目の値

記述例2)

iid:
  scim:
    attribute:
      user:
        default:
          emails:
            - primary:      true
            - primary:      false
        ad_bind:
          emails:
            - value:        proxyAddresses # *1
            - value:        mail

※1 proxyAddressesに複数のメールアドレスを登録している場合、「SMTP:」(全て大文字)プレフィックスがついたメールアドレスがIIJ IDでのプライマリのメールアドレスとして設定されます。詳細については「config.yml」をご覧ください。

記述例3)

iid:
  scim:
    attribute:
      user:
        default:
          emails:
            - primary:      true
            - primary:      false
        ad_bind:
          emails:
            - value:        mail # デフォルト値にprimary:trueを指定しているため、mailがプライマリメールアドレスとなる
            - value:        proxyAddresses