- [Resource: ImportJob](https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob)
  - [JSON representation](https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob.SCHEMA_REPRESENTATION)
- [ImportMethod](https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportMethod)
- [ImportJobState](https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJobState)
- [WrappingPublicKey](https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#WrappingPublicKey)
  - [JSON representation](https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#WrappingPublicKey.SCHEMA_REPRESENTATION)
- [PublicKeyFormat](https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#PublicKeyFormat)
- [Methods](https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#METHODS_SUMMARY)

## Resource: ImportJob

An `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob` can be used to create `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKey` and `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions#CryptoKeyVersion` using pre-existing key material, generated outside of Cloud KMS.

When an `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob` is created, Cloud KMS will generate a "wrapping key", which is a public/private key pair. You use the wrapping key to encrypt (also known as wrap) the pre-existing key material to protect it during the import process. The nature of the wrapping key depends on the choice of `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob.FIELDS.import_method`. When the wrapping key generation is complete, the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob.FIELDS.state` will be set to `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJobState.ENUM_VALUES.ACTIVE` and the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob.FIELDS.public_key` can be fetched. The fetched public key can then be used to wrap your pre-existing key material.

Once the key material is wrapped, it can be imported into a new `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions#CryptoKeyVersion` in an existing `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKey` by calling `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions/import#google.cloud.kms.v1.KeyManagementService.ImportCryptoKeyVersion`. Multiple `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions#CryptoKeyVersion` can be imported with a single `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob`. Cloud KMS uses the private key portion of the wrapping key to unwrap the key material. Only Cloud KMS has access to the private key.

An `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob` expires 3 days after it is created. Once expired, Cloud KMS will no longer be able to import or unwrap any key material that was wrapped with the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob`'s public key.

For more information, see [Importing a key](https://cloud.google.com/kms/docs/importing-a-key).

| JSON representation |
|---|
| ``` { "name": string, "importMethod": enum (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportMethod`), "protectionLevel": enum (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/ProtectionLevel`), "createTime": string, "generateTime": string, "expireTime": string, "expireEventTime": string, "state": enum (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJobState`), "publicKey": { object (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#WrappingPublicKey`) }, "publicKeyFormat": enum (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#PublicKeyFormat`), "attestation": { object (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/KeyOperationAttestation`) }, "cryptoKeyBackend": string } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. The resource name for this `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob` in the format `projects/*/locations/*/keyRings/*/importJobs/*`. |
| `importMethod` | ``enum (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportMethod`)`` Required. Immutable. The wrapping method to be used for incoming key material. |
| `protectionLevel` | ``enum (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/ProtectionLevel`)`` Required. Immutable. The protection level of the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob`. This must match the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/ProtectionLevel` of the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKey.FIELDS.version_template` on the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys#CryptoKey` you attempt to import into. |
| `createTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time at which this `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob` was created. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `generateTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time this `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob`'s key material was generated. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `expireTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time at which this `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob` is scheduled for expiration and can no longer be used to import key material. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `expireEventTime` | ``string (`https://protobuf.dev/reference/protobuf/google.protobuf#timestamp` format)`` Output only. The time this `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob` expired. Only present if `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob.FIELDS.state` is `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJobState.ENUM_VALUES.EXPIRED`. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: `"2014-10-02T15:01:23Z"`, `"2014-10-02T15:01:23.045123456Z"` or `"2014-10-02T15:01:23+05:30"`. |
| `state` | ``enum (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJobState`)`` Output only. The current state of the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob`, indicating if it can be used. |
| `publicKey` | ``object (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#WrappingPublicKey`)`` Output only. The public key with which to wrap key material prior to import. Only returned if `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob.FIELDS.state` is `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJobState.ENUM_VALUES.ACTIVE`. |
| `publicKeyFormat` | ``enum (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#PublicKeyFormat`)`` Output only. Specifies the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#WrappingPublicKey` format provided by the customer in the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs/get#google.cloud.kms.v1.KeyManagementService.GetImportJob` request. |
| `attestation` | ``object (`https://docs.cloud.google.com/kms/docs/reference/rest/v1/KeyOperationAttestation`)`` Output only. Statement that was generated and signed by the key creator (for example, an HSM) at key creation time. Use this statement to verify attributes of the key as stored on the HSM, independently of Google. Only present if the chosen `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportMethod` is one with a protection level of `https://docs.cloud.google.com/kms/docs/reference/rest/v1/ProtectionLevel#ENUM_VALUES.HSM`. |
| `cryptoKeyBackend` | `string` Immutable. The resource name of the backend environment where the key material for the wrapping key resides and where all related cryptographic operations are performed. This field is only populated for keys stored in HSM_SINGLE_TENANT. Note, this list is non-exhaustive. Supported resources: \* `"projects/*/locations/*/singleTenantHsmInstances/*"` |

## ImportMethod

`https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportMethod` describes the key wrapping method chosen for this `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob`.

| Enums ||
|---|---|
| `IMPORT_METHOD_UNSPECIFIED` | Not specified. |
| `RSA_OAEP_3072_SHA1_AES_256` | This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard. In summary, this involves wrapping the raw key with an ephemeral AES key, and wrapping the ephemeral AES key with a 3072 bit RSA key. For more details, see [RSA AES key wrap mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908). |
| `RSA_OAEP_4096_SHA1_AES_256` | This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard. In summary, this involves wrapping the raw key with an ephemeral AES key, and wrapping the ephemeral AES key with a 4096 bit RSA key. For more details, see [RSA AES key wrap mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908). |
| `RSA_OAEP_3072_SHA256_AES_256` | This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard. In summary, this involves wrapping the raw key with an ephemeral AES key, and wrapping the ephemeral AES key with a 3072 bit RSA key. For more details, see [RSA AES key wrap mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908). |
| `RSA_OAEP_4096_SHA256_AES_256` | This ImportMethod represents the CKM_RSA_AES_KEY_WRAP key wrapping scheme defined in the PKCS #11 standard. In summary, this involves wrapping the raw key with an ephemeral AES key, and wrapping the ephemeral AES key with a 4096 bit RSA key. For more details, see [RSA AES key wrap mechanism](http://docs.oasis-open.org/pkcs11/pkcs11-curr/v2.40/cos01/pkcs11-curr-v2.40-cos01.html#_Toc408226908). |
| `RSA_OAEP_3072_SHA256` | This ImportMethod represents RSAES-OAEP with a 3072 bit RSA key. The key material to be imported is wrapped directly with the RSA key. Due to technical limitations of RSA wrapping, this method cannot be used to wrap RSA keys for import. |
| `RSA_OAEP_4096_SHA256` | This ImportMethod represents RSAES-OAEP with a 4096 bit RSA key. The key material to be imported is wrapped directly with the RSA key. Due to technical limitations of RSA wrapping, this method cannot be used to wrap RSA keys for import. |
| `HPKE_KEM_ML_KEM_768_HKDF_SHA256_AES_256_GCM` | Represents the Hybrid Public Key Encryption (HPKE) Scheme originally defined in [RFC 9180](https://www.rfc-editor.org/rfc/rfc9180). It involves wrapping the raw key with an ephemeral AES key, derived with HKDF-SHA256 from an encryption context, that is, in turn obtained from the receiver's public key with the help of the ML-KEM-768 KEM. For more details, see the [ML-KEM HPKE standard](http://datatracker.ietf.org/doc/draft-ietf-hpke-pq/01/). |
| `HPKE_KEM_ML_KEM_1024_HKDF_SHA256_AES_256_GCM` | Represents the Hybrid Public Key Encryption (HPKE) Scheme originally defined in [RFC 9180](https://www.rfc-editor.org/rfc/rfc9180). It involves wrapping the raw key with an ephemeral AES key, derived with HKDF-SHA256 from an encryption context, that is, in turn obtained from the receiver's public key with the help of the ML-KEM-1024 KEM. For more details, see the [ML-KEM HPKE standard](http://datatracker.ietf.org/doc/draft-ietf-hpke-pq/01/). |
| `HPKE_KEM_XWING_HKDF_SHA256_AES_256_GCM` | Represents the Hybrid Public Key Encryption (HPKE) Scheme originally defined in [RFC 9180](https://www.rfc-editor.org/rfc/rfc9180). It involves wrapping the raw key with an ephemeral AES key, derived with HKDF-SHA256 from an encryption context, that is, in turn obtained from the receiver's public key with the help of the X-Wing hybrid KEM. For more details, see the [X-Wing standard](http://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem/09/). |

## ImportJobState

The state of the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob`, indicating if it can be used.

| Enums ||
|---|---|
| `IMPORT_JOB_STATE_UNSPECIFIED` | Not specified. |
| `PENDING_GENERATION` | The wrapping key for this job is still being generated. It may not be used. Cloud KMS will automatically mark this job as `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJobState.ENUM_VALUES.ACTIVE` as soon as the wrapping key is generated. |
| `ACTIVE` | This job may be used in `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys/create#google.cloud.kms.v1.KeyManagementService.CreateCryptoKey` and `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions/create#google.cloud.kms.v1.KeyManagementService.CreateCryptoKeyVersion` requests. |
| `EXPIRED` | This job can no longer be used and may not leave this state once entered. |

## WrappingPublicKey

The public key component of the wrapping key. For details of the type of key this public key corresponds to, see the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportMethod`.

| JSON representation |
|---|
| ``` { "pem": string, "data": string } ``` |

| Fields ||
|---|---|
| `pem` | `string` The public key, encoded in PEM format. For more information, see the [RFC 7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info](https://tools.ietf.org/html/rfc7468#section-13). This field gets populated by default for RSA-based import methods, if no publicKeyFormat is specified in the request. If you want to retrieve the wrapping key of an `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob` in some other format, use `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs/get#google.cloud.kms.v1.KeyManagementService.GetImportJob` and set the publicKeyFormat to the desired public key format. |
| `data` | `string (https://developers.google.com/discovery/v1/type-format format)` Output only. Contains the public key, formatted according to the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#PublicKeyFormat` specified in the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs/get#google.cloud.kms.v1.KeyManagementService.GetImportJob` request. A base64-encoded string. |

## PublicKeyFormat

The supported `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions/getPublicKey#body.PublicKey` formats.

| Enums ||
|---|---|
| `PUBLIC_KEY_FORMAT_UNSPECIFIED` | If the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions/getPublicKey#body.QUERY_PARAMETERS.public_key_format` field is not specified: - For PQC algorithms, an error will be returned. - For non-PQC algorithms, the default format is PEM, and the field `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions/getPublicKey#body.PublicKey.FIELDS.pem` will be populated. Otherwise, the public key will be exported through the `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.cryptoKeys.cryptoKeyVersions/getPublicKey#body.PublicKey.FIELDS.public_key` field in the requested format. |
| `PEM` | The returned public key will be encoded in PEM format. See the [RFC7468](https://tools.ietf.org/html/rfc7468) sections for [General Considerations](https://tools.ietf.org/html/rfc7468#section-2) and [Textual Encoding of Subject Public Key Info](https://tools.ietf.org/html/rfc7468#section-13) for more information. |
| `DER` | The returned public key will be encoded in DER format (the PrivateKeyInfo structure from RFC 5208). |
| `NIST_PQC` | This is supported only for PQC algorithms. The key material is returned in the format defined by NIST PQC standards (FIPS 203, FIPS 204, and FIPS 205). |
| `XWING_RAW_BYTES` | The returned public key is in raw bytes format defined in its standard <https://datatracker.ietf.org/doc/draft-connolly-cfrg-xwing-kem>. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs/create` | Create a new `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob` within a `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings#KeyRing`. |
| ### `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs/get` | Returns metadata for a given `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob`. |
| ### `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs/getIamPolicy` | Gets the access control policy for a resource. |
| ### `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs/list` | Lists `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs#ImportJob`. |
| ### `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs/setIamPolicy` | Sets the access control policy on the specified resource. |
| ### `https://docs.cloud.google.com/kms/docs/reference/rest/v1/projects.locations.keyRings.importJobs/testIamPermissions` | Returns permissions that a caller has on the specified resource. |