Authentication

Content Platform Tenant Management Help

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

To use the HCP management API, you need either a system-level or tenant-level user account that’s defined in HCP. If HCP is configured to support Windows Active Directory® (AD), you can also use an AD user account that HCP recognizes to access HCP through the metadata query API.

HCP also accepts Active Directory authentication provided through the SPNEGO protocol or the AD authentication header. For more information about SPNEGO, see http://tools.ietf.org/html/rfc4559.

Note: To use a user account that was created in an HCP release earlier than 4.0, you need to log into the System Management Console or Tenant Management Console, as applicable, with that account at least once before you can use the account with the management API.

You need to provide credentials with every management API request. If you do not provide credentials or provide invalid credentials, HCP responds with a 403 (Forbidden) error message.

To provide credentials in a management API request, you specify an authentication token in an HTTP Authorization request header.

HCP also accepts credentials provided in an hcp-api-auth cookie. However, this method of providing credentials has been deprecated and should not be used in new applications.