Skip to main content

Spaces

During the onboarding process of a Banqup entity, a first space is created. Spaces are virtual environments (work spaces) where all relevant resources of an entity are managed. Spaces can also facilitate document exchange and communication among entities, depending on the space type. The role of spaces is to gather all relevant data of an entity into one accessible setting. Such data can include: invoices, connections, cards, clients, payments, users, installed apps etc. The capabilities offered by a space depends on the space type and the active subscription. Every space in Banqup has a unique identifier that is needed when performing certain API calls on that space.

📄️ Add or remove the permission tree for a subject (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Grants or revokes permissions on specific resources and/or group memberships for a subject within a space. The request may contain an 'add' operation, a 'remove' operation, or both. Each operation can specify a list of resources (with scopes) and a list of permission groups. The same scope on the same resource cannot appear in both 'add' and 'remove' in a single request. All referenced resources must be associated with the given space, and all scopes must be within the configured scopes for the resource type; otherwise a 400 is returned. After applying the changes, the updated permission tree for the subject is returned. <br/> Scope: space_foundation_manage_users, partner_store

📄️ Bulk get permission tree permissions for a subject (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Returns the granted and ungranted scopes for a given list of UMA resources within a space for a specific active subject. For resources not present in the subject's permission tree, an entry with an empty scopes list is returned. The request list must contain between 1 and 100 items. <br/> Scope: space_read

📄️ JSON patch space (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> Partially updates a space using RFC 6902 JSON patch operations. Allowed paths: /name, /description, /isDefault, /settings, /globalIdentifiers, /addresses, /communicationData, /communicationData/mobile, /communicationData/email, /communicationData/deviceId, /communicationData/locale. All other paths are rejected with 400 Bad Request. <br/> Scope: space_foundation_manage_details

📄️ List permission tree permissions for a space subject (v2)

<div class='my-preview'><span>Preview: The API is in development or testing phases and the interface could still change slightly.</span></div> <br/> List a subject's permission tree permissions for a space, with pagination and BQL-based filtering. Supports filtering by type (e.g. type[in]=('spaces:partner','partner_space:client')) and by scope name (e.g. scopeName=space_read) to retrieve resources that have scope granted or ungranted. <br/> Scope: space_read