Last updated

CCM User Association Service

User association API can be used to retrieve all the data partitions that a user has access to.

API response includes information related to the data partition(s) that are associated to the user such as-

  • Data partition details: partitionId, slbPartitionId, partitionName
  • Account details: billingAccountId, billingAccountName, partitionAccountId, partitionAccountName
  • Data Source details: endpointID, endpointName, instance, repositoryKind
  • Data partition association: departmentId, groupId,

Steps to access the service

After verifying user’s context and subscription, an application should check for user’s access to the selected data partition. User should be allowed to access a data partition only if they have been granted access to the same by Account Admin.

  1. In order to access the service, you are required to have the AppKey and the AccessToken. Below are the steps to get the appKey and AccessToken.
    • [AppKey] can be obtained from My Apps. Make sure your App subscribes CCM product.
    • [Access Token] can be obtained by sending request below using SLB Authenticator

SLB Authenticator information can be found in SAUTH

  1. Trying out the API

Example Request

  curl -X 'GET' \
    'https://api.delfi.slb.com/ccm/userAssociation/v1/dataPartitions' \
    -H 'Authorization: Bearer [token]' \
    -H 'accept: application/json' \
    -H 'appkey: <your-app-key>' 

Example Successful Response

[
  {
    "partitionId": "string",
    "slbPartitionId": "string",
    "partitionName": "string",
    "groupId": "string",
    "departmentId": "string",
    "billingAccountId": "string",
    "billingAccountName": "string",
    "isRegistered": true,
    "partitionAccountId": "string",
    "partitionAccountName": "string",
    "endpointID": "string",
    "endpointName": "string",
    "instance": "string",
    "repositoryKind": "string",
  }
]
Response ParametersTypeDescription
partitionIdstringpartitionId is the auto-generated or user provided Id of the registered data partition
partitionNamestringname of the Data partition.
slbPartitionIdstringunique id representing the data partition registration in SLB Digital Platform
groupIdstringuser group id from which a user has been granted access to the data partition
departmentIdstringdepartmentId from which a user has been granted access to the data partition
billingAccountIdstringbilling account Id in which user was granted access to the data partition via department/user group association
billingAccountNamestringbilling account name in which user was granted access to the data partition via department/user group association
isRegisteredbooleanWhether a data partition has been registered in Digital platform. Only registered data partitions are available for users to select while setting up user context
partitionAccountIdstringbilling account Id in which data partition was registered in SLB Digital Platform
partitionAccountNamestringbilling account name in which data partition was registered in SLB Digital Platform
endpointIDstringunique id representing the data source under which this data partition has been registered
endpointNamestringname of the data source represented by endpointID
instancestringURL of the data source represented by endpointID
repositoryKindStringdata source type selected at the time of registration