Enabling REST, S3 compatible, and WebDAV access to a namespace

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

The HTTP(S) panel has two sections for enabling and configuring the REST, S3 compatible, and WebDAV APIs. This procedure is for the Settings section.

Note: REST and WebDAV are not supported on the namespaces that are configured to use S3 Object Lock.
  1. Take either or both of these actions:
    • To open the HTTPS port for REST, S3 compatible, and WebDAV access to the namespace with SSL security, select Enable HTTPS.

      Certain countries prohibit the export of encryption technology. HCP systems shipped to restricted countries have the HTTPS option on the namespace protocols page disabled. If you do not see the checkbox to enable HTTPS and you are in a country where SSL encryption is permitted, please contact your HCP system administrator.

    • To open the HTTP port for REST, S3 compatible, and WebDAV access to the namespace without SSL security, select Enable HTTP.
    These two options are independent of each other. If you select only Enable HTTPS, data sent through the REST, S3 compatible, and WebDAV APIs is always secure. If you select both options, users and applications can send both secure and unsecure data through the REST, S3 compatible, and WebDAV APIs.
    Note: To enable access to the namespace through the REST, S3 compatible, or WebDAV API, you also need to select Enable REST API, Enable Hitachi API for Amazon S3, or Enable WebDAV API, respectively. Opening the HTTPS and HTTP ports does by itself enable these protocols.
  2. Enable the REST API.
    1. Select Enable REST API.
      This option is available only if Enable HTTP or Enable HTTPS is already selected.

      Above the Enable REST API option, the panel shows the URL for access to the namespace through the REST API. If the HTTPS port is open or if neither the HTTPS or HTTP port is open, this URL starts with https. If only the HTTP port is open, the URL starts with http.

    2. To specify REST authentication requirements, below the Enable REST API option, select either Authenticated access only or Anonymous and authenticated access.
    3. (Optional) Select or deselect Enable Active Directory single sign-on to allow or disallow, respectively, single sign-on to the namespace with Active Directory authentication.
      This option appears only if the tenant supports AD for user authentication.

      The option to enable AD single sign-on for REST is synchronized with the same option for the S3 compatible API. Enabling or disabling either enables of disables the other, respectively.

      To help ensure that AD single sign-on is available for those namespaces that need it, enable it only for those namespaces.

      After this option is disabled, you can reenable it only while HCP can communicate with AD.

  3. Enable the S3 compatible API.
    1. Select Enable Hitachi API for Amazon S3.
      This option is available only if Enable HTTP or Enable HTTPS is already selected.

      Above the Enable Hitachi API for Amazon S3 option, the panel shows the URL for access to the namespace through the S3 compatible API. If the HTTPS port is open or if neither the HTTPS or HTTP port is open, this URL starts with https. If only the HTTP port is open, the URL starts with http.

    2. To specify S3 compatible authentication requirements, below the Enable Hitachi API for Amazon S3 option, select either Authenticated access only or Anonymous and authenticated access.
    3. Optionally, select or deselect Enable Active Directory single sign-on to allow or disallow, respectively, single sign-on to the namespace with Active Directory authentication.
      This option appears only if the tenant supports AD for user authentication.
  4. Enable the WebDAV API.
    1. Select Enable WebDAV API.
      This option is available only if Enable HTTP or Enable HTTPS is already selected.

      Above the Enable WebDAV API option, the panel shows the URL for access to the namespace through the WebDAV API. If the HTTPS port is open or if neither the HTTPS or HTTP port is open, this URL starts with https. If only the HTTP port is open, the URL starts with http.

    2. Select Enable WebDAV basic authentication.
    3. In the Username field, type the user name to use for basic authentication.
      User names must be from one through 64 characters long and can contain any valid UTF-8 characters but cannot start with an opening square bracket ([). White space is allowed. User names are not case sensitive.
    4. In the Password field, type the password to use for basic authentication.
      Passwords can be up to 64 characters long, are case sensitive, and can contain any valid UTF-8 characters, including white space. The minimum password length is the same as the minimum password length for HCP user accounts, which is configurable. To be valid, a password must include at least one character from two of these three groups: alphabetic, numeric, and other.

      If you’re modifying settings in the HTTP(S) panel and you leave the Password field empty, the previously set password remains in effect.

    5. In the Confirm Password field, type the password again.
      Tip: Be sure to tell WebDAV users the username and password you specify.
    6. (Optional) Enable WebDAV users to store dead properties as custom metadata by selecting Use custom metadata to store WebDAV properties.
  5. Click Update Settings.
    If you selected Enable HTTP and also selected Enable REST API, Enable Hitachi API for Amazon S3, or Enable WebDAV API, a confirming message appears.
  6. Click Update Settings.