right logo image
right logo image
Log on
⯆

API Explorer

Log off

v5.1.0 (267 APIs)

API Host: https://api3.openbankproject.com
Bank
Accounts
Views
Counterparties
Transactions

为用户添加权利。

创建权利。向用户授予角色。

权利用于向用户授予系统或银行级别的角色。 （有关帐户级别的权限，请参见视图）

对于系统级角色（例如CanGetAnyUser），将bank_id设置为空字符串，即“ bank_id”：“”

对于银行级别的角色（例如CanCreateAccount），将bank_id设置为有效值，例如“ bank_id”：“ my-bank-id”

必须进行身份验证，并且用户必须是超级管理员。超级管理员列在“道具”文件中。

Typical Successful Response: 

								
									
{
  "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
  "role_name":"CanQueryOtherUser",
  "bank_id":"GENODEM1GLS"
}
Required Roles:
  • CanCreateEntitlementAtOneBank - Please login to request this Role
  • CanCreateEntitlementAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30216: Entitlement already exists for the user.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by addEntitlement, operation_id: OBPv2.0.0-addEntitlement Tags: Role, Entitlement, User,

删除权利

为USER_ID指定的用户删除ENTITLEMENT_ID指定的权利

必须进行身份验证，并且用户必须是超级管理员。
超级管理员列在“道具”文件中。

Typical Successful Response: 

								
									
{
  "jsonString":"{}"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.0.0, function_name: by deleteEntitlement, operation_id: OBPv2.0.0-deleteEntitlement Tags: Role, User, Entitlement,

删除权利请求

删除由ENTITLEMENT_REQUEST_ID指定的针对USER_ID指定的用户的权利请求

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "jsonString":"{}"
}
Required Roles:
  • CanDeleteEntitlementRequestsAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by deleteEntitlementRequest, operation_id: OBPv3.0.0-deleteEntitlementRequest Tags: Role, Entitlement, User, New-Style,

添加当前用户的权利请求。

创建权利请求。

任何登录的用户都可以使用此终结点来请求权利

权利用于向用户授予系统或银行级别的角色。 （有关帐户级别的权限，请参见视图）

对于系统级角色（例如CanGetAnyUser），将bank_id设置为空字符串，即“ bank_id”：“”

对于银行级别的角色（例如CanCreateAccount），将bank_id设置为有效值，例如“ bank_id”：“ my-bank-id”

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
  "user":{
    "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
    "email":"eveline@example.com",
    "provider_id":"Chris",
    "provider":"http://127.0.0.1:8080",
    "username":"felixsmith",
    "entitlements":{
      "list":[{
        "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
        "role_name":"CanQueryOtherUser",
        "bank_id":"GENODEM1GLS"
      }]
    }
  },
  "role_name":"CanQueryOtherUser",
  "bank_id":"GENODEM1GLS",
  "created":"2017-09-18T22:00:00Z"
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20005: User not found. Please specify a valid value for USER_ID.
  • OBP-10001: Incorrect json format.
  • OBP-10007: Incorrect Role name:
  • OBP-30205: This entitlement is a Bank Role. Please set bank_id to a valid bank id.
  • OBP-30206: This entitlement is a System Role. Please set bank_id to empty string.
  • OBP-30214: Entitlement Request already exists for the user.
  • OBP-30217: Entitlement Request cannot be added.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by addEntitlementRequest, operation_id: OBPv3.0.0-addEntitlementRequest Tags: Role, Entitlement, User, New-Style,

获取一家银行的权益

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "list":[{
    "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
    "role_name":"CanQueryOtherUser",
    "bank_id":"GENODEM1GLS"
  }]
}
Required Roles:
  • CanGetEntitlementsForOneBank - Please login to request this Role
  • CanGetEntitlementsForAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getEntitlementsForBank, operation_id: OBPv4.0.0-getEntitlementsForBank Tags: Role, Entitlement, User, New-Style,

获取当前用户的权利。

