1- # Open Bank Project
2-
3- # Introductory System Documentation
1+ # Open Bank Project - Introductory Documentation
42
53This document serves as an overview of the Open Bank Project (OBP) technology ecosystem and related tools.
64It provides an introduction to its key components, architecture, deployment and management approaches and capabilities.
@@ -4816,6 +4814,7 @@ PUT /management/consumers/{CONSUMER_ID}/consumer/certificate
48164814#### Role Naming Convention
48174815
48184816Roles follow a consistent naming pattern:
4817+
48194818- ` Can[Action][Resource][Scope] `
48204819- ** Action:** Create, Get, Update, Delete, Read, Add, Maintain, Search, Enable, Disable, etc.
48214820- ** Resource:** Account, Customer, Bank, Transaction, Product, Card, Branch, ATM, etc.
@@ -4824,16 +4823,19 @@ Roles follow a consistent naming pattern:
48244823#### Common Role Patterns
48254824
48264825** System-Level Roles** (requiresBankId = false):
4826+
48274827- Apply across all banks
48284828- Examples: ` CanGetAnyUser ` , ` CanCreateBank ` , ` CanReadMetrics `
48294829
48304830** Bank-Level Roles** (requiresBankId = true):
4831+
48314832- Scoped to a specific bank
48324833- Examples: ` CanCreateCustomer ` , ` CanCreateBranch ` , ` CanGetMetricsAtOneBank `
48334834
48344835#### Key Role Categories
48354836
48364837** Account Management:**
4838+
48374839- CanCreateAccount
48384840- CanUpdateAccount
48394841- CanGetAccountsHeldAtOneBank
@@ -4853,6 +4855,7 @@ Roles follow a consistent naming pattern:
48534855- CanSeeAccountAccessForAnyUser
48544856
48554857** Customer Management:**
4858+
48564859- CanCreateCustomer
48574860- CanCreateCustomerAtAnyBank
48584861- CanGetCustomer
@@ -4900,6 +4903,7 @@ Roles follow a consistent naming pattern:
49004903- CanUseCustomerFirehoseAtAnyBank
49014904
49024905** Transaction Management:**
4906+
49034907- CanCreateAnyTransactionRequest
49044908- CanGetTransactionRequestAtAnyBank
49054909- CanUpdateTransactionRequestStatusAtAnyBank
@@ -4925,6 +4929,7 @@ Roles follow a consistent naming pattern:
49254929- CanGetDoubleEntryTransactionAtAnyBank
49264930
49274931** Bank Resource Management:**
4932+
49284933- CanCreateBranch
49294934- CanCreateBranchAtAnyBank
49304935- CanUpdateBranch
@@ -4960,6 +4965,7 @@ Roles follow a consistent naming pattern:
49604965- CanDeleteBankAccountBalance
49614966
49624967** User & Entitlement Management:**
4968+
49634969- CanCreateUserCustomerLink
49644970- CanCreateUserCustomerLinkAtAnyBank
49654971- CanGetUserCustomerLink
@@ -4988,6 +4994,7 @@ Roles follow a consistent naming pattern:
49884994- CanCreateResetPasswordUrl
49894995
49904996** Consumer & API Management:**
4997+
49914998- CanCreateConsumer
49924999- CanGetConsumers
49935000- CanEnableConsumers
@@ -5011,6 +5018,7 @@ Roles follow a consistent naming pattern:
50115018- CanGetCallContext
50125019
50135020** Dynamic Resources:**
5021+
50145022- CanCreateDynamicEndpoint
50155023- CanGetDynamicEndpoint
50165024- CanGetDynamicEndpoints
@@ -5082,6 +5090,7 @@ Roles follow a consistent naming pattern:
50825090- CanReadGlossary
50835091
50845092** Consent Management:**
5093+
50855094- CanGetConsentsAtOneBank
50865095- CanGetConsentsAtAnyBank
50875096- CanUpdateConsentStatusAtOneBank
@@ -5093,6 +5102,7 @@ Roles follow a consistent naming pattern:
50935102- CanRevokeConsentAtBank
50945103
50955104** Security & Compliance:**
5105+
50965106- CanAddKycCheck
50975107- CanGetAnyKycChecks
50985108- CanAddKycDocument
@@ -5121,6 +5131,7 @@ Roles follow a consistent naming pattern:
51215131- CanDeleteTaxResidence
51225132
51235133** Logging & Monitoring:**
5134+
51245135- CanGetTraceLevelLogsAtOneBank
51255136- CanGetTraceLevelLogsAtAllBanks
51265137- CanGetDebugLevelLogsAtOneBank
@@ -5135,6 +5146,7 @@ Roles follow a consistent naming pattern:
51355146- CanGetAllLevelLogsAtAllBanks
51365147
51375148** Views & Permissions:**
5149+
51385150- CanCreateSystemView
51395151- CanGetSystemView
51405152- CanUpdateSystemView
@@ -5143,6 +5155,7 @@ Roles follow a consistent naming pattern:
51435155- CanDeleteSystemViewPermission
51445156
51455157** Cards:**
5158+
51465159- CanCreateCardsForBank
51475160- CanGetCardsForBank
51485161- CanUpdateCardsForBank
@@ -5152,6 +5165,7 @@ Roles follow a consistent naming pattern:
51525165- CanDeleteCardAttributeDefinitionAtOneBank
51535166
51545167** Products & Fees:**
5168+
51555169- CanCreateProduct
51565170- CanCreateProductAtAnyBank
51575171- CanCreateProductAttribute
@@ -5169,13 +5183,15 @@ Roles follow a consistent naming pattern:
51695183- CanMaintainProductCollection
51705184
51715185** Webhooks:**
5186+
51725187- CanCreateWebhook
51735188- CanGetWebhooks
51745189- CanUpdateWebhook
51755190- CanCreateSystemAccountNotificationWebhook
51765191- CanCreateAccountNotificationWebhookAtOneBank
51775192
51785193** Data Management:**
5194+
51795195- CanCreateSandbox
51805196- CanSearchWarehouse
51815197- CanSearchWarehouseStatistics
@@ -5193,7 +5209,8 @@ Roles follow a consistent naming pattern:
51935209- CanGetSocialMediaHandles
51945210- CanUpdateAgentStatusAtOneBank
51955211- CanUpdateAgentStatusAtAnyBank
5196- ```
5212+
5213+ ````
51975214
51985215**Scopes:**
51995216
@@ -5214,7 +5231,7 @@ Roles follow a consistent naming pattern:
52145231```bash
52155232GET /obp/v5.1.0/roles
52165233Authorization: DirectLogin token="TOKEN"
5217- ```
5234+ ````
52185235
52195236** Via Source Code:**
52205237The complete list of roles is defined in:
0 commit comments