Certificate Manager Private CA API, REST: Policy.Update

Статья создана

Обновлена 17 декабря 2024 г.

HTTP request
Path parameters
Body parameters
SubjectPolicy
SubjectAlternativeNamePolicy
EdiPartyName
KeyUsagePolicy
ExtendedKeyUsagePolicy
ExtensionPolicy
Response
UpdatePolicyMetadata
Status
Policy
SubjectPolicy
SubjectAlternativeNamePolicy
EdiPartyName
KeyUsagePolicy
ExtendedKeyUsagePolicy
ExtensionPolicy

Updates the specified policy.

Only the fields specified in the update_mask will be updated.

HTTP request

PATCH https://private-ca.certificate-manager.api.cloud.yandex.net/privateca/v1/policies/{id}

Path parameters

Request message for updating a policy.

Field

Description

string

Required field. ID of the policy to update.

Body parameters

{
  "name": "string",
  "subjectPolicy": {
    "country": "string",
    "organization": "string",
    "organizationalUnit": "string",
    "distinguishedNameQualifier": "string",
    "stateOrProvince": "string",
    "commonName": "string",
    "emailAddress": "string",
    "serialNumber": "string",
    "locality": "string",
    "title": "string",
    "surname": "string",
    "givenName": "string",
    "initials": "string",
    "generationQualifier": "string"
  },
  "sanPolicy": {
    "otherNameOid": "string",
    "rfc_822Name": "string",
    "dnsName": "string",
    "directoryName": "string",
    "ediPartyName": {
      "nameAssigner": "string",
      "partyName": "string"
    },
    "uniformResourceIdentifier": "string",
    "ipAddress": "string",
    "registeredId": "string"
  },
  // Includes only one of the fields `keyUsagesWhiteList`, `keyUsagesBlackList`
  "keyUsagesWhiteList": {
    "keyUsage": [
      "string"
    ]
  },
  "keyUsagesBlackList": {
    "keyUsage": [
      "string"
    ]
  },
  // end of the list of possible fields
  // Includes only one of the fields `extendedKeyUsagesWhiteList`, `extendedKeyUsagesBlackList`
  "extendedKeyUsagesWhiteList": {
    "extendedKeyUsage": [
      "string"
    ]
  },
  "extendedKeyUsagesBlackList": {
    "extendedKeyUsage": [
      "string"
    ]
  },
  // end of the list of possible fields
  // Includes only one of the fields `extensionWhiteList`, `extensionBlackList`
  "extensionWhiteList": {
    "extensionOid": [
      "string"
    ]
  },
  "extensionBlackList": {
    "extensionOid": [
      "string"
    ]
  },
  // end of the list of possible fields
  "updateMask": "object"
}

Request message for updating a policy.

Field	Description
name	string New name for the policy.
subjectPolicy	SubjectPolicy New policy for the subject field of the certificate.
sanPolicy	SubjectAlternativeNamePolicy New policy for the subject alternative name (SAN) field of the certificate.
keyUsagesWhiteList	KeyUsagePolicy Whitelist of allowed key usages. Includes only one of the fields `keyUsagesWhiteList`, `keyUsagesBlackList`. New policy for key usages.
keyUsagesBlackList	KeyUsagePolicy Blacklist of disallowed key usages. Includes only one of the fields `keyUsagesWhiteList`, `keyUsagesBlackList`. New policy for key usages.
extendedKeyUsagesWhiteList	ExtendedKeyUsagePolicy Whitelist of allowed extended key usages. Includes only one of the fields `extendedKeyUsagesWhiteList`, `extendedKeyUsagesBlackList`. New policy for extended key usages.
extendedKeyUsagesBlackList	ExtendedKeyUsagePolicy Blacklist of disallowed extended key usages. Includes only one of the fields `extendedKeyUsagesWhiteList`, `extendedKeyUsagesBlackList`. New policy for extended key usages.
extensionWhiteList	ExtensionPolicy Whitelist of allowed extensions. Includes only one of the fields `extensionWhiteList`, `extensionBlackList`. New policy for extensions.
extensionBlackList	ExtensionPolicy Blacklist of disallowed extensions. Includes only one of the fields `extensionWhiteList`, `extensionBlackList`. New policy for extensions.
updateMask	object (field-mask) A comma-separated names off ALL fields to be updated. Only the specified fields will be changed. The others will be left untouched. If the field is specified in `updateMask` and no value for that field was sent in the request, the field's value will be reset to the default. The default value for most fields is null or 0. If `updateMask` is not sent in the request, all fields' values will be updated. Fields specified in the request will be updated to provided values. The rest of the fields will be reset to the default.

