// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="imagesignature-image-openshift-io-v1"]
= ImageSignature [image.openshift.io/v1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
ImageSignature holds a signature of an image. It allows to verify image identity and possibly other claims as long as the signature is trusted. Based on this information it is possible to restrict runnable images to those matching cluster-wide policy. Mandatory fields should be parsed by clients doing image verification. The others are parsed from signature's content by the server. They serve just an informative purpose.

Compatibility level 1: Stable within a major release for a minimum of 12 months or 3 minor releases (whichever is longer).
--

Type::
  `object`

Required::
  - `type`
  - `content`


== Specification

[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

| `conditions`
| `array`
| conditions represent the latest available observations of a signature's current state.

| `conditions[]`
| `object`
| SignatureCondition describes an image signature condition of particular kind at particular probe time.

| `content`
| `string`
| Required: An opaque binary string which is an image's signature.

| `created`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Time[`Time`]
| If specified, it is the time of signature's creation.

| `imageIdentity`
| `string`
| A human readable string representing image's identity. It could be a product name and version, or an image pull spec (e.g. "registry.access.redhat.com/rhel7/rhel:7.2").

| `issuedBy`
| `object`
| SignatureIssuer holds information about an issuer of signing certificate or key.

| `issuedTo`
| `object`
| SignatureSubject holds information about a person or entity who created the signature.

| `kind`
| `string`
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

| `metadata`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| metadata is the standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `signedClaims`
| `object (string)`
| Contains claims from the signature.

| `type`
| `string`
| Required: Describes a type of stored blob.

|===
=== .conditions
Description::
+
--
conditions represent the latest available observations of a signature's current state.
--

Type::
  `array`




=== .conditions[]
Description::
+
--
SignatureCondition describes an image signature condition of particular kind at particular probe time.
--

Type::
  `object`

Required::
  - `type`
  - `status`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `lastProbeTime`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Time[`Time`]
| Last time the condition was checked.

| `lastTransitionTime`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Time[`Time`]
| Last time the condition transit from one status to another.

| `message`
| `string`
| Human readable message indicating details about last transition.

| `reason`
| `string`
| (brief) reason for the condition's last transition.

| `status`
| `string`
| status of the condition, one of True, False, Unknown.

| `type`
| `string`
| type of signature condition, Complete or Failed.

|===
=== .issuedBy
Description::
+
--
SignatureIssuer holds information about an issuer of signing certificate or key.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `commonName`
| `string`
| Common name (e.g. openshift-signing-service).

| `organization`
| `string`
| organization name.

|===
=== .issuedTo
Description::
+
--
SignatureSubject holds information about a person or entity who created the signature.
--

Type::
  `object`

Required::
  - `publicKeyID`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `commonName`
| `string`
| Common name (e.g. openshift-signing-service).

| `organization`
| `string`
| organization name.

| `publicKeyID`
| `string`
| If present, it is a human readable key id of public key belonging to the subject used to verify image signature. It should contain at least 64 lowest bits of public key's fingerprint (e.g. 0x685ebe62bf278440).

|===

== API endpoints

The following API endpoints are available:

* `/apis/image.openshift.io/v1/imagesignatures`
- `POST`: create an ImageSignature
* `/apis/image.openshift.io/v1/imagesignatures/{name}`
- `DELETE`: delete an ImageSignature


=== /apis/image.openshift.io/v1/imagesignatures


.Global query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

HTTP method::
  `POST`

Description::
  create an ImageSignature



.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature`] schema
| 201 - Created
| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature`] schema
| 202 - Accepted
| xref:../image_apis/imagesignature-image-openshift-io-v1.adoc#imagesignature-image-openshift-io-v1[`ImageSignature`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/image.openshift.io/v1/imagesignatures/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ImageSignature
|===

.Global query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===

HTTP method::
  `DELETE`

Description::
  delete an ImageSignature




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status_v2[`Status_v2`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status_v2[`Status_v2`] schema
| 401 - Unauthorized
| Empty
|===


