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

删除消费者范围

对于由CONSUMER_ID指定的使用者，删除由SCOPE_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: OBPv3.0.0, function_name: by deleteScope, operation_id: OBPv3.0.0-deleteScope Tags: Scope, Role, Entitlement, New-Style,

添加消费者范围。

创建范围。授予消费者角色。

范围用于将系统或银行级别的角色授予消费者（App）。 （有关帐户级别的权限，请参见视图）

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

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

Typical Successful Response: 

								
									
{
  "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f",
  "role_name":"CanGetEntitlementsForAnyUserAtOneBank",
  "bank_id":"GENODEM1GLS"
}
Required Roles:
  • CanCreateScopeAtOneBank - Please login to request this Role
  • CanCreateScopeAtAnyBank - 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-20024: Consumer not found. Please specify a valid value for CONSUMER_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: OBPv3.0.0, function_name: by addScope, operation_id: OBPv3.0.0-addScope Tags: Scope, Role, New-Style,

获取消费者范围

获取由CONSUMER_ID指定的使用者的所有范围

身份验证是强制性的

Typical Successful Response: 

								
									
{
  "list":[{
    "scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f",
    "role_name":"CanGetEntitlementsForAnyUserAtOneBank",
    "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-30212: EntitlementId not found
  • OBP-50000: Unknown Error.
Connector Methods:
Version: OBPv3.0.0, function_name: by getScopes, operation_id: OBPv3.0.0-getScopes Tags: Scope, Role, Entitlement, New-Style,