Certificate Manager Private CA API, gRPC: PolicyService.Get
Returns the specified policy.
gRPC request
rpc Get (GetPolicyRequest) returns (Policy)
GetPolicyRequest
{
"id": "string"
}
Request message for getting a policy.
|
Field |
Description |
|
id |
string Required field. ID of the policy to retrieve. |
Policy
{
"id": "string",
"certificate_authority_id": "string",
"name": "string",
"subject_policy": {
"country": "string",
"organization": "string",
"organizational_unit": "string",
"distinguished_name_qualifier": "string",
"state_or_province": "string",
"common_name": "string",
"email_address": "string",
"serial_number": "string",
"locality": "string",
"title": "string",
"surname": "string",
"given_name": "string",
"initials": "string",
"generation_qualifier": "string"
},
"san_policy": {
"other_name_oid": "string",
"rfc_822_name": "string",
"dns_name": "string",
"directory_name": "string",
"edi_party_name": {
"name_assigner": "string",
"party_name": "string"
},
"uniform_resource_identifier": "string",
"ip_address": "string",
"registered_id": "string"
},
// Includes only one of the fields `key_usages_white_list`, `key_usages_black_list`
"key_usages_white_list": {
"key_usage": [
"KeyUsageExtension"
]
},
"key_usages_black_list": {
"key_usage": [
"KeyUsageExtension"
]
},
// end of the list of possible fields
// Includes only one of the fields `extended_key_usages_white_list`, `extended_key_usages_black_list`
"extended_key_usages_white_list": {
"extended_key_usage": [
"ExtendedKeyUsageExtension"
]
},
"extended_key_usages_black_list": {
"extended_key_usage": [
"ExtendedKeyUsageExtension"
]
},
// end of the list of possible fields
// Includes only one of the fields `extension_white_list`, `extension_black_list`
"extension_white_list": {
"extension_oid": [
"string"
]
},
"extension_black_list": {
"extension_oid": [
"string"
]
},
// end of the list of possible fields
"created_at": "google.protobuf.Timestamp",
"updated_at": "google.protobuf.Timestamp"
}
A policy defines the rules and constraints for issuing certificates within a certificate authority.
|
Field |
Description |
|
id |
string ID of the policy. |
|
certificate_authority_id |
string ID of the certificate authority the policy belongs to. |
|
name |
string Name of the policy. |
|
subject_policy |
Policy for the subject field of the certificate. |
|
san_policy |
Policy for the Subject Alternative Name (SAN) extension of the certificate. |
|
key_usages_white_list |
Whitelist of allowed key usages. Includes only one of the fields Policy for key usages. |
|
key_usages_black_list |
Blacklist of disallowed key usages. Includes only one of the fields Policy for key usages. |
|
extended_key_usages_white_list |
Whitelist of allowed extended key usages. Includes only one of the fields Policy for extended key usages. |
|
extended_key_usages_black_list |
Blacklist of disallowed extended key usages. Includes only one of the fields Policy for extended key usages. |
|
extension_white_list |
Whitelist of allowed extensions. Includes only one of the fields Policy for certificate extensions. |
|
extension_black_list |
Blacklist of disallowed extensions. Includes only one of the fields Policy for certificate extensions. |
|
created_at |
Timestamp when the policy was created. |
|
updated_at |
Timestamp when the policy was last updated. |
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. |
|
organizational_unit |
string Allowed organizational unit name in the subject field. |
|
distinguished_name_qualifier |
string Allowed distinguished name qualifier in the subject field. |
|
state_or_province |
string Allowed state or province name in the subject field. |
|
common_name |
string Allowed common name in the subject field. |
|
email_address |
string Allowed email address in the subject field. |
|
serial_number |
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. |
|
given_name |
string Allowed given name in the subject field. |
|
initials |
string Allowed initials in the subject field. |
|
generation_qualifier |
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 |
|
other_name_oid |
string Allowed OIDs of the other name in the SAN field. |
|
rfc_822_name |
string Allowed RFC 822 names (email addresses) in the SAN field. |
|
dns_name |
string Allowed DNS names in the SAN field. |
|
directory_name |
string Allowed directory names in the SAN field. |
|
edi_party_name |
Allowed EDI party names in the SAN field. |
|
uniform_resource_identifier |
string Allowed URIs in the SAN field. |
|
ip_address |
string Allowed IP addresses in the SAN field. |
|
registered_id |
string Allowed registered IDs in the SAN field. |
EdiPartyName
|
Field |
Description |
|
name_assigner |
string Specifies the entity or authority that assigned the partyName |
|
party_name |
string The actual identifier of the EDI party |
KeyUsagePolicy
Policy for key usages in a certificate.
|
Field |
Description |
|
key_usage[] |
enum KeyUsageExtension List of key usages that are allowed or disallowed.
|
ExtendedKeyUsagePolicy
Policy for extended key usages in a certificate.
|
Field |
Description |
|
extended_key_usage[] |
enum ExtendedKeyUsageExtension List of extended key usages that are allowed or disallowed.
|
ExtensionPolicy
Policy for certificate extensions.
|
Field |
Description |
|
extension_oid[] |
string List of extension OIDs that are allowed or disallowed. |