Home

Partner Management Services API documentation (1.0)

Download OpenAPI specification:Download

License: Mosip

Partner Management Services API documentation

secure-biometric-interface-controller

Service to update SecureBiometricInterface

Updates SecureBiometricInterface and returns success message

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

Responses

Request samples

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

Service to save SecureBiometricInterfaceCreateDto

Saves SecureBiometricInterfaceCreateDto and return DeviceDetail id

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

Responses

Request samples

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

Service to approve/reject SecureBiometricInterface

Approve SecureBiometricInterface and returns success message

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

Responses

Request samples

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

Service to search SecureBiometricInterface details

Service to search SecureBiometricInterface details

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

Responses

Request samples

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

Service to filter SBI's

Service to filter SBI's

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

Responses

Request samples

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

Service to map device details with sbi

Service to map device details with sbi

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

Responses

Request samples

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

Service to search mapped device details and SecureBiometricInterface details

Service to search mapped device details and SecureBiometricInterface details

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

Responses

Request samples

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

Service to remove mapped device details with sbi

Service to remove mapped device details with sbi

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

Responses

Request samples

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

role-controller

getRequiredRoles

Responses

partner-management-controller

Service to get partner details

Service to get partner details

query Parameters
partnerType
string

Responses

Service to activate/de-activate partner

Service to activate/de-activate partner

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

Responses

Request samples

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

Service to activate/de-activate partner api key

Service to activate/de-activate partner api key

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

Responses

Request samples

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

Service to get policy for given api key

Service to get policy for given api key

path Parameters
partnerId
required
string
apikey
required
string

Responses

Service to update policies against to api key

Service to update policies against to api key

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

Responses

Request samples

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

Service to approve/reject partner policy mapping

Service to approve/reject partner policy mapping

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

Responses

Request samples

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

Service to get api key requests

Service to get api key requests

Responses

Service to get api key request

Service to get api key request

path Parameters
apikey
required
string

Responses

partner-service-controller

partner self registration

Saves partner details

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

Responses

Request samples

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

Service to get deatils of partner

Service to get deatils of partner

path Parameters
partnerId
required
string

Responses

Service to update deatils of partner

Service to update deatils of partner

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

Responses

Request samples

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

updatePolicyGroup

path Parameters
partnerId
required
string
policygroupName
required
string

Responses

To request for policy mapping

To request for policy mapping

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

Responses

Request samples

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

To generate apiKeys for approved policies

To generate apiKeys for approved policies

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

Responses

Request samples

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

Service to get policy for mapped partner and credential type

Service to get policy for mapped partner and credential type

path Parameters
partnerId
required
string
credentialType
required
string

Responses

Service to map partner and policy to a credential type

Service to map partner and policy to a credential type

path Parameters
partnerId
required
string
policyName
required
string
credentialType
required
string

Responses

Service to add additional contact deatils of partner

Service to add additional contact deatils of partner

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

Responses

Request samples

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

Service to get partner certificate

Service to get partner certificate

path Parameters
partnerId
required
string

Responses

Service to get bio extractors

Service to get bio extractors

path Parameters
partnerId
required
string
policyId
required
string

Responses

Service to add bio extractors

Service to add bio extractors

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

Responses

Request samples

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

Service to get api key requests of partner

Service to get api key requests of partner

path Parameters
partnerId
required
string

Responses

Service to search partner details

Service to search partner details

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

Responses

Request samples

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

Service to search partner types

Service to search partner types

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

Responses

Request samples

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

Service to filter partner details

Service to filter partner details

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

Responses

Request samples

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

To verify partner's email

Service to verify partner email

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

Responses

Request samples

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

Service to upload partner certificate

Service to upload partner certificate

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

Responses

Request samples

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

Service to upload ca certificate

Service to upload ca certificate

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": {
    }
}

Service to search api key

Service to search api key

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

Responses

Request samples

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

Service to search api key requests

Service to search api key requests

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

Responses

Request samples

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

Service to filter api key requests

Service to filter api key requests

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

Responses

Request samples

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

misp-license-controller

Service to get license details of misp

Service to get license details of misp

Responses

Service to update license details of misp

Service to update license details of misp

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

Responses

Request samples

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

Service to generate license for misp

Service to generate license for misp

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

Responses

Request samples

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

Service to get/regenarate license details of misp

Service to get/regenarate license details of misp

path Parameters
mispId
required
string

Responses

Service to search misp details

Service to search misp details

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

Responses

Request samples

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

Service to filter misp details

Service to filter misp details

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

Responses

Request samples

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

login-controller

logoutUser

cookie Parameters
Authorization
string

Responses

login

path Parameters
redirectURI
required
string
cookie Parameters
state
required
string

Responses

loginRedirect

path Parameters
redirectURI
required
string
query Parameters
state
required
string
session_state
required
string
code
required
string

Responses

validateAdminToken

Responses

ftp-chip-detail-controller

Service to update ftp chip detail

Updates ftp chip detail and returns success message

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

Responses

Request samples

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

Service to save ftpChipDetail

Saves ftpChipDetail and return ftpChipDetail id

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

Responses

Request samples

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

Service to approve/reject ftp chip detail

Approve ftp chip detail and returns success message

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

Responses

Request samples

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

Service to upload certificate of ftp chip

uploads the ftp chip certificate and returns success message

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

Responses

Request samples

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

Service to serach ftp chip details

Service to serach ftp chip details

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

Responses

Request samples

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

Service to get certificate of ftp chip

Returns the ftp chip certificate

path Parameters
ftpChipDetailId
required
string

Responses

device-detail-controller

Service to update DeviceDetails

Updates DeviceDetails

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

Responses

Request samples

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

Service to save DeviceDetail

Saves DeviceDetail and return DeviceDetail id

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

Responses

Request samples

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

Service to approve/reject DeviceDetail

Approve DeviceDetail and returns success message

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

Responses

Request samples

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

Service to search DeviceDetails

ervice to search DeviceDetails

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

Responses

Request samples

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

Service to filter DeviceDetails

Service to filter DeviceDetails

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

Responses

Request samples

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

Service to search DeviceTypes

service to search DeviceTypes

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

Responses

Request samples

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

Service to filter DeviceTypes

Service to filter DeviceTypes

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

Responses

Request samples

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

Service to filter DeviceSubTypes

Service to filter DeviceSubTypes

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

Responses

Request samples

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