cacertificate : CA Certificate object.¶
An CA Certificate object represents a CA certificate description.
Object Reference¶
References to cacertificate are object references. The name part of a cacertificate object reference has the following components:
The certificate subject name.
Example: cacertificate/SW5mb2Jsb3ggQXBwbGlhbmNl:some_authority
Restrictions¶
The object does not support the following operations:
Create (insert)
Modify (update)
Global search (searches via the search object)
Scheduling
CSV export
The object cannot be managed on Cloud Platform members.
Fields¶
These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.
The basic version of the object contains the field(s): distinguished_name, issuer, serial, used_by, valid_not_after, valid_not_before.
distinguished_name¶
- distinguished_name¶
The certificate subject name.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The distinguished_name is part of the base object.
The distinguished_name cannot be updated.
distinguished_name cannot be written.
issuer¶
- issuer¶
The certificate issuer subject name.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The issuer is part of the base object.
The issuer cannot be updated.
issuer cannot be written.
serial¶
- serial¶
The certificate serial number in hex format.
Type
String.
Search
The field is available for search via
‘=’ (exact equality)
Notes
The serial is part of the base object.
The serial cannot be updated.
serial cannot be written.
used_by¶
- used_by¶
Information about the CA certificate usage.
Type
String.
Search
The field is not available for search.
Notes
The used_by is part of the base object.
The used_by cannot be updated.
used_by cannot be written.
valid_not_after¶
- valid_not_after¶
The date after which the certificate becomes invalid.
Type
Timestamp.
Search
The field is not available for search.
Notes
The valid_not_after is part of the base object.
The valid_not_after cannot be updated.
valid_not_after cannot be written.
valid_not_before¶
- valid_not_before¶
The date before which the certificate is not valid.
Type
Timestamp.
Search
The field is not available for search.
Notes
The valid_not_before is part of the base object.
The valid_not_before cannot be updated.
valid_not_before cannot be written.
Fields List¶
Field |
Type |
Req |
R/O |
Base |
Search |
|---|---|---|---|---|---|
distinguished_name |
String |
N |
Y |
Y |
= |
issuer |
String |
N |
Y |
Y |
= |
serial |
String |
N |
Y |
Y |
= |
used_by |
String |
N |
Y |
Y |
N/A |
valid_not_after |
Timestamp |
N |
Y |
Y |
N/A |
valid_not_before |
Timestamp |
N |
Y |
Y |
N/A |
