The Identity Service API was deprecated as of January 2018. This service is no longer maintained, and is no longer referenced by any releases of Mojaloop.
For a list of active Mojaloop repos, please refer to Repo Details section of the Mojaloop documentation.
Identity Service is used for managing identity related data, like sessions, images, PINs, etc. This service contains information about all the available actions and wich roles can perform them.
Roles can be one of the following:
- common - Default roles;
- maker - Batch payment maker role;
- checker - Batch payment checker role;
Actions are defined as follow:
- bulk.batch.add - Create new batch;
- bulk.batch.edit - Edit batch;
- bulk.batch.fetch - Fetch batches by criteria;
- bulk.batch.get - Get batch details;
- bulk.batch.reject - Reject batch;
- bulk.batch.disable - Disable batch;
- bulk.batch.pay - Pay batch;
- bulk.batch.check - Check batch;
- bulk.batch.ready - Mark batch as ready;
- bulk.batch.delete - Mark batch as deleted;
- bulk.batch.process - Process batch;
- bulk.payment.check - Check payment details;
- bulk.payment.disable - Disable payment;
- bulk.payment.edit - Edit payment;
- bulk.payment.fetch - Fetch payments;
- bulk.payment.add - Create payment;
- bulk.paymentStatus.fetch - Fetch list with payment statuses;
- bulk.batchStatus.fetch - Fetch list with batch statuse;
- core.transaltion.fetch - Translation fetch;
- rule.rule.fetch - Rule fetch;
- rule.item.fetch - Item fetch;
- rule.rule.add - Rule add;
- rule.rule.edit - Rule edit;
- ledger.account.fetch - Fetch accounts;
-
URL
/login -
Method
POST -
Data Params
Required
actorId [string] - Actor idusername [string] - Usernamepassword [string] - Login passwordsessionId [string] - Generated session id
-
Success Response
- Code: 200
Contentidentity.check [json] - json containing following fieldsactorId [string] - Actor idsessionId [string] - Session id
permission.get [json] - json containing following fieldsactionId [string]- action idobjectId [string] - object iddescription [string] - action description
language [json] - json with user languagelocalisation [json] - json with the following fieldsdateFormat [string] - Date formatnumberFormat [string] - Number format
roles [json] - json containing user rolesscreenHeader [string] - Screen header
- Code: 200
-
URL
/rpc/identity/add -
Method
POST -
Data Params
Required
actorId [string] - Actor idtype [string] - Typeidentifier [string] - User identifieralgorithm [string] - Used algorithmparams [string] - Input paramsvalue [string] - Input valueroles [string array] - Array of role names
-
Success Response
- Code: 200
Contentactor [json] - json containing following fieldsactorId [string] - Actor id
- Code: 200
-
URL
/rpc/identity/closeSession -
Method
POST -
Data Params
Required
actorId [string] - Actor idsessionId [string] - Generated session id
-
Success Response
- Code: 200
Contentdata [json] - json containing empty array
- Code: 200
-
URL
/rpc/identity/get -
Method
POST -
Data Params
Required
username [string] - UsernameactorId [string] - Actor idtype [string] - Type: password/ussd
-
Success Response
- Code: 200
ContenthashParams [json] - json containing following fieldsparams [string] - paramsalgorithm [string] - algorithmactorId [string] - Actor idtype [string] - Type: password/ussd
roles [json] - json containing all assigned roles for this actorId
- Code: 200