Skip to main content

Role

Represents a user role.

access object

Represents the user permissions and access rights.

administratorAccessboolean

TRUE if the user has the administrator user type, FALSE otherwise. Administrators (admins) have all permissions and can perform any action in Mambu.

apiAccessboolean

TRUE if the user can authenticate and interact with Mambu APIs, FALSE otherwise. The user may still require additional permissions for specific API requests.

creditOfficerAccessboolean

TRUE if the user has the credit officer user type, FALSE otherwise. Credit officers have the option of having clients and groups assigned to them.

deliveryAccessboolean

TRUE if the user is part of the Mambu delivery team, FALSE otherwise.

mambuAccessboolean

TRUEif the user can log in to the Mambu UI using their login credentials,FALSE` otherwise.

permissionsstring[]

Permissions for the user. The non-admin users are authorized to do actions based a set of permissions in order to access Mambu features. Permissions may be relevant for the API and/or the Mambu UI.

Possible values: [AUDIT_TRANSACTIONS, VIEW_COMMENTS, CREATE_COMMENTS, EDIT_COMMENTS, DELETE_COMMENTS, CREATE_INDEX_RATE, DOWNLOAD_BACKUPS, IMPORT_DATA, VIEW_BACKGROUND_TASKS, VIEW_EXCHANGE_RATES, CREATE_EXCHANGE_RATE, VIEW_CENTRE_DETAILS, CREATE_CENTRE, EDIT_CENTRE, DELETE_CENTRE, MANAGE_CONFIGURATION_AS_CODE, GET_MANAGE_CONFIGURATION_AS_CODE, PUT_MANAGE_CONFIGURATION_AS_CODE, VIEW_BRANCH_DETAILS, CREATE_BRANCH, EDIT_BRANCH, CREATE_COMMUNICATION_TEMPLATES, EDIT_COMMUNICATION_TEMPLATES, SEND_MANUAL_SMS, SEND_MANUAL_EMAIL, VIEW_COMMUNICATION_HISTORY, RESEND_FAILED_MESSAGES, VIEW_TRANSACTION_CHANNELS, CREATE_TRANSACTION_CHANNELS, EDIT_TRANSACTION_CHANNELS, DELETE_TRANSACTION_CHANNELS, MANAGE_HOLIDAYS, MANAGE_INDEX_RATES, MANAGE_EOD_PROCESSING, MANAGE_INTERNAL_CONTROLS, MANAGE_CURRENCIES, MANAGE_AUTHORIZATION_HOLDS_SETUP, MANAGE_RISK_LEVELS, VIEW_LOAN_PRODUCT_DETAILS, CREATE_LOAN_PRODUCT, EDIT_LOAN_PRODUCT, DELETE_LOAN_PRODUCTS, VIEW_SAVINGS_PRODUCT_DETAILS, CREATE_SAVINGS_PRODUCT, EDIT_SAVINGS_PRODUCT, DELETE_SAVINGS_PRODUCT, CREATE_PRODUCT_DOCUMENT_TEMPLATES, EDIT_PRODUCT_DOCUMENT_TEMPLATES, DELETE_PRODUCT_DOCUMENT_TEMPLATES, VIEW_CLIENT_DETAILS, CREATE_CLIENT, EDIT_CLIENT, DELETE_CLIENTS, APPROVE_CLIENT, REJECT_CLIENT, EXIT_CLIENT, ANONYMIZE_CLIENT, BLACKLIST_CLIENT, UNDO_CLIENT_STATE_CHANGED, EDIT_CLIENT_ID, EDIT_BLACKLISTED_CLIENT_CFV, EDIT_GROUP_ID, CHANGE_CLIENT_TYPE, VIEW_GROUP_DETAILS, CREATE_GROUP, EDIT_GROUP, DELETE_GROUP, CHANGE_GROUP_TYPE, VIEW_LINE_OF_CREDIT_DETAILS, CREATE_LINES_OF_CREDIT, EDIT_LINES_OF_CREDIT, ADD_ACCOUNTS_TO_LINE_OF_CREDIT, REMOVE_ACCOUNTS_FROM_LINE_OF_CREDIT, APPROVE_LINE_OF_CREDIT, UNDO_APPROVE_LINE_OF_CREDIT, WITHDRAW_LINE_OF_CREDIT, UNDO_WITHDRAW_LINE_OF_CREDIT, REJECT_LINE_OF_CREDIT, UNDO_REJECT_LINE_OF_CREDIT, CLOSE_LINES_OF_CREDIT, DELETE_LINES_OF_CREDIT, VIEW_LOAN_ACCOUNT_DETAILS, CREATE_LOAN_ACCOUNT, EDIT_LOAN_ACCOUNT, DELETE_LOAN_ACCOUNT, ENTER_REPAYMENT, EDIT_REPAYMENT_SCHEDULE, APPROVE_LOANS, REQUEST_LOAN_APPROVAL, DIBURSE_LOANS, WITHDRAW_LOAN_ACCOUNTS, UNDO_WITHDRAW_LOAN_ACCOUNTS, SET_LOAN_INCOMPLETE, REJECT_LOANS, UNDO_REJECT_LOANS, CLOSE_LOAN_ACCOUNTS, WRITE_OFF_LOAN_ACCOUNTS, TERMINATE_LOAN_ACCOUNTS, PAY_OFF_LOAN, UNDO_LOAN_ACCOUNT_CLOSURE, REVERSE_LOAN_ACCOUNT_WRITE_OFF, REFINANCE_LOAN_ACCOUNT, RESCHEDULE_LOAN_ACCOUNT, APPLY_ACCRUED_LOAN_INTEREST, APPLY_LOAN_FEES, APPLY_LOAN_ADJUSTMENTS, CREDIT_BALANCE_DEPOSIT, EDIT_PLANNED_FEES, BACKDATE_LOAN_TRANSACTIONS, LINK_ACCOUNTS, COLLECT_GUARANTIES, VIEW_SECURITIES_DETAILS, CREATE_SECURITIES, EDIT_SECURITIES, DELETE_SECURITIES, LOCK_LOAN_ACCOUNTS, POST_TRANSACTIONS_ON_LOCKED_LOAN_ACCOUNTS, EDIT_LOAN_TRANCHES, EDIT_PENALTY_RATE, EDIT_FEE_RATE, SET_DISBURSEMENT_CONDITIONS, EDIT_LOAN_TRANSACTIONS, BULK_LOAN_CORRECTIONS, EDIT_INTEREST_RATE, EDIT_REPAYMENT_METHOD_VALUE, EDIT_PERIODIC_PAYMENT_FOR_ACTIVE_ACCOUNT, MANAGE_LOAN_ASSOCIATION, MAKE_WITHDRAWAL_REDRAW, ENTER_REFUND, VIEW_SAVINGS_ACCOUNT_DETAILS, CREATE_SAVINGS_ACCOUNT, EDIT_SAVINGS_ACCOUNT, DELETE_SAVINGS_ACCOUNT, MAKE_DEPOSIT, MAKE_BULK_DEPOSITS, MAKE_WITHDRAWAL, MAKE_EARLY_WITHDRAWALS, APPROVE_SAVINGS, ACTIVATE_MATURITY, UNDO_MATURITY, CLOSE_SAVINGS_ACCOUNTS, APPLY_SAVINGS_FEES, REOPEN_SAVINGS_ACCOUNT, APPLY_SAVINGS_ADJUSTMENTS, LOCK_SAVINGS_ACCOUNT, UNLOCK_SAVINGS_ACCOUNT, REVERSE_SAVINGS_ACCOUNT_WRITE_OFF, BACKDATE_SAVINGS_TRANSACTIONS, MAKE_TRANSFER, MAKE_INTER_CLIENTS_TRANSFERS, POST_TRANSACTIONS_ON_DORMANT_ACCOUNTS, APPLY_ACCRUED_SAVINGS_INTEREST, EDIT_SAVINGS_TRANSACTIONS, BULK_DEPOSIT_CORRECTIONS, BLOCK_AND_SEIZE_FUNDS, WITHDRAW_BLOCKED_FUNDS, MANAGE_DEPOSIT_ACCOUNT_RECIPIENT, MANAGE_DEPOSIT_ASSOCIATION, BYPASS_ACCOUNT_OWNERSHIP_TRANSFER_VIEW_RESTRICTION, CREATE_CARDS, VIEW_CARDS, DELETE_CARDS, REVERSE_CARD_WITHDRAWAL_TRANSACTION, REVERSE_CARD_TRANSACTION, CARD_BALANCE_INQUIRY, CREATE_AUTHORIZATION_HOLD, UPDATE_AUTHORIZATION_HOLD, VIEW_AUTHORIZATION_HOLD, CREATE_CARD_TRANSACTION, CREATE_ACCOUNT_HOLD, UPDATE_ACCOUNT_HOLD, VIEW_ACCOUNT_HOLD, VIEW_DOCUMENTS, CREATE_DOCUMENTS, EDIT_DOCUMENTS, DELETE_DOCUMENTS, VIEW_TASK, CREATE_TASK, EDIT_TASK, DELETE_TASK, VIEW_INTELLIGENCE, VIEW_REPORTS, CREATE_REPORTS, EDIT_REPORTS, DELETE_REPORTS, VIEW_JASPER_REPORTS, CREATE_JASPER_REPORTS, EDIT_JASPER_REPORTS, DELETE_JASPER_REPORTS, VIEW_CHART_OF_ACCOUNTS, MANAGE_ACCOUNTS, VIEW_JOURNAL_ENTRIES, LOG_JOURNAL_ENTRIES, VIEW_ACCOUNTING_REPORTS, MAKE_ACCOUNTING_CLOSURE, APPLY_ACCOUNTING_ADJUSTMENTS, BOOKING_DATE_LOANS_GL, BOOKING_DATE_SAVINGS_GL, RECTIFY_ADJUSTMENT, MANAGE_INTERBRANCH_GLACCOUNT_RULES, VIEW_ACCOUNTING_RATES, CREATE_ACCOUNTING_RATES, OPEN_TILL, CLOSE_TILL, ADD_CASH, REMOVE_CASH, POST_TRANSACTIONS_WITHOUT_OPENED_TILL, VIEW_INVESTOR_FUNDS_DETAILS, CREATE_INVESTOR_FUNDS, EDIT_INVESTOR_FUNDS, DELETE_INVESTOR_FUNDS, SELL_LOAN_FRACTION, CREATE_USER, EDIT_USER, VIEW_USER_DETAILS, DELETE_USER, MANAGE_TWO_FACTOR_AUTHENTICATION, MANAGE_CLIENT_ASSOCIATION, MANAGE_GROUP_ASSOCIATION, EDIT_PRINCIPAL_PAYMENT_ACTIVE_REVOLVING_CREDIT, PERFORM_REPAYMENTS_WITH_CUSTOM_AMOUNTS_ALLOCATION, EXPORT_TO_EXCEL, VIEW_ADMINISTRATION_DETAILS, MANAGE_EVENTS_STREAMING, MANAGE_PAYMENTS, MANAGE_AUDIT_TRAIL, MANAGE_APPS, MANAGE_CARDS_CAPABILITY, MANAGE_NOTIFICATIONS, ADMIN, CREATE_ROLE, EDIT_ROLE, DELETE_ROLE, VIEW_ROLE, MANAGE_FEDERATED_AUTHENTICATION, MANAGE_ACCESS_PREFERENCES, VIEW_API_CONSUMERS_AND_KEYS, CREATE_API_CONSUMERS_AND_KEYS, EDIT_API_CONSUMERS_AND_KEYS, DELETE_API_CONSUMERS_AND_KEYS, VIEW_CUSTOM_FIELD, CREATE_CUSTOM_FIELD, EDIT_CUSTOM_FIELD, DELETE_CUSTOM_FIELD, VIEW_MAMBU_FUNCTIONS, CREATE_MAMBU_FUNCTIONS, EDIT_MAMBU_FUNCTIONS, DELETE_MAMBU_FUNCTIONS, VIEW_MAMBU_FUNCTIONS_SECRETS, CREATE_MAMBU_FUNCTIONS_SECRETS, EDIT_MAMBU_FUNCTIONS_SECRETS, DELETE_MAMBU_FUNCTIONS_SECRETS, VIEW_PROFIT_SHARING_PROPOSALS, CREATE_PROFIT_SHARING_CASH_FLOWS, VIEW_PROFIT_SHARING_CASH_FLOWS, EDIT_PROFIT_SHARING_CASH_FLOWS, DELETE_PROFIT_SHARING_CASH_FLOWS, CREATE_PROFIT_SHARING_POOLS, VIEW_PROFIT_SHARING_POOLS, EDIT_PROFIT_SHARING_POOLS, DELETE_PROFIT_SHARING_POOLS, CREATE_PROFIT_SHARING_PRODUCT_SETTINGS, VIEW_PROFIT_SHARING_PRODUCT_SETTINGS, EDIT_PROFIT_SHARING_PRODUCT_SETTINGS, DELETE_PROFIT_SHARING_PRODUCT_SETTINGS, MAKE_BULK_CHANGE_INTEREST_AVAILABILITY, CREATE_RATE_SHEET, VIEW_RATE_SHEET]

supportAccessboolean

TRUE if the user can provide Mambu technical support, FALSE otherwise.

tellerAccessboolean

TRUE if the user has the teller user type, FALSE otherwise. Tellers have access to the teller module and specific tellering permissions, which allow them to take actions such as opening or closing tills, posting transactions on a till, and adding and removing cash from a till.

creationDatestring<date-time>

The date when the role was created in UTC.

Example: 2016-09-06T13:37:50+03:00
encodedKeystring

The encoded key of the entity, generated automatically, globally unique.

idstring

The ID of the role, which can be generated and customized, but must be unique.

lastModifiedDatestring<date-time>

The last time the role was modified in UTC.

Example: 2016-09-06T13:37:50+03:00
namestringrequired

The unique name of the role.

notesstring

The notes about the role.

Role
{
"access": {
"administratorAccess": true,
"apiAccess": true,
"creditOfficerAccess": true,
"deliveryAccess": true,
"mambuAccess": true,
"permissions": [
"AUDIT_TRANSACTIONS"
],
"supportAccess": true,
"tellerAccess": true
},
"creationDate": "2016-09-06T13:37:50+03:00",
"encodedKey": "string",
"id": "string",
"lastModifiedDate": "2016-09-06T13:37:50+03:00",
"name": "string",
"notes": "string"
}