Method: projects.locations.initialize

Provisions resources for given tenant project. Returns a long running operation.

HTTP request

POST https://contentwarehouse.googleapis.com/v1/{location}:initialize

Path parameters

Parameters
location

string

Required. The location to be initialized Format: projects/{projectNumber}/locations/{location}. It takes the form projects/{project}/locations/{location}.

Request body

The request body contains data with the following structure:

JSON representation
{
  "databaseType": enum (DatabaseType),
  "accessControlMode": enum (AccessControlMode),
  "kmsKey": string,
  "documentCreatorDefaultRole": enum (DocumentCreatorDefaultRole)
}
Fields
databaseType

enum (DatabaseType)

Required. The type of database used to store customer data

accessControlMode

enum (AccessControlMode)

Required. The access control mode for accessing the customer data

kmsKey

string

Optional. The KMS key used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kmsKey is left empty, no encryption will be enforced.

documentCreatorDefaultRole

enum (DocumentCreatorDefaultRole)

Optional. The default role for the person who create a document.

Response body

If successful, the response body contains an instance of Operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the location resource:

  • contentwarehouse.locations.initialize

For more information, see the IAM documentation.

DatabaseType

type of database used by the customer

Enums
DB_UNKNOWN This value is required by protobuf best practices
DB_INFRA_SPANNER Internal Spanner
DB_CLOUD_SQL_POSTGRES Cloud Sql with a Postgres Sql instance

AccessControlMode

Access Control Mode.

Enums
ACL_MODE_UNKNOWN This value is required by protobuf best practices
ACL_MODE_UNIVERSAL_ACCESS Universal Access: No document level access control.
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_BYOID Document level access control with customer own Identity Service.
ACL_MODE_DOCUMENT_LEVEL_ACCESS_CONTROL_GCI Document level access control using Google Cloud Identity.

DocumentCreatorDefaultRole

The default role of the document creator.

Enums
DOCUMENT_CREATOR_DEFAULT_ROLE_UNSPECIFIED Unspecified, will be default to document admin role.
DOCUMENT_ADMIN Document Admin, same as contentwarehouse.googleapis.com/documentAdmin.
DOCUMENT_EDITOR Document editor, same as contentwarehouse.googleapis.com/documentEditor.
DOCUMENT_VIEWER Document Viewer, same as contentwarehouse.googleapis.com/documentViewer.