httpProtocol

The httpProtocol data type describes the http resource for HCPnamespaces. This data type includes properties for the REST, S3 compatible, HSwift, and WebDAV namespace access protocols.

Properties

The table below describes the properties included in the httpProtocol data type.

PropertyData typeDescriptionNotes
hs3EnabledBooleanSpecifies whether the Hitachi API for Amazon S3 is enabled for the namespace. Valid values are:
  • true

    The Hitachi API for Amazon S3 is enabled.

  • false

    The Hitachi API for Amazon S3 is disabled.

The default is false.

This property can be set to true only if ACLs are enabled for the namespace.
hs3Requires AuthenticationBooleanSpecifies whether user authentication is required or optional for access to the namespace through the Hitachi API for Amazon S3. Valid values are:
  • true

    User authentication is required.

  • false

    User authentication is optional.

The default is true.

hswiftEnabledBooleanSpecifies whether the HSwift API is enabled for the namespace. Valid values are:
  • true

    The HSwift API is enabled.

  • false

    The HSwift API is disabled.

The default is false.

hswiftRequires AuthenticationBooleanSpecifies whether user authentication is required or optional for access to the namespace through the HSwift API. Valid values are:
  • true

    User authentication is required.

  • false

    User authentication is optional.

The default is true.

httpActiveDirectorySSO

Enabled

BooleanSpecifies whether HCP supports AD single sign-on for access to the namespace through the REST and S3 compatible APIs. Valid values are:
  • true

    HCP supports AD single sign-on for access to the namespace through the REST and S3 compatible APIs.

  • false

    HCP does not support AD single sign-on for access to the namespace through the REST and S3 compatible APIs.

The default is true.

This property is valid on a POST request only if owning the tenant supports AD authentication.

You can set the value of this property to true only while HTTP or HTTPS is enabled. Disabling both HTTP and HTTPS automatically disables this property.

httpEnabledBooleanSpecifies whether the HTTP port is open for HTTP and WebDAV access to the namespace without SSL security. Valid values are:
  • true

    The HTTP port is open.

  • false

    The HTTP port is closed.

The default is false.

httpsEnabledBooleanSpecifies whether the HTTPS port is open for HTTP and WebDAV access to the namespace with SSL security. Valid values are:
  • true

    The HTTPS port is open.

  • false

    The HTTPS port is closed.

The default is true.

Certain countries restrict the use of HTTPS. If the HCP system does not have HTTPS enabled, the httpsEnabled value cannot be set to true.
ipSettingsipSettingsSpecifies which IP addresses can and cannot access the namespace through the HTTP and WebDAV protocols.
restEnabledBooleanSpecifies whether the RESTful implementation of the HTTP protocol is enabled for the namespace. Valid values are:
  • true

    The RESTful implementation of the HTTP protocol is enabled.

  • false

    The RESTful implementation of the HTTP protocol is disabled.

The default is true.

restRequires AuthenticationBooleanSpecifies whether user authentication is required or optional for access to the namespace through the HTTP protocol. Valid values are:
  • true

    User authentication is required.

  • false

    User authentication is optional.

The default is true.

webdavBasicAuth EnabledBooleanSpecifies whether the WebDAV protocol requires basic authentication for access to the namespace. Valid values are:
  • true

    WebDAV requires basic authentication.

  • false

    WebDAV does not require basic authentication.

The default is false.

You can set the value of this property to true only if a WebDAV username and password already exist or are specified by the webdav-BasicAuthUsername and webdavBasicAuthPassword properties in the same request.
webdavBasicAuth PasswordStringSpecifies the password to use for basic authentication with the WebDAV protocol.

You can specify a value for this property only if a basic authentication username already exists or is specified by the webdavBasicAuth-Username property in the same request.

To remove the basic authentication password, specify the webdavBasic-AuthPassword property with no value. You can remove the password only if you remove the basic authentication username in the same request.

webdavBasicAuth UsernameString

Specifies the username to use for basic authentication with the WebDAV protocol.

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

Usernames are not case sensitive.

You can specify a value for this property only if a basic authentication password already exists or is specified by the webdavBasicAuth-Password property in the same request.

To remove the basic authentication username, specify the webdavBasic-AuthUsername property with no value. You can remove the username only if you remove the basic authentication password in the same request.

webdavCustom MetadataBooleanSpecifies whether WebDAV dead properties can be stored as custom metadata. Valid values are:
  • true

    Dead properties can be stored as custom metadata.

  • false

    Dead properties cannot be stored as custom metadata.

The default is false.

webdavEnabledBooleanSpecifies whether the WebDAV protocol is enabled for the namespace. Valid values are:
  • true

    The WebDAV protocol is enabled.

  • false

    The WebDAV protocol is disabled.

The default is false.

Example

Here’s an XML example of the httpProtocol data type:

<httpProtocol>
    <hswiftEnabled>false</hswiftEnabled>
    <hswiftRequiresAuthentication>false</hswiftRequiresAuthentication>
    <hs3Enabled>false</hs3Enabled>
    <hs3RequiresAuthentication>false</hs3RequiresAuthentication>
    <httpActiveDirectorySSOEnabled>true</httpActiveDirectorySSOEnabled>
    <httpEnabled>false</httpEnabled>
    <httpsEnabled>true</httpsEnabled>
    <ipSettings>
         <allowAddresses>
             <ipAddress>192.168.140.10</ipAddress>
             <ipAddress>192.168.140.14</ipAddress>
             <ipAddress>192.168.140.15</ipAddress>
             <ipAddress>192.168.149.0/24</ipAddress>
         </allowAddresses>
         <allowIfInBothLists>false</allowIfInBothLists>
         <denyAddresses>
             <ipAddress>192.168.149.5</ipAddress>
         </denyAddresses>
    </ipSettings>
    <restEnabled>true</restEnabled>
    <restRequiresAuthentication>true</restRequiresAuthentication>
    <webdavBasicAuthEnabled>false</webdavBasicAuthEnabled>
    <webdavBasicAuthPassword></webdavBasicAuthPassword>
    <webdavBasicAuthUsername></webdavBasicAuthUsername>
    <webdavCustomMetadata>false</webdavCustomMetadata>
    <webdavEnabled>false</webdavEnabled>
</httpProtocol>