How to manage legal tags
In this article, you'll know what legal tags are and how to manage them in your Azure Data Manager for Energy instance.
A legal tag is the entity that represents the legal status of data ingestion and entitlement service defines user access to data. A user may have access to manage the data using entitlements but need to fulfill certain legal requirements using legal tags. Legal tag is a collection of required properties that governs how data can be ingested into your Azure Data Manager for Energy instance.
The Azure Data Manager for Energy instance allows creation of legal tags only for countryOfOrigin that are allowed as per the configuration file DefaultCountryCodes.json at a data partition level. OSDU has defined this file and you can't edit it.
Create a legal tag
Run the curl command in Azure Cloud Bash to create a legal tag for a given data partition of your Azure Data Manager for Energy instance.
curl --location --request POST 'https://<URI>/api/legal/v1/legaltags' \
--header 'data-partition-id: <data-partition-id>' \
--header 'Authorization: Bearer <access_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "<legal-tag-name>",
"description": "<legal-tag-description>",
"properties": {
"contractId": "<contract-id>",
"countryOfOrigin": ["<country-of-origin>"],
"dataType": "<data-type>",
"expirationDate": "<expiration-ID>",
"exportClassification": "<export-classification>",
"originator": "<originator>",
"personalData": "<personal-data>",
"securityClassification": "Public"
}
}'
Sample request
Consider an Azure Data Manager for Energy instance named medstest with a data partition named "dp1":
curl --location --request POST 'https://medstest.energy.azure.com/api/legal/v1/legaltags' \
--header 'data-partition-id: medstest-dp1' \
--header 'Authorization: Bearer eyxxxxxxx.........................' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "medstest-dp1-legal-tag",
"description": "Azure Data Manager for Energy Legal Tag",
"properties": {
"contractId": "A1234",
"countryOfOrigin": ["US"],
"dataType": "Public Domain Data",
"expirationDate": "2099-01-25",
"exportClassification": "EAR99",
"originator": "MyCompany",
"personalData": "No Personal Data",
"securityClassification": "Public"
}
}'
Sample response
{
"name": "medsStest-dp1-legal-tag",
"description": "Azure Data Manager for Energy Legal Tag",
"properties": {
"countryOfOrigin": [
"US"
],
"contractId": "A1234",
"expirationDate": "2099-01-25",
"originator": "MyCompany",
"dataType": "Public Domain Data",
"securityClassification": "Public",
"personalData": "No Personal Data",
"exportClassification": "EAR99"
}
}
The country/region of origin should follow ISO Alpha2 format.
This API internally appends data-partition-id to legal tag name if it isn't already present. For instance, if request has name as: legal-tag, then the create legal tag name would be <instancename>-<data-partition-id>-legal-tag.
curl --location --request POST 'https://medstest.energy.azure.com/api/legal/v1/legaltags' \
--header 'data-partition-id: medstest-dp1' \
--header 'Authorization: Bearer eyxxxxxxx.........................' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "legal-tag",
"description": "Azure Data Manager for Energy Legal Tag",
"properties": {
"contractId": "A1234",
"countryOfOrigin": ["US"],
"dataType": "Public Domain Data",
"expirationDate": "2099-01-25",
"exportClassification": "EAR99",
"originator": "MyCompany",
"personalData": "No Personal Data",
"securityClassification": "Public"
}
}'
The sample response has data-partition-id appended to the legal tag name.
{
"name": "medstest-dp1-legal-tag",
"description": "Azure Data Manager for Energy Legal Tag",
"properties": {
"countryOfOrigin": [
"US"
],
"contractId": "A1234",
"expirationDate": "2099-01-25",
"originator": "MyCompany",
"dataType": "Public Domain Data",
"securityClassification": "Public",
"personalData": "No Personal Data",
"exportClassification": "EAR99"
}
}
Get a legal tag
Run the curl command in Azure Cloud Bash to get the legal tag associated with a data partition of your Azure Data Manager for Energy instance.
curl --location --request GET 'https://<URI>/api/legal/v1/legaltags/<legal-tag-name>' \
--header 'data-partition-id: <data-partition-id>' \
--header 'Authorization: Bearer <access_token>'
Sample request
Consider an Azure Data Manager for Energy instance named medstest with a data partition named "dp1":
curl --location --request GET 'https://medstest.energy.azure.com/api/legal/v1/legaltags/medstest-dp1-legal-tag' \
--header 'data-partition-id: medstest-dp1' \
--header 'Authorization: Bearer eyxxxxxxx.........................'
Sample response
{
"name": "medstest-dp1-legal-tag",
"description": "Azure Data Manager for Energy Legal Tag",
"properties": {
"countryOfOrigin": [
"US"
],
"contractId": "A1234",
"expirationDate": "2099-01-25",
"originator": "MyCompany",
"dataType": "Public Domain Data",
"securityClassification": "Public",
"personalData": "No Personal Data",
"exportClassification": "EAR99"
}
}