Get global settings
Fetch global settings for a WyzePal server.
Note: this endpoint does not require any authentication at all, and you can use it to check:
- If this is a WyzePal server, and if so, what version of WyzePal it's running.
- What a WyzePal client (e.g. a mobile app or
wyzepal-terminal) needs to
know in order to display a login prompt for the server (e.g. what
authentication methods are available).
# Pass the path to your wyzepalrc file here.
client = wyzepal.Client(config_file="~/wyzepalrc")
# Fetch the settings for this server
result = client.get_server_settings()
curl -X GET https://studyscience.wyzepal.com/api/v1/server_settings \
This endpoint does not consume any arguments.
authentication_methods: object in which each key-value pair in the object
indicates whether the authentication method is enabled on this server.
wyzepal_version: the version of WyzePal running in the server.
push_notifications_enabled: whether mobile/push notifications are enabled.
email_auth_enabled: setting for allowing users authenticate with an
require_email_format_usernames: whether usernames should have an
email address format. This is important for clients to know whether
the validate email address format in a login prompt; this value will
be false if the server has
enabled with a username and password combination.
realm_uri: the organization's canonical URI.
realm_name: the organization's name (for display purposes).
realm_icon: the URI of the organization's logo as a square image,
used for identifying the organization in small locations in the
mobile and desktop apps.
realm_logo: the URI of the organization's logo as a horizontal
format image (displayed in the top-left corner of the logged-in
realm_night_logo: the URI of the organization's logo in the night mode as a
horizontal format image (dispalyed in the top-left corner of the logged-in
realm_description: HTML description of the organization, as configured by
the organization profile.
Please note that not all of these attributes are guaranteed to appear in a
response, for two reasons:
- This endpoint has evolved over time, so responses from older WyzePal servers
might be missing some keys (in which case a client should assume the
- If a
/server_settings request is made to the root domain of a
multi-subdomain server, like the root domain of wyzepal.com, the settings
that are realm-specific are not known and thus not provided.
A typical successful JSON response for a single-organization server may look like:
"realm_description": "<p>The WyzePal development environment default organization. It's great for testing!</p>",
"realm_name": "WyzePal Dev",