Group¶

A group is a type of role that defines permissions for one or more users.

Properties¶

Property	Type	Required	Description
`name`	`string`	—	The group name.
`comment`	`string`	—	An optional comment about the group.
`environments`	array of (`DEVELOPMENT` \| `STAGING` \| `TESTING` \| `PRODUCTION`)	—	Used to limit the environments the group is created in. The default value is all environments. Entries must be unique.
`grants`	acls	—	ACLs to add to the group.
`revocations`	acls	—	ACLs to remove from the group.
`options`	`object`	—	—

Property	Type	Required	Description
`create_db`	`boolean`	—	Determines if members of a group are allowed to create databases. Default: `false`.
`create_role`	`boolean`	—	These clauses determine whether members of a group will be permitted to create a new group, role or user. Default: `false`.
`inherit`	`boolean`	—	These clauses determine whether the group "inherits" the privileges of any roles that are granted ot it. Default: `false`.
`replication`	`boolean`	—	These clauses determine whether members of the group are allowed to initiate streaming replication or put the system in and out of backup mode. A role having the REPLICATION attribute is a very highly privileged role, and should only be used on roles actually used for replication. Default: `false`.
`superuser`	`boolean`	—	These clauses determine whether members of a group are superusers, who can override all access restrictions within the database. Superuser status is dangerous and should be used only when really needed. Default: `false`.

No other properties are accepted.

Source: schemata/group.yml · Resolved JSON Schema: group.json