Skip to content

Hub Privacy

Allows managing various methods limiting access to a Hub Page.

User-based methods - only one can be active in the same time:

  • SAML 2.0 - Recommended method offering the most flexibility and security,
  • Google OAuth - Use email address domain of user Google Account to limit the access to only those domains which are whitelisted.
    Very easy to setup for companies using Google services,
  • Hub Password - Most basic method which use a single password that can be used by anyone in order to see the Hub Page.

Network-based methods:

  • IP whitelist - Allow to specify a whitelist of IP V4 addresses and IP V4 ranges from which users are allowed to access the Hub Page.
Operations

Retrieve Hub privacy state

Request

Lists all available methods for restricting access to the Hub as well as the currently enabled access restriction method or public if Hub is public.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
api_versionstring

Api version

Value:"V3-R1"
curl -i -X GET \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/access_restriction?api_version=V3-R1' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
allowed_methodsArray of strings
Items Enum:"saml""google_oauth""global_password""public"
Example:
[
  "saml",
  "google_oauth",
  "global_password",
  "public"
]
enabled_methodstring
Enum:"saml""google_oauth""global_password""public"
Response
{
  "allowed_methods": [
    "saml",
    "google_oauth",
    "global_password",
    "public"
  ],
  "enabled_method": "saml"
}