HCP Tenant Management Help


Namespace resources

Namespace resources let you create, retrieve information about, modify, and delete namespaces. The table below provides information about these resources.

Data type

Method

Use

Access

Notes

.../tenants/tenant-name/namespaces

namespace

PUT

Create an HCP namespace

Tenant-level user account with the administrator role or allow namespace management property

Not valid for the default namespace.

List

GET

Retrieve a list of the namespaces owned by a tenant

For an HCP tenant, tenant-level user account with the monitor, administrator, or compliance role or allow namespace management property

For the default tenant, system-level user account with the monitor or administrator role

The listed namespaces are identified by namespace name.

In XML, the element that identifies each namespace is name. The root element for the list of namespaces is namespaces.

In JSON, the name in the name/value pair that lists the namespaces is name.

For a user with the allow namespace management property and no roles, the retrieved list includes only the namespaces the user owns.

.../tenants/tenant-name/namespaces/namespace-name

namespace

GET

Retrieve information about a namespace

For an HCP namespace, tenant-level user account with the monitor or administrator role or allow namespace management property

For the default namespace, system-level user account with the monitor or administrator role

A user with the allow namespace management property and no roles can retrieve information only about the namespaces the user owns. In this case, the retrieved information includes only the namespace name and owner.

N/A

HEAD

Check for the existence of a namespace

For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role or allow namespace management property

For the default namespace, system-level user account with the monitor or administrator role

 

namespace

POST

Modify a namespace

For an HCP namespace, tenant-level user account with the administrator role

For the default namespace, system-level user account with the administrator role

For information about query parameters for resetting indexing checkpoints, see Query parameter for restarting indexing.

N/A

DELETE

Delete an HCP namespace

Tenant-level user account with the administrator role or allow namespace management property

A user with the allow namespace management property and no roles can delete only the namespaces the user owns.

The namespace cannot contain any objects.

Not valid for the default namespace.

.../tenants/tenant-name/namespaces/namespace-name/chargebackReport

chargeback
  Report

GET

Generate a chargeback report for a namespace

Tenant-level user account with the monitor or administrator role

Not valid for the default namespace.

Supported output formats are XML, JSON, and CSV.

For information about optional query parameters for generating chargeback reports, see Query parameters for generating chargeback reports.

For information about chargeback reports, see About chargeback reports.

.../tenants/tenant-name/namespaces/namespace-name/complianceSettings

compliance
  Settings

GET

Retrieve the default retention, shred, custom metadata handling, and disposition settings for a namespace

For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role

For the default namespace, system-level user account with the monitor, administrator, or compliance role

Default retention and shred settings do not apply to the default namespace.

POST

Modify the default retention, shred, custom metadata handling, or disposition setting for a namespace

For an HCP namespace, tenant-level user account with the compliance role

For the default namespace, system-level user account with the compliance role

.../tenants/tenant-name/namespaces/namespace-name/
customMetadataIndexingSettings

custom
  Metadata
  Indexing
  Settings

GET

Retrieve settings specific to metadata query engine indexing of custom metadata for a search-enabled namespace

For an HCP namespace, tenant-level user account with the monitor or administrator role

For the default namespace, system-level user account with the monitor or administrator role

Not valid for namespaces that do not have search enabled.

POST

Modify settings specific to metadata query engine indexing of custom metadata for a search-enabled namespace

For an HCP namespace, tenant-level user account with the administrator role

For the default namespace, system-level user account with the administrator role

.../tenants/tenant-name/namespaces/namespace-name/permissions

List

GET

Retrieve the list of permissions in the data access permission mask for a namespace

For an HCP namespace, tenant-level user account with the monitor or administrator role

For the default namespace, system-level user account with the monitor or administrator role

For the format of the permission list, seePermission lists.

List

POST

Modify the list of permissions in the data access permission mask for a namespace

For an HCP namespace, tenant-level user account with the administrator role

For the default namespace, system-level user account with the administrator role

Valid values for permissions are:

DELETE

PRIVILEGED

PURGE

READ

SEARCH

WRITE

These values are case sensitive.

For the format of the permission list, see Permission lists.

The set of permissions specified in the request body replaces the set of permissions currently included in the data access permission mask for the namespace. To remove all permissions, specify an empty list.

If the set of permissions includes PURGE, delete permission is enabled automatically. If the set of permissions includes SEARCH, read permission is enabled automatically.

By default, when you create a namespace, its data access permission mask includes all permissions.

.../tenants/tenant-name/namespaces/namespace-name/protocols

protocols

GET

Retrieve a subset of the HTTP namespace access protocol settings for the default namespace

System-level user account with the monitor or administrator role

Not valid for HCP namespaces. For HCP namespaces, this resource has been superseded by the .../protocols/http resource.

POST

Modify a subset of the HTTP namespace access protocol settings for the default namespace

System-level user account with the administrator role

.../tenants/tenant-name/namespaces/namespace-name/protocols/protocol-name

Determined by protocol-name. Possible data types are:

  cifsProtocol
  httpProtocol
  nfsProtocol
  smtpProtocol

GET

Retrieve the applicable namespace access protocol settings for a namespace

Tenant-level user account with the monitor or administrator role

Not valid for the default namespace.

Valid values for protocol-name are:

cifs

http

nfs

smtp

These values are case sensitive.

The httpProtocol data type includes properties for both the HTTP and WebDAV protocols.

POST

Modify the applicable namespace access protocol settings for a namespace

Tenant-level user account with the administrator role

.../tenants/tenant-name/namespaces/namespace-name/replicationCollisionSettings

replication
  Collision
  Settings

GET

Retrieve the replication collision handling settings for a namespace

For an HCP namespace, tenant-level user account with the monitor or administrator role

For the default namespace, system-level user account with the monitor or administrator role

 

POST

Modify the replication collision handling settings for a namespace

For an HCP namespace, tenant-level user account with the administrator role

For the default namespace, system-level user account with the administrator role

 

.../tenants/tenant-name/namespaces/namespace-name/statistics

statistics

GET

Retrieve information about the content of a namespace

For an HCP namespace, tenant-level user account with the monitor or administrator role

For the default namespace, system-level user account with the monitor or administrator role

 

.../tenants/tenant-name/namespaces/namespace-name/versioningSettings

versioning
  Settings

GET

Retrieve the versioning settings for a namespace

Tenant-level user account with the monitor or administrator role or the allow namespace management property

A user with the allow namespace management property and no roles can retrieve and modify only the versioning enabled property and that property only for the namespaces the user owns.

Not valid for the default namespace.

POST

Modify the versioning settings for a namespace

Tenant-level user account with the administrator role or the allow namespace management property

DELETE

Delete the versioning settings for a namespace

Tenant-level user account with the monitor or administrator role or the allow namespace management property

© 2015, 2019 Hitachi Vantara Corporation. All rights reserved.