{"resource_docs":[{"operation_id":"OBPv3.0.0-deleteScope","implemented_by":{"version":"OBPv3.0.0","function":"deleteScope"},"request_verb":"DELETE","request_url":"/obp/v3.0.0/consumers/CONSUMER_ID/scope/SCOPE_ID","summary":"Delete Consumer Scope","description":"
Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID
\nAuthentication is required and the user needs to be a Super Admin.
\nSuper Admins are listed in the Props file.
Authentication is Mandatory
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\n\nJSON response body fields:
\n","description_markdown":"Delete Consumer Scope specified by SCOPE_ID for an consumer specified by CONSUMER_ID\n\nAuthentication is required and the user needs to be a Super Admin.\nSuper Admins are listed in the Props file.\n\n\n \n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n[SCOPE_ID](/glossary#scope_id): \n\n\n\n\n\n**JSON response body fields:**\n\n\n","error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30212: EntitlementId not found","OBP-50000: Unknown Error."],"tags":["Scope","Consumer"],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/consumers/CONSUMER_ID/scope/SCOPE_ID","connector_methods":[]},{"operation_id":"OBPv4.0.0-getScopes","implemented_by":{"version":"OBPv4.0.0","function":"getScopes"},"request_verb":"GET","request_url":"/obp/v4.0.0/consumers/CONSUMER_ID/scopes","summary":"Get Scopes for Consumer","description":"Get all the scopes for an consumer specified by CONSUMER_ID
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON response body fields:
\nbank_id: gh.29.uk
\nlist:
\n\n\n","description_markdown":"Get all the scopes for an consumer specified by CONSUMER_ID\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**list**](/glossary#list): \n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**scope_id**](/glossary#scope_id): \n\n\n","success_response_body":{"list":[{"scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f","role_name":"CanGetEntitlementsForAnyUserAtOneBank","bank_id":"gh.29.uk"}]},"error_response_bodies":["OBP-20001: User not logged in. Authentication is required!","OBP-30212: EntitlementId not found","OBP-30019: Consumer not found. Please specify a valid value for CONSUMER_ID.","OBP-50000: Unknown Error."],"tags":["Scope","Consumer"],"typed_success_response_body":{"type":"object","properties":{"list":{"type":"array","items":{"type":"object","properties":{"scope_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"}}}}}},"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/consumers/CONSUMER_ID/scopes","connector_methods":[]},{"operation_id":"OBPv4.0.0-addScope","implemented_by":{"version":"OBPv4.0.0","function":"addScope"},"request_verb":"POST","request_url":"/obp/v4.0.0/consumers/CONSUMER_ID/scopes","summary":"Create Scope for a Consumer","description":"Create Scope. Grant Role to Consumer.
\nScopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)
\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. "bank_id":""
\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. "bank_id":"my-bank-id"
\nAuthentication is Mandatory
\nURL Parameters:
\nCONSUMER_ID: 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
\nJSON request body fields:
\nbank_id: gh.29.uk
\n\nJSON response body fields:
\nbank_id: gh.29.uk
\n\n\n","description_markdown":"Create Scope. Grant Role to Consumer.\n\nScopes are used to grant System or Bank level roles to the Consumer (App). (For Account level privileges, see Views)\n\nFor a System level Role (.e.g CanGetAnyUser), set bank_id to an empty string i.e. \"bank_id\":\"\"\n\nFor a Bank level Role (e.g. CanCreateAccount), set bank_id to a valid value e.g. \"bank_id\":\"my-bank-id\"\n\n\n\nAuthentication is Mandatory\n\n\n**URL Parameters:**\n\n[CONSUMER_ID](/glossary#): 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh\n\n\n\n\n\n**JSON request body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n\n\n**JSON response body fields:**\n\n\n\n[**bank_id**](/glossary#): gh.29.uk\n\n\n\n[**role_name**](/glossary#role_name): \n\n\n\n[**scope_id**](/glossary#scope_id): \n\n\n","example_request_body":{"bank_id":"gh.29.uk","role_name":"CanGetEntitlementsForAnyUserAtOneBank"},"success_response_body":{"scope_id":"88625da4-a671-435e-9d24-e5b6e5cc404f","role_name":"CanGetEntitlementsForAnyUserAtOneBank","bank_id":"gh.29.uk"},"error_response_bodies":["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.","OBP-20006: User is missing one or more roles: "],"tags":["Scope","Consumer"],"typed_request_body":{"type":"object","properties":{"bank_id":{"type":"string"},"role_name":{"type":"string"}}},"typed_success_response_body":{"type":"object","properties":{"scope_id":{"type":"string"},"bank_id":{"type":"string"},"role_name":{"type":"string"}}},"roles":[{"role":"CanCreateScopeAtAnyBank","requires_bank_id":false},{"role":"CanCreateScopeAtOneBank","requires_bank_id":true}],"is_featured":false,"special_instructions":"","specified_url":"/obp/v4.0.0/consumers/CONSUMER_ID/scopes","connector_methods":[]}]}