Proper YAML Descriptions

Descriptions of Keys and Values

Describe the following parameters as shown here.

Parameter Name

Description

Example Configuration

iid scim attribute user default

preferredLanguage

Language

ja-JP

Example Description

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 one 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 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

iidscimattributeuser

default

 

ims
(An array of up to 10 entries can be configured.)

display

Display name of instance messenger

primaryIndicates whether the instance messenger is the primary instance messenger (default)
excludeims

(An array of up to 10 entries can be configured.)

valueInstance messenger ID, etc. to be excluded

Example 1 of Correct Description

iid:
  scim:
   attribute:
      user:
        default:
          ims:                                    # Specifies 3 ims.primary entries as the default
            - primary:            true
            - primary:            false
            - primary:            false
        ad_bind:                                  # To specify ims.value parameters in ad_bind, 3 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 3 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, 3 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:                                   # 3 ims.primary entries have been specified in the default section, but only 2 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 OpenLDAP Attributes

You can specify multiple attributes by specifying different array numbers.

Parameter Name

Description

iidscimattributeuser

default

 

emails

 (An array of up to 2 entries can be configured.)

primary

Indicates whether the email address is the primary email address (default value)

ad_bindemails

(An array of up to 2 entries can be configured.)

valueUser email addresses

Example Description

iid:
  scim:
    attribute:
      user:
        default:
          emails:
            - primary:      true
            - primary:      false
        ad_bind:
          emails:
            - value:        mail[0] # First value of emails attribute array
            - value:        mail[1] # Second value of email attribute array