{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/pipeliner/main/json-schema/pipeliner-master-right-schema.json", "title": "MasterRight", "x-generated": "2026-09-22", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/pipeliner-openapi.json#/components/schemas/MasterRight", "properties": { "is_delete_protected": { "type": "boolean", "description": "Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.", "readOnly": true }, "id": { "type": "string", "format": "uuid", "description": "Unique identifier of entity.", "readOnly": true }, "is_deleted": { "type": "boolean", "description": "Specifies if the entity is considered deleted.", "readOnly": true }, "modified": { "type": "string", "format": "date-time", "description": "Last modification time.", "readOnly": true }, "created": { "type": "string", "format": "date-time", "description": "Creation time.", "readOnly": true }, "access_account_relation_types": { "type": "boolean", "description": "Controls access to resource." }, "access_accounts": { "type": "boolean", "description": "Controls access to resource." }, "access_ai_automatizer": { "type": "boolean", "description": "Controls access to resource." }, "access_ai_online_forms": { "type": "boolean", "description": "Controls access to resource." }, "access_ai_record_detail": { "type": "boolean", "description": "Controls access to resource." }, "access_ai_record_enrichment": { "type": "boolean", "description": "Controls access to resource." }, "access_ai_relationship_charts": { "type": "boolean", "description": "Controls access to resource." }, "access_ai_reports": { "type": "boolean", "description": "Controls access to resource." }, "access_ai_smart_field": { "type": "boolean", "description": "Controls access to resource." }, "access_appointment_scheduler": { "type": "boolean", "description": "Controls access to resource." }, "access_appointment_scheduler_management": { "type": "boolean", "description": "Controls access to resource." }, "access_approval_processes": { "type": "boolean", "description": "Controls access to resource." }, "access_approval_processes_management": { "type": "boolean", "description": "Controls access to resource." }, "access_approvals": { "type": "boolean", "description": "Controls access to resource." }, "access_archive": { "type": "boolean", "description": "Controls access to resource." }, "access_audit": { "type": "boolean", "description": "Controls access to resource." }, "access_audit_log": { "type": "boolean", "description": "Controls access to resource." }, "access_bulk_update": { "type": "boolean", "description": "Controls access to resource." }, "access_calling": { "type": "boolean", "description": "Controls access to resource." }, "access_calling_company_phone": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "enum": [ 0, 1, 2 ] }, "access_calling_purchase_phone": { "type": "boolean", "description": "Controls access to resource." }, "access_company_emails": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "enum": [ 0, 1, 2 ] }, "access_contacts": { "type": "boolean", "description": "Controls access to resource." }, "access_document_management": { "type": "boolean", "description": "Controls access to resource." }, "access_document_management_company": { "type": "boolean", "description": "Controls access to resource." }, "access_document_management_record": { "type": "boolean", "description": "Controls access to resource." }, "access_duplicate_checker": { "type": "boolean", "description": "Controls access to resource." }, "access_email_notification_enforcement": { "type": "boolean", "description": "Controls access to resource." }, "access_email_notification_settings": { "type": "object", "description": "Default email notification preferences applied to users with this role (which events trigger an email and through which channel)." }, "access_entity_account": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "enum": [ 0, 1, 2, 3, 4 ] }, "access_entity_account_copy": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_account_delete": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_account_direction": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "access_entity_account_private": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_account_tag_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_account_types": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "enum": [ 1, 2 ] }, "access_entity_appointment": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "enum": [ 0, 1, 2, 3, 4 ] }, "access_entity_appointment_delete": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_appointment_direction": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "access_entity_appointment_tag_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_better_navigator": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "enum": [ 0, 1, 4 ] }, "access_entity_better_navigator_delete_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_better_navigator_delete_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_better_navigator_sharing_custom": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_better_navigator_sharing_public": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_contact": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "enum": [ 0, 1, 2, 3, 4 ] }, "access_entity_contact_copy": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_contact_delete": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_contact_direction": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "access_entity_contact_private": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_contact_tag_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_contact_types": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "enum": [ 1, 2 ] }, "access_entity_dashboard": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "enum": [ 0, 1, 4 ] }, "access_entity_dashboard_delete_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_dashboard_delete_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_dashboard_sharing_custom": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_dashboard_sharing_public": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_email_content_share_mode": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - PrivateOnly, 1 - Custom, 2 - PublicOnly", "enum": [ 0, 1, 2 ] }, "access_entity_email_delete_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_email_sequence": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "enum": [ 1, 2, 3 ] }, "access_entity_email_template": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "enum": [ 0, 1, 4 ] }, "access_entity_email_template_create_delete_folder": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_email_template_delete_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_email_template_delete_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_email_template_sharing_custom": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_email_template_sharing_public": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_forecast": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "enum": [ 0, 1, 4 ] }, "access_entity_forecast_delete_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_forecast_delete_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_forecast_edit_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_forecast_sharing_custom": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_forecast_sharing_public": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_form_view": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "enum": [ 0, 1, 4 ] }, "access_entity_form_view_delete_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_form_view_delete_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_form_view_sharing_custom": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_form_view_sharing_public": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_lead": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "enum": [ 0, 1, 2, 3, 4 ] }, "access_entity_lead_copy": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_lead_delete": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_lead_direction": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "access_entity_lead_private": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_lead_tag_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_lead_types": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "enum": [ 1, 2 ] }, "access_entity_message_tag_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_oppty": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "enum": [ 0, 1, 2, 3, 4 ] }, "access_entity_oppty_copy": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_oppty_delete": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_oppty_direction": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "access_entity_oppty_private": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_oppty_tag_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_pipeline": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoPipeline, 1 - Selected, 2 - AllNoDocuments, 3 - AllWithDocuments", "enum": [ 0, 1, 2, 3 ] }, "access_entity_process": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - FullAccess, 2 - Personal, 3 - NoAccess", "enum": [ 1, 2, 3 ] }, "access_entity_profile": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "enum": [ 0, 1, 4 ] }, "access_entity_profile_default_screen_profiles": { "type": "object", "description": "Default screen profile ids assigned to users with this role for each main screen (Navigator, Pipeline, Lead, Account, Contact, Activity, Project, Quote, etc.)." }, "access_entity_profile_delete_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_profile_delete_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_profile_sharing_custom": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_profile_sharing_public": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_project": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "enum": [ 0, 1, 2, 3, 4 ] }, "access_entity_project_copy": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_project_delete": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_project_direction": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "access_entity_project_private": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_project_tag_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_quote": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "enum": [ 0, 1, 2, 3, 4 ] }, "access_entity_quote_copy": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_quote_delete": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_quote_direction": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "access_entity_quote_tag_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_quote_types": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - All, 2 - Selected", "enum": [ 1, 2 ] }, "access_entity_report": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "enum": [ 0, 1, 4 ] }, "access_entity_report_create_delete_folder": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_report_delete_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_report_delete_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_report_private": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_report_schedule_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_report_schedule_management": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_report_sharing_custom": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_report_sharing_public": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_target": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 4 - All", "enum": [ 0, 1, 4 ] }, "access_entity_target_delete_not_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_target_delete_owned": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_task": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Readonly, 2 - Editor, 3 - EditorOrUnitManger, 4 - All", "enum": [ 0, 1, 2, 3, 4 ] }, "access_entity_task_delete": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_task_direction": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 1 - Owned, 2 - Current, 3 - CurrentAndParent, 4 - CurrentAndSubunit, 5 - CurrentAndParentAndSubunit, 6 - All", "enum": [ 1, 2, 3, 4, 5, 6 ] }, "access_entity_task_tag_create": { "type": "boolean", "description": "Controls access to resource." }, "access_entity_task_unassigned": { "type": "boolean", "description": "Controls access to resource." }, "access_export": { "type": "boolean", "description": "Controls access to resource." }, "access_feeds": { "type": "boolean", "description": "Controls access to resource." }, "access_foreign_currencies": { "type": "boolean", "description": "Controls access to resource." }, "access_form_and_fields": { "type": "boolean", "description": "Controls access to resource." }, "access_global_settings": { "type": "boolean", "description": "Controls access to resource." }, "access_home_screen": { "type": "boolean", "description": "Controls access to resource." }, "access_import": { "type": "boolean", "description": "Controls access to resource." }, "access_insights": { "type": "boolean", "description": "Controls access to resource." }, "access_leads": { "type": "boolean", "description": "Controls access to resource." }, "access_online_forms": { "type": "boolean", "description": "Controls access to resource." }, "access_online_forms_management": { "type": "boolean", "description": "Controls access to resource." }, "access_opportunity": { "type": "boolean", "description": "Controls access to resource." }, "access_pipeline_configuration": { "type": "boolean", "description": "Controls access to resource." }, "access_print": { "type": "boolean", "description": "Controls access to resource." }, "access_products_services": { "type": "boolean", "description": "Controls access to resource." }, "access_projects": { "type": "boolean", "description": "Controls access to resource." }, "access_quotes": { "type": "boolean", "description": "Controls access to resource." }, "access_sales_roles": { "type": "boolean", "description": "Controls access to resource." }, "access_security": { "type": "boolean", "description": "Controls access to resource." }, "access_units": { "type": "boolean", "description": "Controls access to resource." }, "access_user_and_roles": { "type": "boolean", "description": "Controls access to resource." }, "access_whats_app_company_phone": { "type": "integer", "description": "Field whose values are strictly defined with an enumeration of values.\n\nInteger enum value: 0 - NoAccess, 1 - Selected, 2 - All", "enum": [ 0, 1, 2 ] }, "name": { "type": "string", "description": "Name of the entity and its default text representation." }, "revision": { "type": "integer", "format": "int32", "description": "Revision when entity was lastly changed." }, "allowed_pipelines": { "type": "array", "items": { "type": "string", "format": "uri", "description": "Relation to AllowedPipeline. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedPipeline' object for properties." }, "description": "Pipelines this user role can use. Effective only when access_entity_pipeline is set to Selected; with All-* values every pipeline is granted." }, "allowed_lead_types": { "type": "array", "items": { "type": "string", "format": "uri", "description": "Relation to AllowedLeadType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedLeadType' object for properties." }, "description": "Lead types this user role can use. Effective only when access_entity_lead_types is set to Selected." }, "allowed_quote_types": { "type": "array", "items": { "type": "string", "format": "uri", "description": "Relation to AllowedQuoteType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedQuoteType' object for properties." }, "description": "Quote types this user role can use. Effective only when access_entity_quote_types is set to Selected." }, "allowed_account_types": { "type": "array", "items": { "type": "string", "format": "uri", "description": "Relation to AllowedAccountType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedAccountType' object for properties." }, "description": "Account types this user role can use. Effective only when access_entity_account_types is set to Selected." }, "allowed_contact_types": { "type": "array", "items": { "type": "string", "format": "uri", "description": "Relation to AllowedContactType. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedContactType' object for properties." }, "description": "Contact types this user role can use. Effective only when access_entity_contact_types is set to Selected." }, "allowed_company_emails": { "type": "array", "items": { "type": "string", "format": "uri", "description": "Relation to AllowedCompanyEmail. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedCompanyEmail' object for properties." }, "description": "Company email addresses this user role can send from. Effective only when access_company_emails is set to Selected." }, "allowed_company_phones": { "type": "array", "items": { "type": "string", "format": "uri", "description": "Relation to AllowedCompanyPhone. By default it is returned as URI to related resource. Using parameter 'expand', it will return full entity. See: 'AllowedCompanyPhone' object for properties." }, "description": "Company phones this user role can use for calling/SMS. Effective only when access_calling_company_phone is set to Selected." }, "custom_entities": { "type": "string", "format": "binary", "description": "Per-custom-entity access settings (access level, allowed types, default screen profile, etc.) for users with this role. One entry per custom entity defined in the space." } }, "required": [ "is_delete_protected", "id", "name" ] }