Policy

GET

/api/v1/instance/policy

const url = 'https://example.com/api/v1/instance/policy';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/instance/policy

Public: the register screen reads it before anyone signs in.

Responses

200

Successful Response

application/json

InstancePolicyRead

What the menus need, signed in or not: whether an account may found an organization on its own (signup, avatar menu, Waiting Room).

object

assistant_enabled

Assistant Enabled

boolean

can_found_organization

required

Can Found Organization

boolean

email_invitations_available

required

Email Invitations Available

boolean

password_min_length

Password Min Length

integer

default: 8

password_reject_personal

Password Reject Personal

boolean

password_reset_available

required

Password Reset Available

boolean

surface

Surface

string

default: internal

Allowed values: internal public

tenancy_mode

required

Tenancy Mode

string

Allowed values: open single managed

Example

{
  "assistant_enabled": false,
  "password_min_length": 8,
  "password_reject_personal": false,
  "surface": "internal",
  "tenancy_mode": "open"
}