ResourceGroup

When working with resource within the TeamTV platform you always need a ResourceGroup. The ResourceGroup holds all resources together for a certain group, like a Team. The ResourceGroup also has a policy about the permissions per role.

Each request to the TeamTV API must contain a the X-Resource-Group-ID header to tell TeamTV in which group you want to run your request.

Create

Request

resourceGroup = post(
   "https://api.teamtvsport.com/api/resourceGroups",
   headers={
      "Content-Type": "application/json",
      "Authorization": `Bearer ${API_TOKEN}`,
      "X-Resource-Group-Id": clubResourceGroupId
   },
   body={
      "name": "PSV A2",
      "type": "team"
   }
)

Response

{
  "tenantId": "nl_soccer_fcbalophetdak",
  "resourceGroupId": "45aaaaa-27f1-11eb-aaaa-123123123",
  "name": "FC Bal op het dak 1",
  "targetResourceName": "FC Bal op het dak 1",
  "targetResourceId": "team:aaaaaaa-27f1-11eb-aa12-bbbbfbaaf",
  "memberCount": 1,
  "created": "2021-08-20T11:59:44.726094Z",
  "updated": "2021-08-20T11:59:44.869725Z"
}

The resourceGroupId field in the returned resourceGroup object is the teamResourceGroupId. You need to keep a copy for further usage.

List

Request

resourceGroup = get(
   "https://api.teamtvsport.com/api/resourceGroups",
   headers={
      "Authorization": `Bearer ${API_TOKEN}`,
      "X-Resource-Group-Id": clubResourceGroupId
   }
)

Response

[
  {
    "tenantId": "nl_soccer_fcbalophetdak",
    "resourceGroupId": "45aaaaa-27f1-11eb-aaaa-123123123",
    "name": "FC Bal op het dak 1",
    "targetResourceName": "FC Bal op het dak 1",
    "targetResourceId": "team:aaaaaaa-27f1-11eb-aa12-bbbbfbaaf",
    "memberCount": 4,
    "created": "2020-11-16T09:51:16.731637Z",
    "updated": "2021-05-18T08:15:25.564400Z"
  },
  {
    "tenantId": "nl_soccer_fcbalophetdak",
    "resourceGroupId": "45aaaaa-27f1-11eb-8ff7-222123123",
    "name": "FC Bal op het dak 2",
    "targetResourceName": "FC Bal op het dak 2",
    "targetResourceId": "team:aaaaaaa-27f1-11eb-aa12-feedaaaa",
    "memberCount": 6,
    "created": "2020-11-16T09:52:54.545636Z",
    "updated": "2021-06-02T14:45:48.951428Z"
  }
]

Policy Configuration

The policy of a ResourceGroup can be used to change the behaviour regarding privileges of roles and other limits.

Limit products

When you want to limit the products a ResourceGroup has access to you can specify a list of products. The ResourceGroup won't have access to any other products. The products a ResourceGroup has access to is always limited by the products of a tenant. Note: the api does NOT check if the productIds are valid, nor if your tenant has access to those products.

Request

resourceGroup = post(
   `https://api.teamtvsport.com/api/resourceGroups/${resourceGroupId}/setPolicyConfiguration`,
   headers={
      "Authorization": `Bearer ${API_TOKEN}`,
      "X-Resource-Group-Id": clubResourceGroupId
   },
   body={
      "limits": {
        "productIds": ["productID1", "productID2"]
      }  
   }
)

Response

"OK"

Per-Resource ACL

TeamTV allows you to specify per-resource. Some resources within TeamTV are SportingEvent, Video, etc.

You can disable certain privileges per resource for some specified roles.

Request

resourceGroup = post(
   `https://api.teamtvsport.com/api/resourceGroups/${resourceGroupId}/setResourceACL`,
   headers={
      "Authorization": `Bearer ${API_TOKEN}`,
      "X-Resource-Group-Id": resourceGroupId
   },
   body={
      "resourceId": "sporting-event:11111111-2222-3333-4444-555555555",
      "acl": {
        "actions": ["observe"],
        "roleNames": ["admin"]
      }
   }
)

Response

"OK"

You can also omit the roleNames argument. When it's omitted all privileges will be removed for other roles.

Request

resourceGroup = post(
   `https://api.teamtvsport.com/api/resourceGroups/${resourceGroupId}/setResourceACL`,
   headers={
      "Authorization": `Bearer ${API_TOKEN}`,
      "X-Resource-Group-Id": resourceGroupId
   },
   body={
      "resourceId": "sporting-event:11111111-2222-3333-4444-555555555",
      "acl": {
        "roleNames": ["admin"]
      }
   }
)

Response

"OK"