The table below describes the properties included in the httpProtocol data type.
Property name |
Data type |
Description |
Notes |
---|---|---|---|
Boolean |
Specifies 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. |
|
Boolean |
Specifies 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. |
|
|
hswiftEnabled |
Boolean |
Specifies 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 |
Boolean |
Specifies 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 |
Boolean |
Specifies 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. |
Boolean |
Specifies 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. |
|
|
Boolean |
Specifies 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. |
|
ipSettings |
Specifies which IP addresses can and cannot access the namespace through the HTTP and WebDAV protocols. For details, see ipSettings. |
|
|
Boolean |
Specifies 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. |
|
|
Boolean |
Specifies 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. |
|
|
Boolean |
Specifies 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. |
|
String |
Specifies the password to use for basic authentication with the WebDAV protocol. For the rules for passwords, see Passwords. |
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. |
|
String |
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. |
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. |
|
Boolean |
Specifies 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. |
|
|
Boolean |
Specifies 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. |
|
© 2015, 2020 Hitachi Vantara LLC. All rights reserved.