Skip to content

Client

Client Definition

As a client administrator there are properties and values that are available to customize the Secure Data Zone or Secure Client Space.

Client IDs

TBD

A consent contract can be written to a single Public ID, a role name or a wildcard (‘*’). To define a role name, the client preferences (or info) has an array of role names. To create or update a role it is best to get the current client preferences, then updated the one attribute, and update the entire preferences document.

  1. Call this endpoint with a ADMIN credential:

GET /api/metadata/client/info

  1. Edit the JSON response attribute burst_chain_consent_roles and add an array of objects like:
'burst_chain_consent_roles': [
    {
        'role_name': 'my_group',
        'public_ids': ['1267861278', '346278643789']
    }
]
  1. Then you can update then ENTIRE preferences JSON document with (not just the one attribute):

PUT /api/metadata/client/info