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つ多いため、エラーになる
複数パラメータの指定
同一パラメータに複数の配列が指定できるパラメータが存在します。
複数のパラメータを指定した場合、記載順と記載個数を揃える必要があります。
値の設定をスキップしたい場合は、値に"null"を指定してください。
| パラメータ名 | 説明 | ||||||
|---|---|---|---|---|---|---|---|
| iid | scim | attribute | user | default | ims | display | インスタンスメッセンジャーの表示名 |
| primary | このインスタンスメッセンジャーがプライマリかどうか（デフォルト値） | ||||||
| exclude | ims （最大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
OpenLDAPの属性に複数の値がある場合の指定
複数の属性を指定する場合は、配列の番号を指定することができます。
| パラメータ名 | 説明 | ||||||
|---|---|---|---|---|---|---|---|
| iid | scim | attribute | user | default | emails （最大2個までの配列指定） | primary | メールアドレスがプライマリかどうか（デフォルト値） |
| ad_bind | emails （最大2個までの配列指定） | value | ユーザのメールアドレス | ||||
記述例）
iid:
scim:
attribute:
user:
default:
emails:
- primary: true
- primary: false
ad_bind:
emails:
- value: mail[0] # emails属性の配列1番目の値
- value: mail[1] # emails属性の配列2番目の値