Home
Documentation Powered by ReDoc

Key Manager Service (1.0)

Download OpenAPI specification:Download

License: Mosip

Rest Endpoints for operations related to key management and crypto operations

signaturecontroller

Operation related to signature

Function to validate signature Deprecated

Function to validate signature

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (TimestampRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Function to sign response Deprecated

Function to sign response

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (SignRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Function to sign PDF

Function to sign PDF

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (PDFSignatureRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Function to JWT Signature verification

Function to JWT Signature verification

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (JWTSignatureVerifyRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

TFunction to JWT sign datas

Function to JWT sign data

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (JWTSignatureRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Function to do JSON Web Signature(JWS) for the inputted data using inputted algorithm. Default Algorithm PS256.

Function to JWT sign data

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (JWSSignatureRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

tokenidgenerator

Operation related to tokenid generator

Function to generate token id

Function to generate token id

path Parameters
uin
required
string
partnercode
required
string

Responses

clientcrypto

Operation related to offline Encryption and Decryption

Get signinging public key

Get signinging public key

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (PublicKeyRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Get encryption public key

Get encryption public key

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (PublicKeyRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Encrypt data using tpm

Encrypt data using tpm

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (TpmCryptoRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Decrypt data using tpm

Decrypt data using tpm

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (TpmCryptoRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Verify signature

Verify signature

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (TpmSignVerifyRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Sign data using tpm

Sign data using tpm

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (TpmSignRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

cryptomanager

Operation related to Encryption and Decryption

Encrypt the data

Encrypt the data

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CryptomanagerRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Encrypt the data with pin

Encrypt the data with pin

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CryptoWithPinRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Encrypt the data & encrypt hash of the data with same session key

Encrypt the data & encrypt hash of the data with same session key

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CryptomanagerRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Decrypt the data

Decrypt the data

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CryptomanagerRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Decrypt the data with pin

Decrypt the data with pin

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CryptoWithPinRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Decrypt the data & encrypt hash of the data with same session key

Decrypt the data & encrypt hash of the data with same session key

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CryptomanagerRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

zkcryptomanager

Operation related to Zero Knowledge Encryption and Decryption

Endpoint for Decrypt the data

Endpoint for Decrypt the data

query Parameters
encryptedKey
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Endpoint for Encrypt the data

Endpoint for Encrypt the data

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ZKCryptoRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Endpoint for Decrypt the data

Endpoint for Decrypt the data

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ZKCryptoRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

keymanager

Operation related to Keymanagement

Update signed certificate for the provided APP ID & REF ID for other domains

Update signed certificate for the provided APP ID & REF ID for other domains

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (UploadCertificateRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Update signed certificate for the provided APP ID & REF ID

Update signed certificate for the provided APP ID & REF ID

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (UploadCertificateRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Request to Revoke Base Key for the provided APP ID & REF ID

Request to Revoke Base Key for the provided APP ID & REF ID

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (RevokeKeyRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Request to get Certificate for the Provided APP ID & REF ID

Request to get Certificate for the Provided APP ID & REF ID

query Parameters
applicationId
required
string
referenceId
string

Responses

Request to Generate Symmetric key for the provided APP ID & REF ID

Request to Generate Symmetric key for the provided APP ID & REF ID

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (SymmetricKeyGenerateRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Generate Master Key for the provided APP ID

Generate Master Key for the provided APP ID

path Parameters
objectType
required
string
Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (KeyPairGenerateRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Request to Generate CSR for the provided APP ID & REF ID along with other certificate params

Request to Generate CSR for the provided APP ID & REF ID along with other certificate params

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CSRGenerateRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

partnercertmanager

Operation related to partner certificate management

To Upload Partner Certificate

To Upload Partner Certificate

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CertificateTrustRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

To Upload Partner Certificate

To Upload Partner Certificate

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (PartnerCertificateRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

To Upload CA/Sub-CA certificates

To Upload CA/Sub-CA certificates

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (CACertificateRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

To Download Partner Certificate

To Download Partner Certificate

path Parameters
partnerCertId
required
string

Responses

keymigrator

Operation related to Key Migration from one HSM to another HSM

Controller for migrating ZK keys

Controller for migrating ZK keys

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (ZKKeyMigrateRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Controller for migrating base key

Controller for migrating base key

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (KeyMigrateBaseKeyRequestDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

Controller to get the certificate for migrating ZK keys

Controller to get the certificate for migrating ZK keys

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "responsetime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "response": {
    },
  • "errors": [
    ]
}

licensekey

Operation related to License Key Management

This method will fetch the mapped permissions for a license key

Endpoint for Encrypt the data

query Parameters
tspId
required
string
licenseKey
required
string

Responses

This method will map license key to several permissions. The permissions provided must be present in the master list

Endpoint for Encrypt the data

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (LicenseKeyMappingDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}

This method will generate license key against a certain TSP ID

Endpoint for Encrypt the data

Request Body schema: application/json
id
string
version
string
requesttime
string <date-time>
metadata
object
required
object (LicenseKeyGenerationDto)

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "version": "string",
  • "requesttime": "2019-08-24T14:15:22Z",
  • "metadata": { },
  • "request": {
    }
}
Home