What you can do with the management API

Content Platform Tenant Management Help

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

The HCP management API lets you work with tenants, namespaces, retention classes, content classes, and tenant-level user and group accounts.

For tenants, you can:

  • Modify HCP tenants
  • Retrieve information about a single tenant
  • Set default properties for namespaces created for an HCP tenant
  • Retrieve statistics about the content of the namespaces owned by a tenant
  • Generate a chargeback report for an HCP tenant

For namespaces, you can:

  • Create HCP namespaces
  • Modify namespaces
  • Delete HCP namespaces
  • Retrieve information about a single namespace
  • Retrieve a list of all the namespaces owned by a tenant
  • Retrieve statistics about the content of a namespace
  • Generate a chargeback report for an HCP namespace
  • Reset the indexing checkpoint for a namespace

For retention classes, you can:

  • Create, modify, and delete retention classes for a namespace
  • Retrieve information about a single retention class
  • Retrieve a list of all the retention classes defined for a namespace

For content classes, you can:

  • Create, modify, and delete content classes for a tenant
  • Retrieve information about a single content class
  • Retrieve a list of all the content classes defined for a tenant

For HCP tenant-level user accounts, you can:

  • Create, modify, and delete user accounts
  • Retrieve information about a single user account
  • Retrieve a list of all the user accounts defined for a tenant

For HCP tenant-level group accounts, you can:

  • Create, modify, and delete group accounts
  • Retrieve information about a single group account
  • Retrieve a list of all the group accounts defined for a tenant
  • Create a new group account with the security role or give the security role to an existing group account