SubjectPolicy

Policy for the subject field of a certificate. Each string field could be a regexp

Field	Description
country	string Allowed country name in the subject field.
organization	string Allowed organization name in the subject field.
organizationalUnit	string Allowed organizational unit name in the subject field.
distinguishedNameQualifier	string Allowed distinguished name qualifier in the subject field.
stateOrProvince	string Allowed state or province name in the subject field.
commonName	string Allowed common name in the subject field.
emailAddress	string Allowed email address in the subject field.
serialNumber	string Allowed serial number in the subject field.
locality	string Allowed locality name in the subject field.
title	string Allowed title in the subject field.
surname	string Allowed surname in the subject field.
givenName	string Allowed given name in the subject field.
initials	string Allowed initials in the subject field.
generationQualifier	string Allowed generation qualifier in the subject field.

SubjectAlternativeNamePolicy

Policy for the Subject Alternative Name (SAN) field of a certificate. Each string field could be a regexp

Field	Description
otherNameOid	string Allowed OIDs of the other name in the SAN field.
rfc_822Name	string Allowed RFC 822 names (email addresses) in the SAN field.
dnsName	string Allowed DNS names in the SAN field.
directoryName	string Allowed directory names in the SAN field.
ediPartyName	EdiPartyName Allowed EDI party names in the SAN field.
uniformResourceIdentifier	string Allowed URIs in the SAN field.
ipAddress	string Allowed IP addresses in the SAN field.
registeredId	string Allowed registered IDs in the SAN field.

EdiPartyName

Field

Description

nameAssigner

string

Specifies the entity or authority that assigned the partyName

partyName

string

The actual identifier of the EDI party

KeyUsagePolicy

Policy for key usages in a certificate.

Field

Description

keyUsage[]

enum (KeyUsageExtension)

List of key usages that are allowed or disallowed.

KEY_USAGE_EXTENSION_UNSPECIFIED
DIGITAL_SIGNATURE
CONTENT_COMMITMENT
KEY_ENCIPHERMENT
DATA_ENCIPHERMENT
KEY_AGREEMENT
KEY_CERT_SIGN
CRL_SIGN
ENCIPHER_ONLY
DECIPHER_ONLY

ExtendedKeyUsagePolicy

Policy for extended key usages in a certificate.

Field

Description

extendedKeyUsage[]

enum (ExtendedKeyUsageExtension)

List of extended key usages that are allowed or disallowed.

EXTENDED_KEY_USAGE_EXTENSION_UNSPECIFIED
SERVER_AUTH
CLIENT_AUTH
CODE_SIGNING
EMAIL_PROTECTION
TIME_STAMPING
OCSP_SIGNING
IPSEC_IKE
MS_CODE_IND
MS_CODE_COM
MS_CTL_SIGN
MS_EFS

ExtensionPolicy

Policy for certificate extensions.

Field

Description

extensionOid[]

string

List of extension OIDs that are allowed or disallowed.

