Working with schemas

Schemas

Schemas are used to describe the structure of a directory, while also providing the ability to create mappings, constraints, validation rules and more.

Profile schema-defaults for User and Group are automatically applied when using a directory_type other than custom.

• Active Directory
• FreeIPA

One or more properties in these schemas may be overridden with new values (in user.yml or group.yml).

 

Base properties

Name	required	data type	default value	notes
classes	yes	list		Object classes for this schema
relative_dn	no	string		Relative to core.base_dn
required_fields	no	list	[ ]	List of required fields on update/insert
hidden_fields	no	list	[ ]	Hide these fields in the JSON response
fields	yes	list		Field type and reference

 

Fields

If defining your own set of fields, an 'id' field with reference ref to a unique attribute in the directory is required. Additionally, if the directory_type is 'ad', you're required to define a field with reference to the 'cn' attribute.

Name	required	data type	default value	notes
ref	yes	string		Directory attribute name
type	yes	string	string	Data type
default	no	string		Default value