Customization
This page describe all API used to customize your Truedat installation
Custom permissions
Allows to define custom permissions and permission groups to be assigned in your application roles
Get all permission groups defined in your installation
GET https://my-organization.truedat.io/api/permission_groups
{
"data": [
{
"id": 1,
"name": "taxonomy_membership"
},
{
"id": 2,
"name": "taxonomy"
},
{
"id": 4,
"name": "data_dictionary"
},
{
"id": 6,
"name": "ingests"
},
{
"id": 7,
"name": "dashboards"
},
{
"id": 8,
"name": "lineage"
},
{
"id": 298,
"name": "configurations"
},
{
"id": 302,
"name": "data_sources"
},
{
"id": 387,
"name": "business_glossary_management"
},
{
"id": 388,
"name": "business_glossary_view"
},
{
"id": 1415,
"name": "data_dictionary_structure_notes"
},
{
"id": 1550,
"name": "grants"
},
{
"id": 6570,
"name": "quality"
},
{
"id": 6571,
"name": "quality_implementation_additional_actions"
},
{
"id": 6572,
"name": "quality_implementation_workflow_management"
}
]
}Create permission group
POST https://my-organization.truedat.io/api/permission_groups
Payload example:
{ "permission_group":
{ "name": "custom.Custom permissions group" }
}
Request Body
| Name | Type | Description |
|---|---|---|
name* | Needs to begin with "custom." |
{
"data": {
"id": 9548,
"name": "custom.Custom permissions group"
}
}Delete a permission group
DELETE https://my-organization.truedat.io/api/permission_groups/:id
In order to delete a permission group it should have not permission assigned
Path Parameters
| Name | Type | Description |
|---|---|---|
* | String |
{
// Response
}Create permission
POST https://my-organization.truedat.io/api/permissions
{
"permission":
{
"name": "custom.Custom permission",
"permission_group_id": 9548
}
}
Delete a custom permission
DELETE https://my-organization.truedat.io/api/permissions/:id
Get all permissions defined in your installation
GET https://my-organization.truedat.io/api/permissions
{
"data": [
{
"group": {
"id": 1550,
"name": "grants"
},
"id": 36355,
"name": "request_grant_removal"
},
{
"group": {
"id": 6570,
"name": "quality"
},
"id": 30,
"name": "manage_quality_rule"
},
{
"group": {
"id": 6570,
"name": "quality"
},
"id": 48,
"name": "view_quality_rule"
},
{
"group": {
"id": 6571,
"name": "quality_implementation_additional_actions"
},
"id": 50,
"name": "execute_quality_rule_implementations"
},
{
"group": {
"id": 6572,
"name": "quality_implementation_workflow_management"
},
"id": 49,
"name": "manage_quality_rule_implementations"
},
{
"group": {
"id": 1,
"name": "taxonomy_membership"
},
"id": 1,
"name": "create_acl_entry"
},
{
"group": {
"id": 1,
"name": "taxonomy_membership"
},
"id": 2,
"name": "update_acl_entry"
},
{
"group": {
"id": 1,
"name": "taxonomy_membership"
},
"id": 3,
"name": "delete_acl_entry"
},
{
"group": {
"id": 2,
"name": "taxonomy"
},
"id": 4,
"name": "create_domain"
},
{
"group": {
"id": 2,
"name": "taxonomy"
},
"id": 5,
"name": "update_domain"
},
{
"group": {
"id": 2,
"name": "taxonomy"
},
"id": 6,
"name": "delete_domain"
},
{
"group": {
"id": 2,
"name": "taxonomy"
},
"id": 7,
"name": "view_domain"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 49218,
"name": "view_protected_metadata"
},
{
"group": {
"id": 1550,
"name": "grants"
},
"id": 49562,
"name": "create_foreign_grant_request"
},
{
"group": {
"id": 1550,
"name": "grants"
},
"id": 49563,
"name": "allow_foreign_grant_request"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 22,
"name": "update_data_structure"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 23,
"name": "view_data_structure"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 24,
"name": "create_data_structure"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 25,
"name": "delete_data_structure"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 45,
"name": "manage_confidential_structures"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 47,
"name": "view_data_structures_profile"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 51,
"name": "link_data_structure"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 52,
"name": "manage_structures_metadata"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 32,
"name": "create_ingest"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 33,
"name": "update_ingest"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 34,
"name": "send_ingest_for_approval"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 35,
"name": "delete_ingest"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 36,
"name": "publish_ingest"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 37,
"name": "reject_ingest"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 38,
"name": "deprecate_ingest"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 39,
"name": "view_draft_ingests"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 40,
"name": "view_approval_pending_ingests"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 41,
"name": "view_published_ingests"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 8,
"name": "create_business_concept"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 9,
"name": "update_business_concept"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 10,
"name": "send_business_concept_for_approval"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 11,
"name": "delete_business_concept"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 12,
"name": "publish_business_concept"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 13,
"name": "reject_business_concept"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 14,
"name": "deprecate_business_concept"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 16,
"name": "view_draft_business_concepts"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 17,
"name": "view_approval_pending_business_concepts"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 20,
"name": "view_rejected_business_concepts"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 21,
"name": "view_deprecated_business_concepts"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 29,
"name": "manage_business_concept_links"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 31,
"name": "manage_confidential_business_concepts"
},
{
"group": {
"id": 388,
"name": "business_glossary_view"
},
"id": 18,
"name": "view_published_business_concepts"
},
{
"group": {
"id": 388,
"name": "business_glossary_view"
},
"id": 19,
"name": "view_versioned_business_concepts"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 42,
"name": "view_versioned_ingests"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 43,
"name": "view_rejected_ingests"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 44,
"name": "view_deprecated_ingests"
},
{
"group": {
"id": 6,
"name": "ingests"
},
"id": 46,
"name": "manage_ingest_relations"
},
{
"group": {
"id": 7,
"name": "dashboards"
},
"id": 53,
"name": "view_dashboard"
},
{
"group": {
"id": 8,
"name": "lineage"
},
"id": 54,
"name": "view_lineage"
},
{
"group": {
"id": 298,
"name": "configurations"
},
"id": 1935,
"name": "manage_configurations"
},
{
"group": {
"id": 302,
"name": "data_sources"
},
"id": 1950,
"name": "manage_data_sources"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 5928,
"name": "profile_structures"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 6793,
"name": "link_data_structure_tag"
},
{
"group": {
"id": 1415,
"name": "data_dictionary_structure_notes"
},
"id": 7399,
"name": "create_structure_note"
},
{
"group": {
"id": 1415,
"name": "data_dictionary_structure_notes"
},
"id": 7400,
"name": "edit_structure_note"
},
{
"group": {
"id": 1415,
"name": "data_dictionary_structure_notes"
},
"id": 7401,
"name": "send_structure_note_to_approval"
},
{
"group": {
"id": 1415,
"name": "data_dictionary_structure_notes"
},
"id": 7402,
"name": "reject_structure_note"
},
{
"group": {
"id": 1415,
"name": "data_dictionary_structure_notes"
},
"id": 7403,
"name": "unreject_structure_note"
},
{
"group": {
"id": 1415,
"name": "data_dictionary_structure_notes"
},
"id": 7404,
"name": "deprecate_structure_note"
},
{
"group": {
"id": 1415,
"name": "data_dictionary_structure_notes"
},
"id": 7405,
"name": "publish_structure_note"
},
{
"group": {
"id": 1415,
"name": "data_dictionary_structure_notes"
},
"id": 7406,
"name": "delete_structure_note"
},
{
"group": {
"id": 6571,
"name": "quality_implementation_additional_actions"
},
"id": 22835,
"name": "manage_rule_results"
},
{
"group": {
"id": 6571,
"name": "quality_implementation_additional_actions"
},
"id": 26313,
"name": "link_implementation_business_concept"
},
{
"group": {
"id": 1415,
"name": "data_dictionary_structure_notes"
},
"id": 7409,
"name": "publish_structure_note_from_draft"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 7459,
"name": "manage_structures_domain"
},
{
"group": {
"id": 1550,
"name": "grants"
},
"id": 8153,
"name": "view_grants"
},
{
"group": {
"id": 1550,
"name": "grants"
},
"id": 8154,
"name": "manage_grants"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 8328,
"name": "share_with_domain"
},
{
"group": {
"id": 1550,
"name": "grants"
},
"id": 9553,
"name": "create_grant_request"
},
{
"group": {
"id": 1550,
"name": "grants"
},
"id": 12039,
"name": "approve_grant_request"
},
{
"group": {
"id": 387,
"name": "business_glossary_management"
},
"id": 22950,
"name": "manage_business_concepts_domain"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 7407,
"name": "view_structure_note"
},
{
"group": {
"id": 4,
"name": "data_dictionary"
},
"id": 7408,
"name": "view_structure_note_history"
},
{
"group": {
"id": 6571,
"name": "quality_implementation_additional_actions"
},
"id": 26764,
"name": "manage_remediations"
},
{
"group": {
"id": 6571,
"name": "quality_implementation_additional_actions"
},
"id": 31629,
"name": "link_implementation_structure"
},
{
"group": {
"id": 6571,
"name": "quality_implementation_additional_actions"
},
"id": 32705,
"name": "manage_segments"
},
{
"group": {
"id": 6572,
"name": "quality_implementation_workflow_management"
},
"id": 492,
"name": "manage_raw_quality_rule_implementations"
},
{
"group": {
"id": 6572,
"name": "quality_implementation_workflow_management"
},
"id": 34342,
"name": "manage_ruleless_implementations"
},
{
"group": {
"id": 6572,
"name": "quality_implementation_workflow_management"
},
"id": 35692,
"name": "publish_implementation"
}
]
}