Schemas

BlackPearlStoragePolicies Document

The BlackPearlStoragePolicies document describes Black Pearl-specific policies. This document contains policies to locate the Black Pearl S3 endpoint and map account names to API keys.

Name	Type	Description
DATA_TYPE	string `blackpearl_storage_policies#1.0.0`	Type of this document
s3_endpoint	string <uri>	The URL of the S3 endpoint of the BlackPearl appliance to use to access collections on this Storage Gateway.
bp_access_id_file	string	Path to the file which provides mappings from usernames within the configured identity domain to the ID and secret associated with the user’s BlackPearl account

{
  "DATA_TYPE": "blackpearl_storage_policies#1.0.0",
  "s3_endpoint": "http://blackpearl.example.org:8080",
  "bp_access_id_file": "/etc/blackpearl/access-id-file"
}

BlackPearlCollectionPolicies Document

The BlackPearlCollectionPolicies document describes Black Pearl-specific policies. Currently this document contains no connector-specific policy information.

Name	Type	Description
DATA_TYPE	string `blackpearl_collection_policies#1.0.0`

{
  "DATA_TYPE": "blackpearl_collection_policies#1.0.0"
}

BlackPearlUserCredentialPolicies Document

The BlackPearlUserCredentialPolicies document describes Black Pearl-specific policies. Currently this document contains read-only information about the access_id and key associated with an account.

Name	Type	Description
DATA_TYPE	string `blackpearl_user_credential_policies#1.0.0`
access_id	string	BlackPearl access ID
secret_key	string	BlackPearl secret key[Private]

{
  "DATA_TYPE": "blackpearl_user_credential_policies#1.0.0",
  "access_id": "amFzb25hbHQ=",
  "secret_key": "K9YxrEaj"
}