Skip to content

SQL directory

Directory

Description

Short description of this directory.

Text. Name in the API: description.

Connection

Storage Backend

Storage backend where accounts and groups are stored.

Settings of their own: see SQL auth store. Name in the API: store.

Columns

E-mail Column

Column name for e-mail address. Optional, you can use instead a query to obtain the account's addresses.

Text. Default: name. Name in the API: columnEmail.

Password Column

Column name for the account password.

Text. Default: secret. Name in the API: columnSecret.

Account Type Column

Column name for account type.

Text. Default: type. Name in the API: columnClass.

Description Column

Column name for account full name or description.

Text. Default: description. Name in the API: columnDescription.

Queries

Login Query

Query to obtain the account details by login e-mail address.

Text. Name in the API: queryLogin.

Recipient Query

Query to obtain the account details by recipient e-mail address or alias.

Text. Name in the API: queryRecipient.

Member Of Query

Query to obtain the groups an account is member of.

Text. Default: SELECT member_of FROM group_members WHERE name = $1. Name in the API: queryMemberOf.

E-mail Aliases Query

Query to obtain the e-mail aliases of an account.

Text. Default: SELECT address FROM emails WHERE name = $1. Name in the API: queryEmailAliases.

Tenant

Identifier for the tenant this directory belongs to.

One of your Tenants, chosen from a list. Name in the API: memberTenantId.