# Hub Privacy

Allows managing various methods limiting access to a Hub Page.<br>

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.<br>
  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.


## Retrieve Hub privacy state

 - [GET /hubs/{subdomain}/access_restriction](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction/get.md): 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.

## Retrieve SAML settings

 - [GET /hubs/{subdomain}/access_restriction/saml](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1saml/get.md): Returns data about SAML authentication.

## Update SAML authentication settings

 - [PUT /hubs/{subdomain}/access_restriction/saml](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1saml/put.md): Modifies SAML authentication settings.

## Retrieve Google OAuth settings

 - [GET /hubs/{subdomain}/access_restriction/google_oauth](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1google_oauth/get.md): Returns data about Google OAuth authorization.

## Update Google OAuth authorization settings

 - [PUT /hubs/{subdomain}/access_restriction/google_oauth](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1google_oauth/put.md): Modifies Google OAuth authorization settings.

## Retrieve Hub password settings

 - [GET /hubs/{subdomain}/access_restriction/global_password](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1global_password/get.md): Returns data about Hub password.

## Update Hub password settings

 - [PUT /hubs/{subdomain}/access_restriction/global_password](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1global_password/put.md): Modifies Hub password settings.

## Retrieve domain-based restriction details

 - [GET /hubs/{subdomain}/access_restriction/domains_whitelist](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1domains_whitelist/get.md): Returns data about domain-based restriction for Hub access restriction
methods providing authentication of user with user email.
Applies to:
- SAML - optional,
- Google OAuth - required.

Once set if visitor trying to sign-in has a domain reported by
authentication method not matching any of the domains in domains whitelist,
the access to Hub is not granted even if authentication method normally
would grant access to this visitor.

Required to be enabled when using Google OAuth restriction method.

## Update Hub domain-based restrictions

 - [PUT /hubs/{subdomain}/access_restriction/domains_whitelist](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1domains_whitelist/put.md): Modified the domain-based restrictions settings.

## Retrieve ip-based restriction details

 - [GET /hubs/{subdomain}/access_restriction/ip_whitelist](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1ip_whitelist/get.md): Returns data about ip-based restriction for Hub.
If enabled only visitors from whitelisted IP addresser or IP ranges
are allowed to access the Hub. All other visitors will see 404 error.
Supported address formats:
- IP V4 address,
- IP V4 range in CIDR notation.

## Update Hub ip-based restrictions

 - [PUT /hubs/{subdomain}/access_restriction/ip_whitelist](https://api-docs.statushub.com/api-v3-openapi/hub-privacy/paths/~1hubs~1%7Bsubdomain%7D~1access_restriction~1ip_whitelist/put.md): Modified the ip-based restrictions settings.