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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"id": "string",
"swBinaryHash": "string",
"swVersion": "string",
"swCreateDateTime": "2019-08-24T14:15:22Z",
"swExpiryDateTime": "2019-08-24T14:15:22Z",
"isActive": true
}
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"swBinaryHash": "string",
"swVersion": "string",
"swCreateDateTime": "2019-08-24T14:15:22Z",
"swExpiryDateTime": "2019-08-24T14:15:22Z",
"providerId": "string"
}
}

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

Payload

Content type

application/json

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

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"values": ["string"
],
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"purpose": "string"
}
}

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"columnName": "string",
"type": "string",
"text": "string"
}
],
"optionalFilters": [{"value": "string",
"values": ["string"
],
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
]
}
}

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

Payload

Content type

application/json

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

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

Payload

Content type

application/json

{"id": "string",
"version": "string",
"requesttime": "2019-08-24T14:15:22Z",
"metadata": { },
"request": {"filters": [{"value": "string",
"values": ["string"
],
"fromValue": "string",
"toValue": "string",
"columnName": "string",
"type": "string"
}
],
"sort": [{"sortField": "string",
"sortType": "string"
}
],
"pagination": {"pageStart": 0,
"pageFetch": 0
},
"purpose": "string"
}
}

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

Payload

Content type

application/json

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

role-controller

getRequiredRoles

Responses

partner-management-controller

Service to get partner details

query Parameters

partnerType

string

Responses

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

Payload

Content type

application/json

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

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

Payload

Content type

application/json

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

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

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

Payload

Content type

application/json

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

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

Payload

Content type

application/json

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

Service to get api key requests

Responses

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

Payload

Home

Partner Management Services API documentation (1.0)

secure-biometric-interface-controller

Service to update SecureBiometricInterface

Request Body schema: application/json

Responses

Request samples

Service to save SecureBiometricInterfaceCreateDto

Request Body schema: application/json

Responses

Request samples

Service to approve/reject SecureBiometricInterface

Request Body schema: application/json

Responses

Request samples

Service to search SecureBiometricInterface details

Request Body schema: application/json

Responses

Request samples

Service to filter SBI's

Request Body schema: application/json

Responses

Request samples

Service to map device details with sbi

Request Body schema: application/json

Responses

Request samples

Service to search mapped device details and SecureBiometricInterface details

Request Body schema: application/json

Responses

Request samples

Service to remove mapped device details with sbi

Request Body schema: application/json

Responses

Request samples

role-controller

getRequiredRoles

Responses

partner-management-controller

Service to get partner details

query Parameters

Responses

Service to activate/de-activate partner

path Parameters

Request Body schema: application/json

Responses

Request samples

Service to activate/de-activate partner api key

path Parameters

Request Body schema: application/json

Responses

Request samples

Service to get policy for given api key

path Parameters

Responses

Service to update policies against to api key

path Parameters

Request Body schema: application/json

Responses

Request samples

Service to approve/reject partner policy mapping

path Parameters

Request Body schema: application/json

Responses

Request samples

Service to get api key requests

Responses

Service to get api key request

path Parameters

Responses

partner-service-controller

partner self registration

Request Body schema: application/json

Responses

Request samples