Response

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "certificateAuthorityId": "string",
    "name": "string",
    "subjectPolicy": {
      "country": "string",
      "organization": "string",
      "organizationalUnit": "string",
      "distinguishedNameQualifier": "string",
      "stateOrProvince": "string",
      "commonName": "string",
      "emailAddress": "string",
      "serialNumber": "string",
      "locality": "string",
      "title": "string",
      "surname": "string",
      "givenName": "string",
      "initials": "string",
      "generationQualifier": "string"
    },
    "sanPolicy": {
      "otherNameOid": "string",
      "rfc_822Name": "string",
      "dnsName": "string",
      "directoryName": "string",
      "ediPartyName": {
        "nameAssigner": "string",
        "partyName": "string"
      },
      "uniformResourceIdentifier": "string",
      "ipAddress": "string",
      "registeredId": "string"
    },
    // Includes only one of the fields `keyUsagesWhiteList`, `keyUsagesBlackList`
    "keyUsagesWhiteList": {
      "keyUsage": [
        "string"
      ]
    },
    "keyUsagesBlackList": {
      "keyUsage": [
        "string"
      ]
    },
    // end of the list of possible fields
    // Includes only one of the fields `extendedKeyUsagesWhiteList`, `extendedKeyUsagesBlackList`
    "extendedKeyUsagesWhiteList": {
      "extendedKeyUsage": [
        "string"
      ]
    },
    "extendedKeyUsagesBlackList": {
      "extendedKeyUsage": [
        "string"
      ]
    },
    // end of the list of possible fields
    // Includes only one of the fields `extensionWhiteList`, `extensionBlackList`
    "extensionWhiteList": {
      "extensionOid": [
        "string"
      ]
    },
    "extensionBlackList": {
      "extensionOid": [
        "string"
      ]
    },
    // end of the list of possible fields
    "createdAt": "string",
    "updatedAt": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
createdAt	string (date-time) Creation timestamp. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
createdBy	string ID of the user or service account who initiated the operation.
modifiedAt	string (date-time) The time when the Operation resource was last modified. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
done	boolean If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
metadata	UpdatePolicyMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Policy The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

UpdatePolicyMetadata

Metadata for the UpdatePolicy operation.

Field

Description

string

ID of the policy being updated.

Status

The error result of the operation in case of failure or cancellation.

Field	Description
code	integer (int32) Error code. An enum value of google.rpc.Code.
message	string An error message.
details[]	object A list of messages that carry the error details.

Policy

A policy defines the rules and constraints for issuing certificates within a certificate authority.

Field	Description
id	string ID of the policy.
certificateAuthorityId	string ID of the certificate authority the policy belongs to.
name	string Name of the policy.
subjectPolicy	SubjectPolicy Policy for the subject field of the certificate.
sanPolicy	SubjectAlternativeNamePolicy Policy for the Subject Alternative Name (SAN) extension of the certificate.
keyUsagesWhiteList	KeyUsagePolicy Whitelist of allowed key usages. Includes only one of the fields `keyUsagesWhiteList`, `keyUsagesBlackList`. Policy for key usages.
keyUsagesBlackList	KeyUsagePolicy Blacklist of disallowed key usages. Includes only one of the fields `keyUsagesWhiteList`, `keyUsagesBlackList`. Policy for key usages.
extendedKeyUsagesWhiteList	ExtendedKeyUsagePolicy Whitelist of allowed extended key usages. Includes only one of the fields `extendedKeyUsagesWhiteList`, `extendedKeyUsagesBlackList`. Policy for extended key usages.
extendedKeyUsagesBlackList	ExtendedKeyUsagePolicy Blacklist of disallowed extended key usages. Includes only one of the fields `extendedKeyUsagesWhiteList`, `extendedKeyUsagesBlackList`. Policy for extended key usages.
extensionWhiteList	ExtensionPolicy Whitelist of allowed extensions. Includes only one of the fields `extensionWhiteList`, `extensionBlackList`. Policy for certificate extensions.
extensionBlackList	ExtensionPolicy Blacklist of disallowed extensions. Includes only one of the fields `extensionWhiteList`, `extensionBlackList`. Policy for certificate extensions.
createdAt	string (date-time) Timestamp when the policy was created. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).
updatedAt	string (date-time) Timestamp when the policy was last updated. String in RFC3339 text format. The range of possible values is from `0001-01-01T00:00:00Z` to `9999-12-31T23:59:59.999999999Z`, i.e. from 0 to 9 digits for fractions of a second. To work with values in this field, use the APIs described in the Protocol Buffers reference. In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

SubjectPolicy

Policy for the subject field of a certificate. Each string field could be a regexp

