1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
# OpenbaoClient::PkiPatchRoleResponse
## Properties
| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **allow_any_name** | **Boolean** | If set, clients can request certificates for any domain, regardless of allowed_domains restrictions. See the documentation for more information. | [optional] |
| **allow_bare_domains** | **Boolean** | If set, clients can request certificates for the base domains themselves, e.g. \"example.com\" of domains listed in allowed_domains. This is a separate option as in some cases this can be considered a security threat. See the documentation for more information. | [optional] |
| **allow_glob_domains** | **Boolean** | If set, domains specified in allowed_domains can include shell-style glob patterns, e.g. \"ftp*.example.com\". See the documentation for more information. | [optional] |
| **allow_ip_sans** | **Boolean** | If set, IP Subject Alternative Names are allowed. Any valid IP is accepted and No authorization checking is performed. | [optional] |
| **allow_localhost** | **Boolean** | Whether to allow \"localhost\" and \"localdomain\" as a valid common name in a request, independent of allowed_domains value. | [optional] |
| **allow_subdomains** | **Boolean** | If set, clients can request certificates for subdomains of domains listed in allowed_domains, including wildcard subdomains. See the documentation for more information. | [optional] |
| **allow_token_displayname** | **Boolean** | Whether to allow \"localhost\" and \"localdomain\" as a valid common name in a request, independent of allowed_domains value. | [optional] |
| **allow_wildcard_certificates** | **Boolean** | If set, allows certificates with wildcards in the common name to be issued, conforming to RFC 6125's Section 6.4.3; e.g., \"*.example.net\" or \"b*z.example.net\". See the documentation for more information. | [optional] |
| **allowed_domains** | **Array<String>** | Specifies the domains this role is allowed to issue certificates for. This is used with the allow_bare_domains, allow_subdomains, and allow_glob_domains to determine matches for the common name, DNS-typed SAN entries, and Email-typed SAN entries of certificates. See the documentation for more information. This parameter accepts a comma-separated string or list of domains. | [optional] |
| **allowed_domains_template** | **Boolean** | If set, Allowed domains can be specified using identity template policies. Non-templated domains are also permitted. | [optional] |
| **allowed_other_sans** | **Array<String>** | If set, an array of allowed other names to put in SANs. These values support globbing and must be in the format <oid>;<type>:<value>. Currently only \"utf8\" is a valid type. All values, including globbing values, must use this syntax, with the exception being a single \"*\" which allows any OID and any value (but type must still be utf8). | [optional] |
| **allowed_serial_numbers** | **Array<String>** | If set, an array of allowed serial numbers to put in Subject. These values support globbing. | [optional] |
| **allowed_uri_sans** | **Array<String>** | If set, an array of allowed URIs for URI Subject Alternative Names. Any valid URI is accepted, these values support globbing. | [optional] |
| **allowed_uri_sans_template** | **Boolean** | If set, Allowed URI SANs can be specified using identity template policies. Non-templated URI SANs are also permitted. | [optional] |
| **allowed_user_ids** | **Array<String>** | If set, an array of allowed user-ids to put in user system login name specified here: https://www.rfc-editor.org/rfc/rfc1274#section-9.3.1 | [optional] |
| **basic_constraints_valid_for_non_ca** | **Boolean** | Mark Basic Constraints valid when issuing non-CA certificates. | [optional] |
| **client_flag** | **Boolean** | If set, certificates are flagged for client auth use. Defaults to true. See also RFC 5280 Section 4.2.1.12. | [optional] |
| **cn_validations** | **Array<String>** | List of allowed validations to run against the Common Name field. Values can include 'email' to validate the CN is a email address, 'hostname' to validate the CN is a valid hostname (potentially including wildcards). When multiple validations are specified, these take OR semantics (either email OR hostname are allowed). The special value 'disabled' allows disabling all CN name validations, allowing for arbitrary non-Hostname, non-Email address CNs. | [optional] |
| **code_signing_flag** | **Boolean** | If set, certificates are flagged for code signing use. Defaults to false. See also RFC 5280 Section 4.2.1.12. | [optional] |
| **country** | **Array<String>** | If set, Country will be set to this value in certificates issued by this role. | [optional] |
| **email_protection_flag** | **Boolean** | If set, certificates are flagged for email protection use. Defaults to false. See also RFC 5280 Section 4.2.1.12. | [optional] |
| **enforce_hostnames** | **Boolean** | If set, only valid host names are allowed for CN and DNS SANs, and the host part of email addresses. Defaults to true. | [optional] |
| **ext_key_usage** | **Array<String>** | A comma-separated string or list of extended key usages. Valid values can be found at https://golang.org/pkg/crypto/x509/#ExtKeyUsage -- simply drop the \"ExtKeyUsage\" part of the name. To remove all key usages from being set, set this value to an empty list. See also RFC 5280 Section 4.2.1.12. | [optional] |
| **ext_key_usage_oids** | **Array<String>** | A comma-separated string or list of extended key usage oids. | [optional] |
| **generate_lease** | **Boolean** | If set, certificates issued/signed against this role will have OpenBao leases attached to them. Defaults to \"false\". Certificates can be added to the CRL by \"bao revoke <lease_id>\" when certificates are associated with leases. It can also be done using the \"pki/revoke\" endpoint. However, when lease generation is disabled, invoking \"pki/revoke\" would be the only way to add the certificates to the CRL. When large number of certificates are generated with long lifetimes, it is recommended that lease generation be disabled, as large amount of leases adversely affect the startup time of OpenBao. | [optional] |
| **issuer_ref** | **String** | Reference to the issuer used to sign requests serviced by this role. | [optional] |
| **key_bits** | **Integer** | The number of bits to use. Allowed values are 0 (universal default); with rsa key_type: 2048 (default), 3072, or 4096; with ec key_type: 224, 256 (default), 384, or 521; ignored with ed25519. | [optional] |
| **key_type** | **String** | The type of key to use; defaults to RSA. \"rsa\" \"ec\", \"ed25519\" and \"any\" are the only valid values. | [optional] |
| **key_usage** | **Array<String>** | A comma-separated string or list of key usages (not extended key usages). Valid values can be found at https://golang.org/pkg/crypto/x509/#KeyUsage -- simply drop the \"KeyUsage\" part of the name. To remove all key usages from being set, set this value to an empty list. See also RFC 5280 Section 4.2.1.3. | [optional] |
| **locality** | **Array<String>** | If set, Locality will be set to this value in certificates issued by this role. | [optional] |
| **max_ttl** | **Integer** | The maximum allowed lease duration. If not set, defaults to the system maximum lease TTL. | [optional] |
| **no_store** | **Boolean** | If set, certificates issued/signed against this role will not be stored in the storage backend. This can improve performance when issuing large numbers of certificates. However, certificates issued in this way cannot be enumerated or revoked, so this option is recommended only for certificates that are non-sensitive, or extremely short-lived. This option implies a value of \"false\" for \"generate_lease\". | [optional] |
| **not_after** | **String** | Set the not after field of the certificate with specified date value. The value format should be given in UTC format YYYY-MM-ddTHH:MM:SSZ. | [optional] |
| **not_before_duration** | **Integer** | The duration in seconds before now which the certificate needs to be backdated by. | [optional] |
| **organization** | **Array<String>** | If set, O (Organization) will be set to this value in certificates issued by this role. | [optional] |
| **ou** | **Array<String>** | If set, OU (OrganizationalUnit) will be set to this value in certificates issued by this role. | [optional] |
| **policy_identifiers** | **Array<String>** | A comma-separated string or list of policy OIDs, or a JSON list of qualified policy information, which must include an oid, and may include a notice and/or cps url, using the form [{\"oid\"=\"1.3.6.1.4.1.7.8\",\"notice\"=\"I am a user Notice\"}, {\"oid\"=\"1.3.6.1.4.1.44947.1.2.4 \",\"cps\"=\"https://example.com\"}]. | [optional] |
| **postal_code** | **Array<String>** | If set, Postal Code will be set to this value in certificates issued by this role. | [optional] |
| **province** | **Array<String>** | If set, Province will be set to this value in certificates issued by this role. | [optional] |
| **require_cn** | **Boolean** | If set to false, makes the 'common_name' field optional while generating a certificate. | [optional] |
| **server_flag** | **Boolean** | If set, certificates are flagged for server auth use. Defaults to true. See also RFC 5280 Section 4.2.1.12. | [optional][default to true] |
| **signature_bits** | **Integer** | The number of bits to use in the signature algorithm; accepts 256 for SHA-2-256, 384 for SHA-2-384, and 512 for SHA-2-512. Defaults to 0 to automatically detect based on key length (SHA-2-256 for RSA keys, and matching the curve size for NIST P-Curves). | [optional] |
| **street_address** | **Array<String>** | If set, Street Address will be set to this value in certificates issued by this role. | [optional] |
| **ttl** | **Integer** | The lease duration (validity period of the certificate) if no specific lease duration is requested. The lease duration controls the expiration of certificates issued by this backend. Defaults to the system default value or the value of max_ttl, whichever is shorter. | [optional] |
| **use_csr_common_name** | **Boolean** | If set, when used with a signing profile, the common name in the CSR will be used. This does *not* include any requested Subject Alternative Names; use use_csr_sans for that. Defaults to true. | [optional] |
| **use_csr_sans** | **Boolean** | If set, when used with a signing profile, the SANs in the CSR will be used. This does *not* include the Common Name (cn); use use_csr_common_name for that. Defaults to true. | [optional] |
| **use_pss** | **Boolean** | Whether or not to use PSS signatures when using a RSA key-type issuer. Defaults to false. | [optional] |
## Example
```ruby
require 'openbao_client'
instance = OpenbaoClient::PkiPatchRoleResponse.new(
allow_any_name: null,
allow_bare_domains: null,
allow_glob_domains: null,
allow_ip_sans: null,
allow_localhost: null,
allow_subdomains: null,
allow_token_displayname: null,
allow_wildcard_certificates: null,
allowed_domains: null,
allowed_domains_template: null,
allowed_other_sans: null,
allowed_serial_numbers: null,
allowed_uri_sans: null,
allowed_uri_sans_template: null,
allowed_user_ids: null,
basic_constraints_valid_for_non_ca: null,
client_flag: null,
cn_validations: null,
code_signing_flag: null,
country: null,
email_protection_flag: null,
enforce_hostnames: null,
ext_key_usage: null,
ext_key_usage_oids: null,
generate_lease: null,
issuer_ref: null,
key_bits: null,
key_type: null,
key_usage: null,
locality: null,
max_ttl: null,
no_store: null,
not_after: null,
not_before_duration: null,
organization: null,
ou: null,
policy_identifiers: null,
postal_code: null,
province: null,
require_cn: null,
server_flag: null,
signature_bits: null,
street_address: null,
ttl: null,
use_csr_common_name: null,
use_csr_sans: null,
use_pss: null
)
```
|