获取当前用户的权利。

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "list":[{
    "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
    "role_name":"CanQueryOtherUser",
    "bank_id":"GENODEM1GLS"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getEntitlementsForCurrentUser, operation_id: OBPv3.0.0-getEntitlementsForCurrentUser Tags: Role, Entitlement, User, New-Style,

获取当前用户的权利请求。

获取当前用户的权利请求。

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "entitlement_requests":[{
    "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
    "user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"eveline@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith",
      "entitlements":{
        "list":[{
          "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
          "role_name":"CanQueryOtherUser",
          "bank_id":"GENODEM1GLS"
        }]
      }
    },
    "role_name":"CanQueryOtherUser",
    "bank_id":"GENODEM1GLS",
    "created":"2017-09-18T22:00:00Z"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getEntitlementRequestsForCurrentUser, operation_id: OBPv3.0.0-getEntitlementRequestsForCurrentUser Tags: Role, Entitlement, User, New-Style,

获取所有权利

需要登录。

角色字段上可能的过滤器：

例如：/ entitlements？role = CanGetCustomer

Typical Successful Response: 

								
									
{
  "list":[{
    "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
    "role_name":"CanQueryOtherUser",
    "bank_id":"GENODEM1GLS"
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.1.0, function_name: by getAllEntitlements, operation_id: OBPv3.1.0-getAllEntitlements Tags: Role, Entitlement, New-Style,

获取所有权利请求

获取所有权利请求

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "entitlement_requests":[{
    "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
    "user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"eveline@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith",
      "entitlements":{
        "list":[{
          "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
          "role_name":"CanQueryOtherUser",
          "bank_id":"GENODEM1GLS"
        }]
      }
    },
    "role_name":"CanQueryOtherUser",
    "bank_id":"GENODEM1GLS",
    "created":"2017-09-18T22:00:00Z"
  }]
}
Required Roles:
  • CanGetEntitlementRequestsAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getAllEntitlementRequests, operation_id: OBPv3.0.0-getAllEntitlementRequests Tags: Role, Entitlement, User, New-Style,

获取用户权利

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "list":[{
    "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
    "role_name":"CanQueryOtherUser",
    "bank_id":"GENODEM1GLS"
  }]
}
Required Roles:
  • CanGetEntitlementsForAnyUserAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv4.0.0, function_name: by getEntitlements, operation_id: OBPv4.0.0-getEntitlements Tags: Role, Entitlement, User, New-Style,

获取用户的权利请求。

获取用户的权利请求。

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "entitlement_requests":[{
    "entitlement_request_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
    "user":{
      "user_id":"9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
      "email":"eveline@example.com",
      "provider_id":"Chris",
      "provider":"http://127.0.0.1:8080",
      "username":"felixsmith",
      "entitlements":{
        "list":[{
          "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
          "role_name":"CanQueryOtherUser",
          "bank_id":"GENODEM1GLS"
        }]
      }
    },
    "role_name":"CanQueryOtherUser",
    "bank_id":"GENODEM1GLS",
    "created":"2017-09-18T22:00:00Z"
  }]
}
Required Roles:
  • CanGetEntitlementRequestsAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20050: Current User is not a Super Admin!
  • OBP-50200: Connector cannot return the data we requested.
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getEntitlementRequests, operation_id: OBPv3.0.0-getEntitlementRequests Tags: Role, Entitlement, User, New-Style,

获取角色

返回所有可用角色

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "roles":[{
    "role":"eBranch",
    "requires_bank_id":true
  }]
}
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by getRoles, operation_id: OBPv2.1.0-getRoles Tags: Role, New-Style,

获取银行用户的权利。

获取由BANK_ID和USER_ID指定的权利

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "list":[{
    "entitlement_id":"6fb17583-1e49-4435-bb74-a14fe0996723",
    "role_name":"CanQueryOtherUser",
    "bank_id":"GENODEM1GLS"
  }]
}
Required Roles:
  • CanGetEntitlementsForAnyUserAtOneBank - Please login to request this Role
  • CanGetEntitlementsForAnyUserAtAnyBank - Please login to request this Role
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv2.1.0, function_name: by getEntitlementsByBankAndUser, operation_id: OBPv2.1.0-getEntitlementsByBankAndUser Tags: Role, Entitlement, User,