Field	Description
country	string Allowed country name in the subject field.
organization	string Allowed organization name in the subject field.
organizationalUnit	string Allowed organizational unit name in the subject field.
distinguishedNameQualifier	string Allowed distinguished name qualifier in the subject field.
stateOrProvince	string Allowed state or province name in the subject field.
commonName	string Allowed common name in the subject field.
emailAddress	string Allowed email address in the subject field.
serialNumber	string Allowed serial number in the subject field.
locality	string Allowed locality name in the subject field.
title	string Allowed title in the subject field.
surname	string Allowed surname in the subject field.
givenName	string Allowed given name in the subject field.
initials	string Allowed initials in the subject field.
generationQualifier	string Allowed generation qualifier in the subject field.

SubjectAlternativeNamePolicy

Policy for the Subject Alternative Name (SAN) field of a certificate. Each string field could be a regexp

Field	Description
otherNameOid	string Allowed OIDs of the other name in the SAN field.
rfc_822Name	string Allowed RFC 822 names (email addresses) in the SAN field.
dnsName	string Allowed DNS names in the SAN field.
directoryName	string Allowed directory names in the SAN field.
ediPartyName	EdiPartyName Allowed EDI party names in the SAN field.
uniformResourceIdentifier	string Allowed URIs in the SAN field.
ipAddress	string Allowed IP addresses in the SAN field.
registeredId	string Allowed registered IDs in the SAN field.

EdiPartyName

Field

Description

nameAssigner

string

Specifies the entity or authority that assigned the partyName

partyName

string

The actual identifier of the EDI party

KeyUsagePolicy

Policy for key usages in a certificate.

Field

Description

keyUsage[]

enum (KeyUsageExtension)

List of key usages that are allowed or disallowed.

KEY_USAGE_EXTENSION_UNSPECIFIED
DIGITAL_SIGNATURE
CONTENT_COMMITMENT
KEY_ENCIPHERMENT
DATA_ENCIPHERMENT
KEY_AGREEMENT
KEY_CERT_SIGN
CRL_SIGN
ENCIPHER_ONLY
DECIPHER_ONLY

ExtendedKeyUsagePolicy

Policy for extended key usages in a certificate.

Field

Description

extendedKeyUsage[]

enum (ExtendedKeyUsageExtension)

List of extended key usages that are allowed or disallowed.

EXTENDED_KEY_USAGE_EXTENSION_UNSPECIFIED
SERVER_AUTH
CLIENT_AUTH
CODE_SIGNING
EMAIL_PROTECTION
TIME_STAMPING
OCSP_SIGNING
IPSEC_IKE
MS_CODE_IND
MS_CODE_COM
MS_CTL_SIGN
MS_EFS

ExtensionPolicy

Policy for certificate extensions.

Field

Description

extensionOid[]

string

List of extension OIDs that are allowed or disallowed.

Certificate Manager Private CA API, REST: Policy.Update

HTTP requestHTTP request

Path parametersPath parameters

Body parametersBody parameters

SubjectPolicySubjectPolicy

SubjectAlternativeNamePolicySubjectAlternativeNamePolicy

EdiPartyNameEdiPartyName

KeyUsagePolicyKeyUsagePolicy

ExtendedKeyUsagePolicyExtendedKeyUsagePolicy

ExtensionPolicyExtensionPolicy

ResponseResponse

UpdatePolicyMetadataUpdatePolicyMetadata

StatusStatus

PolicyPolicy

SubjectPolicySubjectPolicy

SubjectAlternativeNamePolicySubjectAlternativeNamePolicy

EdiPartyNameEdiPartyName

KeyUsagePolicyKeyUsagePolicy

ExtendedKeyUsagePolicyExtendedKeyUsagePolicy

ExtensionPolicyExtensionPolicy

Была ли статья полезна?

HTTP request

Path parameters

Body parameters

SubjectPolicy

SubjectAlternativeNamePolicy

EdiPartyName

KeyUsagePolicy

ExtendedKeyUsagePolicy

ExtensionPolicy

Response

UpdatePolicyMetadata

Status

Policy

SubjectPolicy

SubjectAlternativeNamePolicy

EdiPartyName

KeyUsagePolicy

ExtendedKeyUsagePolicy

ExtensionPolicy