The Backend OrganizationSettings object
The OrganizationSettings object represents the Organization-related settings for the current instance.
Properties
- Name
-
adminDeleteEnabled - Type
boolean- Description
Whether admins are allowed to delete Organizations.
- Name
-
creatorRole - Type
string- Description
The default Role for an Organization creator.
- Name
-
domainsDefaultRole - Type
string- Description
The default Role for the Organization's Verified Domains.
- Name
-
domainsEnabled - Type
boolean- Description
Whether the instance has Verified Domains enabled.
- Name
-
domainsEnrollmentModes - Type
DomainsEnrollmentModes[]- Description
The enrollment modes available for Verified Domains.
manual_invitation: No automatic enrollment. Users with a matching email domain are not given any invitation or suggestion; an admin must invite them manually.automatic_invitation: Users with a matching email domain automatically receive a pending invitation (assigned the Organization's default Role) which they can accept to join.automatic_suggestion: Users with a matching email domain automatically receive a suggestion to join, which they can request.
- Name
-
enabled - Type
boolean- Description
Whether the instance has Organizations enabled.
- Name
-
maxAllowedMemberships - Type
number- Description
The maximum number of memberships allowed per Organization.
- Name
-
slugDisabled - Type
boolean- Description
Whether the instance has Organization slugs disabled.
Feedback
Last updated on