Home

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