Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/CloudKMS/CryptoKey.php
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,10 @@ public function getImportOnly()
* the policy. The policy is defined by specifying zero or more allowed
* justification codes. https://cloud.google.com/assured-workloads/key-access-
* justifications/docs/justification-codes By default, this field is absent,
* and all justification codes are allowed.
* and all justification codes are allowed. If the
* `key_access_justifications_policy.allowed_access_reasons` is empty (zero
* allowed justification code), all encrypt, decrypt, and sign operations will
* fail.
*
* @param KeyAccessJustificationsPolicy $keyAccessJustificationsPolicy
*/
Expand Down
8 changes: 4 additions & 4 deletions src/CloudKMS/KeyAccessJustificationsEnrollmentConfig.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@
class KeyAccessJustificationsEnrollmentConfig extends \Google\Model
{
/**
* Whether the project has KAJ logging enabled.
* Indicates whether the project has KAJ logging enabled.
*
* @var bool
*/
public $auditLogging;
/**
* Whether the project is enrolled in KAJ policy enforcement.
* Indicates whether the project is enrolled in KAJ policy enforcement.
*
* @var bool
*/
public $policyEnforcement;

/**
* Whether the project has KAJ logging enabled.
* Indicates whether the project has KAJ logging enabled.
*
* @param bool $auditLogging
*/
Expand All @@ -49,7 +49,7 @@ public function getAuditLogging()
return $this->auditLogging;
}
/**
* Whether the project is enrolled in KAJ policy enforcement.
* Indicates whether the project is enrolled in KAJ policy enforcement.
*
* @param bool $policyEnforcement
*/
Expand Down
14 changes: 8 additions & 6 deletions src/CloudKMS/KeyAccessJustificationsPolicy.php
Original file line number Diff line number Diff line change
Expand Up @@ -21,18 +21,20 @@ class KeyAccessJustificationsPolicy extends \Google\Collection
{
protected $collection_key = 'allowedAccessReasons';
/**
* The list of allowed reasons for access to a CryptoKey. Zero allowed access
* reasons means all encrypt, decrypt, and sign operations for the CryptoKey
* associated with this policy will fail.
* The list of allowed reasons for access to a CryptoKey. Note that empty
* allowed_access_reasons has a different meaning depending on where this
* message appears. If this is under KeyAccessJustificationsPolicyConfig, it
* means allow-all. If this is under CryptoKey, it means deny-all.
*
* @var string[]
*/
public $allowedAccessReasons;

/**
* The list of allowed reasons for access to a CryptoKey. Zero allowed access
* reasons means all encrypt, decrypt, and sign operations for the CryptoKey
* associated with this policy will fail.
* The list of allowed reasons for access to a CryptoKey. Note that empty
* allowed_access_reasons has a different meaning depending on where this
* message appears. If this is under KeyAccessJustificationsPolicyConfig, it
* means allow-all. If this is under CryptoKey, it means deny-all.
*
* @param string[] $allowedAccessReasons
*/
Expand Down
22 changes: 14 additions & 8 deletions src/CloudKMS/KeyAccessJustificationsPolicyConfig.php
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,23 @@ class KeyAccessJustificationsPolicyConfig extends \Google\Model
protected $defaultKeyAccessJustificationPolicyType = KeyAccessJustificationsPolicy::class;
protected $defaultKeyAccessJustificationPolicyDataType = '';
/**
* Identifier. The resource name for this KeyAccessJustificationsPolicyConfig
* in the format of "{organizations|folders|projects}/kajPolicyConfig".
* Identifier. Represents the resource name for this
* KeyAccessJustificationsPolicyConfig in the format of
* "{organizations|folders|projects}/kajPolicyConfig".
*
* @var string
*/
public $name;

/**
* Optional. The default key access justification policy used when a CryptoKey
* is created in this folder. This is only used when a Key Access
* Justifications policy is not provided in the CreateCryptoKeyRequest. This
* overrides any default policies in its ancestry.
* Optional. Specifies the default key access justifications (KAJ) policy used
* when a CryptoKey is created in this folder. This is only used when a Key
* Access Justifications policy is not provided in the CreateCryptoKeyRequest.
* This overrides any default policies in its ancestry. If this field is
* unset, or is set but contains an empty allowed_access_reasons list, no
* default Key Access Justifications (KAJ) policy configuration is active. In
* this scenario, all newly created keys will default to an "allow-all"
* policy.
*
* @param KeyAccessJustificationsPolicy $defaultKeyAccessJustificationPolicy
*/
Expand All @@ -49,8 +54,9 @@ public function getDefaultKeyAccessJustificationPolicy()
return $this->defaultKeyAccessJustificationPolicy;
}
/**
* Identifier. The resource name for this KeyAccessJustificationsPolicyConfig
* in the format of "{organizations|folders|projects}/kajPolicyConfig".
* Identifier. Represents the resource name for this
* KeyAccessJustificationsPolicyConfig in the format of
* "{organizations|folders|projects}/kajPolicyConfig".
*
* @param string $name
*/
Expand Down
7 changes: 4 additions & 3 deletions src/CloudKMS/Resource/Folders.php
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public function getAutokeyConfig($name, $optParams = [])
* Gets the KeyAccessJustificationsPolicyConfig for a given organization,
* folder, or project. (folders.getKajPolicyConfig)
*
* @param string $name Required. The name of the
* @param string $name Required. Specifies the name of the
* KeyAccessJustificationsPolicyConfig to get.
* @param array $optParams Optional parameters.
* @return KeyAccessJustificationsPolicyConfig
Expand Down Expand Up @@ -91,13 +91,14 @@ public function updateAutokeyConfig($name, AutokeyConfig $postBody, $optParams =
* Updates the KeyAccessJustificationsPolicyConfig for a given organization,
* folder, or project. (folders.updateKajPolicyConfig)
*
* @param string $name Identifier. The resource name for this
* @param string $name Identifier. Represents the resource name for this
* KeyAccessJustificationsPolicyConfig in the format of
* "{organizations|folders|projects}/kajPolicyConfig".
* @param KeyAccessJustificationsPolicyConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Optional. The list of fields to update.
* @opt_param string updateMask Optional. Specifies the list of fields to
* update.
* @return KeyAccessJustificationsPolicyConfig
* @throws \Google\Service\Exception
*/
Expand Down
7 changes: 4 additions & 3 deletions src/CloudKMS/Resource/Organizations.php
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class Organizations extends \Google\Service\Resource
* Gets the KeyAccessJustificationsPolicyConfig for a given organization,
* folder, or project. (organizations.getKajPolicyConfig)
*
* @param string $name Required. The name of the
* @param string $name Required. Specifies the name of the
* KeyAccessJustificationsPolicyConfig to get.
* @param array $optParams Optional parameters.
* @return KeyAccessJustificationsPolicyConfig
Expand All @@ -49,13 +49,14 @@ public function getKajPolicyConfig($name, $optParams = [])
* Updates the KeyAccessJustificationsPolicyConfig for a given organization,
* folder, or project. (organizations.updateKajPolicyConfig)
*
* @param string $name Identifier. The resource name for this
* @param string $name Identifier. Represents the resource name for this
* KeyAccessJustificationsPolicyConfig in the format of
* "{organizations|folders|projects}/kajPolicyConfig".
* @param KeyAccessJustificationsPolicyConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Optional. The list of fields to update.
* @opt_param string updateMask Optional. Specifies the list of fields to
* update.
* @return KeyAccessJustificationsPolicyConfig
* @throws \Google\Service\Exception
*/
Expand Down
15 changes: 8 additions & 7 deletions src/CloudKMS/Resource/Projects.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public function getAutokeyConfig($name, $optParams = [])
* Gets the KeyAccessJustificationsPolicyConfig for a given organization,
* folder, or project. (projects.getKajPolicyConfig)
*
* @param string $name Required. The name of the
* @param string $name Required. Specifies the name of the
* KeyAccessJustificationsPolicyConfig to get.
* @param array $optParams Optional parameters.
* @return KeyAccessJustificationsPolicyConfig
Expand Down Expand Up @@ -89,8 +89,8 @@ public function showEffectiveAutokeyConfig($parent, $optParams = [])
* to the given project in hierarchy.
* (projects.showEffectiveKeyAccessJustificationsEnrollmentConfig)
*
* @param string $project Required. The number or id of the project to get the
* effective KeyAccessJustificationsEnrollmentConfig for.
* @param string $project Required. Specifies the number or id of the project to
* get the effective KeyAccessJustificationsEnrollmentConfig for.
* @param array $optParams Optional parameters.
* @return ShowEffectiveKeyAccessJustificationsEnrollmentConfigResponse
* @throws \Google\Service\Exception
Expand All @@ -106,8 +106,8 @@ public function showEffectiveKeyAccessJustificationsEnrollmentConfig($project, $
* the given project in hierarchy.
* (projects.showEffectiveKeyAccessJustificationsPolicyConfig)
*
* @param string $project Required. The number or id of the project to get the
* effective KeyAccessJustificationsPolicyConfig. In the format of
* @param string $project Required. Specifies the number or id of the project to
* get the effective KeyAccessJustificationsPolicyConfig. In the format of
* "projects/{|}"
* @param array $optParams Optional parameters.
* @return ShowEffectiveKeyAccessJustificationsPolicyConfigResponse
Expand Down Expand Up @@ -148,13 +148,14 @@ public function updateAutokeyConfig($name, AutokeyConfig $postBody, $optParams =
* Updates the KeyAccessJustificationsPolicyConfig for a given organization,
* folder, or project. (projects.updateKajPolicyConfig)
*
* @param string $name Identifier. The resource name for this
* @param string $name Identifier. Represents the resource name for this
* KeyAccessJustificationsPolicyConfig in the format of
* "{organizations|folders|projects}/kajPolicyConfig".
* @param KeyAccessJustificationsPolicyConfig $postBody
* @param array $optParams Optional parameters.
*
* @opt_param string updateMask Optional. The list of fields to update.
* @opt_param string updateMask Optional. Specifies the list of fields to
* update.
* @return KeyAccessJustificationsPolicyConfig
* @throws \Google\Service\Exception
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ class ShowEffectiveKeyAccessJustificationsEnrollmentConfigResponse extends \Goog
protected $softwareConfigDataType = '';

/**
* The effective KeyAccessJustificationsEnrollmentConfig for external keys.
* Contains the effective KeyAccessJustificationsEnrollmentConfig for external
* keys.
*
* @param KeyAccessJustificationsEnrollmentConfig $externalConfig
*/
Expand All @@ -43,7 +44,8 @@ public function getExternalConfig()
return $this->externalConfig;
}
/**
* The effective KeyAccessJustificationsEnrollmentConfig for hardware keys.
* Contains the effective KeyAccessJustificationsEnrollmentConfig for hardware
* keys.
*
* @param KeyAccessJustificationsEnrollmentConfig $hardwareConfig
*/
Expand All @@ -59,7 +61,8 @@ public function getHardwareConfig()
return $this->hardwareConfig;
}
/**
* The effective KeyAccessJustificationsEnrollmentConfig for software keys.
* Contains the effective KeyAccessJustificationsEnrollmentConfig for software
* keys.
*
* @param KeyAccessJustificationsEnrollmentConfig $softwareConfig
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class ShowEffectiveKeyAccessJustificationsPolicyConfigResponse extends \Google\M
protected $effectiveKajPolicyDataType = '';

/**
* The effective KeyAccessJustificationsPolicyConfig.
* Contains the effective KeyAccessJustificationsPolicyConfig.
*
* @param KeyAccessJustificationsPolicyConfig $effectiveKajPolicy
*/
Expand Down
Loading