Id Authentication Internal Service (1.0)

Download OpenAPI specification:Download

License: Mosip

Id Authentication Internal Service

Authentication

Authorization

Security Scheme Type	API Key
Header parameter name:	Authorization

internal-update-auth-type-controller

Internal Update Auth Type Controller

updateAuthtypeStatus

path Parameters

partnerId

required

string

Request Body schema: application/json

publisher	string
topic	string
publishedOn	̥ "string"
	object (Event)

Responses

Request samples

Payload

Content type

application/json

{"publisher": "string",
"topic": "string",
"publishedOn": null,
"event": {"id": "string",
"transactionId": "string",
"type": {"namespace": "string",
"name": "string"
},
"timestamp": "string",
"dataShareUri": "string",
"data": {"property1": { },
"property2": { }
}
}
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"signature": "string",
"data": "string",
"timestamp": "2019-08-24T14:15:22Z"
}
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"data": "string"
}
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"applicationId": "string",
"referenceId": "string",
"timeStamp": "string",
"data": "string",
"lowerLeftX": 2147483647,
"lowerLeftY": 2147483647,
"upperRightX": 2147483647,
"upperRightY": 2147483647,
"reason": "string",
"pageNumber": 2147483647,
"password": "string"
}
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"jwtSignatureData": "string",
"actualData": "string",
"applicationId": "string",
"referenceId": "string",
"certificateData": "string",
"validateTrust": true,
"domain": "string"
}
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"dataToSign": "string",
"applicationId": "string",
"referenceId": "string",
"includePayload": true,
"includeCertificate": true,
"includeCertHash": true,
"certificateUrl": "string"
}
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"dataToSign": "string",
"applicationId": "string",
"referenceId": "string",
"includePayload": true,
"includeCertificate": true,
"includeCertHash": true,
"certificateUrl": "string",
"validateJson": true,
"b64JWSHeaderParam": true,
"signAlgorithm": "string"
}
}

cryptomanager

Operation related to Encryption and Decryption

Encrypt the data

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (CryptomanagerRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"applicationId": "string",
"referenceId": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"data": "string",
"salt": "string",
"aad": "string",
"prependThumbprint": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"data": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"data": "string",
"userPin": "string"
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"data": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"applicationId": "string",
"referenceId": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"data": "string",
"salt": "string",
"aad": "string",
"prependThumbprint": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"data": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

Decrypt the data

Request Body schema: application/json

id	string
version	string
requesttime	string <date-time>
metadata	object
required	object (CryptomanagerRequestDto)

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"applicationId": "string",
"referenceId": "string",
"timeStamp": "2019-08-24T14:15:22Z",
"data": "string",
"salt": "string",
"aad": "string",
"prependThumbprint": true
}
}

Response samples

200

Content type

application/json

{"id": "string",
"version": "string",
"responsetime": "2019-08-24T14:15:22Z",
"metadata": { },
"response": {"data": "string"
},
"errors": [{"errorCode": "string",
"message": "string"
}
]
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"data": "string",
"userPin": "string"
}
}

Response samples

200

Content type

application/json

{"id": "

Home

Id Authentication Internal Service (1.0)

Authentication

Authorization

internal-update-auth-type-controller

updateAuthtypeStatus

path Parameters

Request Body schema: application/json

Responses

Request samples

signaturecontroller

Function to validate signature Deprecated

Request Body schema: application/json

Responses

Request samples

Function to sign response Deprecated

Request Body schema: application/json

Responses

Request samples

Function to sign PDF

Request Body schema: application/json

Responses

Request samples

Function to JWT Signature verification

Request Body schema: application/json

Responses

Request samples

TFunction to JWT sign datas

Request Body schema: application/json

Responses

Request samples

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

Request Body schema: application/json

Responses

Request samples

cryptomanager

Encrypt the data

Request Body schema: application/json

Responses

Request samples

Response samples

Encrypt the data with pin

Request Body schema: application/json

Responses

Request samples

Response samples

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

Request Body schema: application/json

Responses

Request samples

Response samples

Decrypt the data

Request Body schema: application/json

Responses

Request samples

Response samples

Decrypt the data with pin

Request Body schema: application/json

Responses

Request samples

Response samples