Proper YAML Descriptions
Descriptions of Keys and Values
Describe the parameters as shown here.
| Parameter Name | Description | Example Configuration | |||||
|---|---|---|---|---|---|---|---|
| iid | scim | attribute | user | default | preferredLanguage | Language | ja-JP |
iid:
scim:
attribute:
user:
default:
preferredLanguage: 'ja-JP'
The parameter name is a hash key. Describe the input value as a value corresponding to a key.
Describe keys together when including multiple keys within an upper key.
| Parameter Name | Description | Example Configuration | |||||
|---|---|---|---|---|---|---|---|
| iid | scim | attribute | user | default | preferredLanguage | Language | ja-JP |
| timezone | Time zone | Asia/Tokyo | |||||
Example of Correct Description
iid:
scim:
attribute:
user:
default:
preferredLanguage: 'ja-JP'
timezone: 'Asia/Tokyo'
Example of Incorrect Description
The "preferredLanguage" and "timezone" keys are in different levels of the hierarchy, which results in an error.
iid:
scim:
attribute:
user:
default:
preferredLanguage: 'ja-JP'
timezone: 'Asia/Tokyo' # One space too many before "timezone," which results in an error.
Specifying Arrays
Some parameters require description of arrays for the same parameter.
You can specify an array using a hyphen (-). In this case, describe the element of the array on the next line of the key.
| Parameter Name | Description | Example Configuration | |||||
|---|---|---|---|---|---|---|---|
| iid | scim | attribute | user | convert | externalUserName | User name for upstream ID provider | Example: Add "'@' + (AD domain name)" to the end - pattern: '\z' |
Example of Correct Description
iid:
scim:
attribute:
user:
convert:
externalUserName:
- pattern: '@example.com' # Start a new line for the key and then describe the array element
replacement: '@example.jp'
Example of Incorrect Description
iid:
scim:
attribute:
user:
convert:
externalUserName: - pattern: '@example.com' # An error occurs because the array element is specified on the same line as the key
replacement: '@example.jp'
Specifying Multiple Parameters
Some parameters allow the specification of arrays with multiple values.
To specify multiple parameters, the listing order and number of entries must be in alignment.
If you do not want to specify a value for a particular entry, use the "null" value.
| Parameter Name | Description | ||||||
|---|---|---|---|---|---|---|---|
| iid | scim | attribute | user | default | ims | display | Display name of instance messenger |
| primary | Specifies whether the instance messenger is the primary instance messenger (default) | ||||||
| exclude | ims (An array of up to 10 entries can be configured.) | value | Instance messenger ID, etc. to be excluded | ||||
Example 1 of Correct Description
iid:
scim:
attribute:
user:
default:
ims: # Specifies three ims.primary entries as the default
- primary: true
- primary: false
- primary: false
ad_bind: # To specify ims.value parameters in ad_bind, three entries must be specified to stay in alignment with the configuration for the default section.
ims:
- value: pager
- value: telephoneNumber
- value: pager
Example 2 of Correct Description
iid:
scim:
attribute:
user:
default:
ims: # Specifies three ims.display and ims.primary entries as the default
- display: 'display1'
primary: true
- display: 'display2'
primary: false
- display: 'display3'
primary: false
ad_bind: # To specify ims.value parameters in ad_bind, three entries must be specified to stay in alignment with the configuration for the default section.
ims:
- value: pager
- value: null # The null value is used to bypass configuring a value for this particular parameter.
- value: pager
Example of Incorrect Description
iid:
scim:
attribute:
user:
default:
ims:
- primary: true
- primary: false
- primary: false
ad_bind: # three ims.primary entries have been specified in the default section, but only two ims.value entries have been specified in the ad_bind section. This will result in an error.
ims:
- value: pager
- value: telephoneNumber
Specifying Multiple Values for an Active Directory Attribute
With Active Directory, you can specify multiple values for an attribute using arrays, such as with the userCertificate attribute.
You can specify such attributes by specifying different array numbers.
| Parameter Name | Description | ||||||
|---|---|---|---|---|---|---|---|
| iid | scim | attribute | user | default | x509Certificates (An array of up to 20 entries can be configured.) | display | Display name of X.509 certificate (default value) |
| type | X.509 certificate type (default value) | ||||||
| primary | Specifies whether the X.509 certificate is the primary X.509 certificate (default value) | ||||||
| emails (An array of up to five entries can be configured.) | primary | Indicates whether the notification email address is the primary email address (default value) | |||||
| ad_bind | x509Certificates (An array of up to 20 entries can be configured.) | value | User X.509 certificate | ||||
| emails (An array of up to five entries can be configured.) | value | Notification email address | |||||
Example Description 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] # First value of userCertificate attribute array
- value: userCertificate[1] # Second value of userCertificate attribute array
Example Description 2
iid:
scim:
attribute:
user:
default:
emails:
- primary: true
- primary: false
ad_bind:
emails:
- value: proxyAddresses # *1
- value: mail
*1 When multiple email addresses are registered with proxyAddresses, the email address to which the "SMTP:" (all upper-case characters) prefix is attached is configured as the primary email address for IIJ IDs. Refer to "config.yml" for more information.
Example Description 3
iid:
scim:
attribute:
user:
default:
emails:
- primary: true
- primary: false
ad_bind:
emails:
- value: mail # Because primary:true is specified as the default value, mail is the primary email address.
- value: proxyAddresses