Workspaceintegration data model

Updated:

FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstringNo(reference to KmsSpace)
integration_typestringYes
is_activebooleanYes
api_urlstringNo
authorize_urlstringNo
token_urlstringNo
refresh_urlstringNo
base_urlstringNo
prompt_regionbooleanNo
use_unified_redirectbooleanNo
auth_typeenumNothe authentication method to use for this workspace integration; when set, it overrides the default auth-method selection (e.g. force 'token' even when Unified OAUTH credentials exist) Values: oauth2, other, token
environmentstringNoauthentication environment
categoriesenumNoderived from permissions (plus the auth, passthrough and saml categories, which have no permissions) Values: passthrough, hris, ats, auth, saml, crm, enrich, martech, ticketing, uc, accounting, storage, commerce, payment, genai, messaging, kms, task, scim, lms, repo, metadata, calendar, verification, ads, analytics, forms, shipping, assessment, signing, clubs, datastore, cdp, performance, social, legal, compute, healthcare, property, plm
permissionsenumNothe unified permission scopes enabled for this integration; requested when an authorization URL omits scopes Values: accounting_account_read, accounting_account_write, accounting_transaction_read, accounting_transaction_write, accounting_journal_read, accounting_journal_write, accounting_invoice_read, accounting_invoice_write, accounting_bill_read, accounting_bill_write, accounting_vendorcredit_read, accounting_vendorcredit_write, accounting_creditmemo_read, accounting_creditmemo_write, accounting_contact_read, accounting_contact_write, accounting_expense_read, accounting_expense_write, accounting_expensereport_read, accounting_expensereport_write, accounting_purchasereceipt_read, accounting_purchasereceipt_write, accounting_taxrate_read, accounting_taxrate_write, accounting_paymentterm_read, accounting_paymentterm_write, accounting_organization_read, accounting_order_read, accounting_order_write, accounting_purchaseorder_read, accounting_purchaseorder_write, accounting_salesorder_read, accounting_salesorder_write, accounting_salesreceipt_read, accounting_salesreceipt_write, accounting_trialbalance_read, accounting_trialbalance_write, accounting_profitloss_read, accounting_profitloss_write, accounting_balancesheet_read, accounting_balancesheet_write, accounting_category_read, accounting_category_write, payment_payment_read, payment_payment_write, accounting_cashflow_read, accounting_cashflow_write, accounting_quote_read, accounting_quote_write, accounting_agedreceivable_read, accounting_agedpayable_read, accounting_project_read, accounting_project_write, accounting_bankfeedaccount_read, accounting_bankfeedaccount_write, accounting_bankfeedtransaction_read, accounting_bankfeedtransaction_write, payment_payout_read, payment_refund_read, payment_link_read, payment_link_write, payment_subscription_read, payment_subscription_write, commerce_item_read, commerce_item_write, commerce_collection_read, commerce_collection_write, commerce_inventory_read, commerce_inventory_write, commerce_location_read, commerce_location_write, commerce_review_read, commerce_review_write, commerce_saleschannel_read, commerce_saleschannel_write, commerce_itemvariant_read, commerce_itemvariant_write, commerce_reservation_read, commerce_reservation_write, commerce_table_read, commerce_table_write, commerce_return_read, commerce_return_write, commerce_availability_read, commerce_availability_write, verification_package_read, verification_request_read, verification_request_write, assessment_package_read, assessment_package_write, assessment_order_write, ats_activity_read, ats_activity_write, ats_application_read, ats_application_write, ats_applicationstatus_read, ats_candidate_read, ats_candidate_write, ats_interview_read, ats_interview_write, ats_job_read, ats_job_write, ats_company_read, ats_company_write, ats_document_read, ats_document_write, ats_scorecard_read, ats_scorecard_write, crm_company_read, crm_company_write, crm_contact_read, crm_contact_write, crm_deal_read, crm_deal_write, crm_event_read, crm_event_write, crm_lead_read, crm_lead_write, crm_pipeline_read, crm_pipeline_write, crm_taxonomy_read, martech_list_read, martech_list_write, martech_member_read, martech_member_write, martech_campaign_read, martech_campaign_write, martech_report_read, martech_report_write, ticketing_customer_read, ticketing_customer_write, ticketing_ticket_read, ticketing_ticket_write, ticketing_note_read, ticketing_note_write, ticketing_category_read, ticketing_category_write, hris_employee_read, hris_employee_write, hris_group_read, hris_group_write, hris_payslip_read, hris_payslip_write, hris_timeoff_read, hris_timeoff_write, hris_timeshift_read, hris_timeshift_write, hris_attendance_read, hris_attendance_write, hris_company_read, hris_company_write, hris_location_read, hris_location_write, hris_device_read, hris_device_write, hris_deduction_read, hris_deduction_write, hris_benefit_read, hris_benefit_write, hris_bankaccount_read, hris_bankaccount_write, hris_document_read, hris_document_write, hris_taxonomy_read, hris_taxonomy_write, hris_job_read, hris_job_write, hris_payroll_read, hris_payroll_write, hris_paycode_read, hris_paycode_write, hris_earning_read, hris_earning_write, uc_call_read, uc_call_write, uc_contact_read, uc_contact_write, uc_fax_read, uc_fax_write, uc_comment_read, uc_comment_write, uc_recording_read, uc_scorecard_read, uc_scorecardtemplate_read, storage_file_read, storage_file_write, webhook, genai_model_read, genai_prompt_read, genai_prompt_write, genai_embedding_read, genai_embedding_write, genai_task_read, genai_task_write, genai_agent_read, genai_agent_write, genai_organization_read, genai_organization_write, genai_skill_read, genai_skill_write, genai_memory_read, genai_memory_write, messaging_message_read, messaging_message_write, messaging_channel_read, messaging_channel_write, messaging_event_read, messaging_event_write, kms_space_read, kms_space_write, kms_page_read, kms_page_write, kms_comment_read, kms_comment_write, task_project_read, task_project_write, task_task_read, task_task_write, task_change_read, task_comment_read, task_comment_write, scim_users_read, scim_users_write, scim_groups_read, scim_groups_write, lms_course_read, lms_course_write, lms_class_read, lms_class_write, lms_student_read, lms_student_write, lms_instructor_read, lms_instructor_write, lms_content_read, lms_content_write, lms_collection_read, lms_collection_write, lms_activity_read, lms_activity_write, repo_organization_read, repo_organization_write, repo_repository_read, repo_repository_write, repo_branch_read, repo_branch_write, repo_commit_read, repo_commit_write, repo_pullrequest_read, repo_pullrequest_write, metadata_metadata_read, metadata_metadata_write, calendar_calendar_read, calendar_calendar_write, calendar_event_read, calendar_event_write, calendar_busy_read, calendar_link_read, calendar_link_write, calendar_recording_read, calendar_recording_write, calendar_webinar_read, calendar_webinar_write, calendar_bot_read, calendar_bot_write, calendar_botevent_read, calendar_room_read, calendar_location_read, enrich_person_read, enrich_company_read, ads_ad_read, ads_ad_write, ads_campaign_read, ads_campaign_write, ads_group_read, ads_group_write, ads_report_read, ads_organization_read, ads_organization_write, ads_creative_read, ads_creative_write, ads_asset_read, ads_asset_write, ads_insertionorder_read, ads_insertionorder_write, ads_target_read, ads_promoted_read, analytics_property_read, analytics_property_write, analytics_event_read, analytics_event_write, analytics_session_read, analytics_visitor_read, analytics_visitor_write, analytics_report_read, forms_form_read, forms_form_write, forms_submission_read, forms_submission_write, shipping_shipment_read, shipping_shipment_write, shipping_label_read, shipping_label_write, shipping_tracking_read, shipping_rate_read, shipping_rate_write, shipping_carrier_read, signing_document_read, signing_document_write, signing_signatory_read, signing_signatory_write, signing_template_read, signing_template_write, clubs_group_read, clubs_group_write, clubs_member_read, clubs_member_write, clubs_activity_read, clubs_activity_write, clubs_location_read, clubs_location_write, clubs_event_read, clubs_event_write, datastore_database_read, datastore_database_write, datastore_table_read, datastore_table_write, datastore_record_read, datastore_record_write, datastore_query_read, datastore_query_write, cdp_profile_read, cdp_profile_write, cdp_segment_read, cdp_segment_write, cdp_event_read, cdp_event_write, cdp_source_read, cdp_source_write, cdp_destination_read, cdp_destination_write, cdp_activation_read, cdp_activation_write, performance_cycle_read, performance_review_read, performance_review_write, performance_goal_read, performance_goal_write, performance_feedback_read, performance_feedback_write, social_post_read, social_post_write, social_profile_read, social_profile_write, social_review_read, social_review_write, social_insight_read, social_insight_write, legal_matter_read, legal_matter_write, legal_practicearea_read, legal_practicearea_write, legal_timeentry_read, legal_timeentry_write, legal_expense_read, legal_expense_write, compute_instance_read, compute_instance_write, compute_template_read, compute_template_write, compute_gputype_read, compute_region_read, compute_volume_read, compute_volume_write, compute_snapshot_read, compute_snapshot_write, compute_usage_read, compute_key_read, compute_key_write, compute_service_read, compute_service_write, compute_deployment_read, compute_deployment_write, compute_domain_read, compute_domain_write, compute_envvar_read, compute_envvar_write, healthcare_patient_read, healthcare_patient_write, healthcare_practitioner_read, healthcare_practitioner_write, healthcare_location_read, healthcare_location_write, healthcare_appointment_read, healthcare_appointment_write, healthcare_slot_read, healthcare_slot_write, healthcare_encounter_read, healthcare_encounter_write, healthcare_condition_read, healthcare_condition_write, healthcare_allergy_read, healthcare_allergy_write, healthcare_medication_read, healthcare_medication_write, healthcare_observation_read, healthcare_observation_write, healthcare_immunization_read, healthcare_immunization_write, healthcare_document_read, healthcare_document_write, healthcare_coverage_read, healthcare_coverage_write, healthcare_procedure_read, healthcare_procedure_write, healthcare_report_read, healthcare_report_write, healthcare_careplan_read, healthcare_careplan_write, healthcare_goal_read, healthcare_goal_write, property_listing_read, property_listing_write, property_unittype_read, property_guest_read, property_guest_write, property_reservation_read, property_reservation_write, property_availability_read, property_quote_read, property_quote_write, property_review_read, property_review_write, property_conversation_read, property_conversation_write, plm_part_read, plm_part_write, plm_bomline_read, plm_bomline_write, plm_document_read, plm_document_write, plm_change_read, plm_change_write, plm_category_read, plm_category_write
overriden_scopesobjectNo
overriden_scopes.accounting_account_readstringNo
overriden_scopes.accounting_account_writestringNo
overriden_scopes.accounting_transaction_readstringNo
overriden_scopes.accounting_transaction_writestringNo
overriden_scopes.accounting_journal_readstringNo
overriden_scopes.accounting_journal_writestringNo
overriden_scopes.accounting_invoice_readstringNo
overriden_scopes.accounting_invoice_writestringNo
overriden_scopes.accounting_bill_readstringNo
overriden_scopes.accounting_bill_writestringNo
overriden_scopes.accounting_vendorcredit_readstringNo
overriden_scopes.accounting_vendorcredit_writestringNo
overriden_scopes.accounting_creditmemo_readstringNo
overriden_scopes.accounting_creditmemo_writestringNo
overriden_scopes.accounting_contact_readstringNo
overriden_scopes.accounting_contact_writestringNo
overriden_scopes.accounting_expense_readstringNo
overriden_scopes.accounting_expense_writestringNo
overriden_scopes.accounting_expensereport_readstringNo
overriden_scopes.accounting_expensereport_writestringNo
overriden_scopes.accounting_purchasereceipt_readstringNo
overriden_scopes.accounting_purchasereceipt_writestringNo
overriden_scopes.accounting_taxrate_readstringNo
overriden_scopes.accounting_taxrate_writestringNo
overriden_scopes.accounting_paymentterm_readstringNo
overriden_scopes.accounting_paymentterm_writestringNo
overriden_scopes.accounting_organization_readstringNo
overriden_scopes.accounting_order_readstringNo
overriden_scopes.accounting_order_writestringNo
overriden_scopes.accounting_purchaseorder_readstringNo
overriden_scopes.accounting_purchaseorder_writestringNo
overriden_scopes.accounting_salesorder_readstringNo
overriden_scopes.accounting_salesorder_writestringNo
overriden_scopes.accounting_salesreceipt_readstringNo
overriden_scopes.accounting_salesreceipt_writestringNo
overriden_scopes.accounting_trialbalance_readstringNo
overriden_scopes.accounting_trialbalance_writestringNo
overriden_scopes.accounting_profitloss_readstringNo
overriden_scopes.accounting_profitloss_writestringNo
overriden_scopes.accounting_balancesheet_readstringNo
overriden_scopes.accounting_balancesheet_writestringNo
overriden_scopes.accounting_category_readstringNo
overriden_scopes.accounting_category_writestringNo
overriden_scopes.payment_payment_readstringNo
overriden_scopes.payment_payment_writestringNo
overriden_scopes.accounting_cashflow_readstringNo
overriden_scopes.accounting_cashflow_writestringNo
overriden_scopes.accounting_quote_readstringNo
overriden_scopes.accounting_quote_writestringNo
overriden_scopes.accounting_agedreceivable_readstringNo
overriden_scopes.accounting_agedpayable_readstringNo
overriden_scopes.accounting_project_readstringNo
overriden_scopes.accounting_project_writestringNo
overriden_scopes.accounting_bankfeedaccount_readstringNo
overriden_scopes.accounting_bankfeedaccount_writestringNo
overriden_scopes.accounting_bankfeedtransaction_readstringNo
overriden_scopes.accounting_bankfeedtransaction_writestringNo
overriden_scopes.payment_payout_readstringNo
overriden_scopes.payment_refund_readstringNo
overriden_scopes.payment_link_readstringNo
overriden_scopes.payment_link_writestringNo
overriden_scopes.payment_subscription_readstringNo
overriden_scopes.payment_subscription_writestringNo
overriden_scopes.commerce_item_readstringNo
overriden_scopes.commerce_item_writestringNo
overriden_scopes.commerce_collection_readstringNo
overriden_scopes.commerce_collection_writestringNo
overriden_scopes.commerce_inventory_readstringNo
overriden_scopes.commerce_inventory_writestringNo
overriden_scopes.commerce_location_readstringNo
overriden_scopes.commerce_location_writestringNo
overriden_scopes.commerce_review_readstringNo
overriden_scopes.commerce_review_writestringNo
overriden_scopes.commerce_saleschannel_readstringNo
overriden_scopes.commerce_saleschannel_writestringNo
overriden_scopes.commerce_itemvariant_readstringNo
overriden_scopes.commerce_itemvariant_writestringNo
overriden_scopes.commerce_reservation_readstringNo
overriden_scopes.commerce_reservation_writestringNo
overriden_scopes.commerce_table_readstringNo
overriden_scopes.commerce_table_writestringNo
overriden_scopes.commerce_return_readstringNo
overriden_scopes.commerce_return_writestringNo
overriden_scopes.commerce_availability_readstringNo
overriden_scopes.commerce_availability_writestringNo
overriden_scopes.verification_package_readstringNo
overriden_scopes.verification_request_readstringNo
overriden_scopes.verification_request_writestringNo
overriden_scopes.assessment_package_readstringNo
overriden_scopes.assessment_package_writestringNo
overriden_scopes.assessment_order_writestringNo
overriden_scopes.ats_activity_readstringNo
overriden_scopes.ats_activity_writestringNo
overriden_scopes.ats_application_readstringNo
overriden_scopes.ats_application_writestringNo
overriden_scopes.ats_applicationstatus_readstringNo
overriden_scopes.ats_candidate_readstringNo
overriden_scopes.ats_candidate_writestringNo
overriden_scopes.ats_interview_readstringNo
overriden_scopes.ats_interview_writestringNo
overriden_scopes.ats_job_readstringNo
overriden_scopes.ats_job_writestringNo
overriden_scopes.ats_company_readstringNo
overriden_scopes.ats_company_writestringNo
overriden_scopes.ats_document_readstringNo
overriden_scopes.ats_document_writestringNo
overriden_scopes.ats_scorecard_readstringNo
overriden_scopes.ats_scorecard_writestringNo
overriden_scopes.crm_company_readstringNo
overriden_scopes.crm_company_writestringNo
overriden_scopes.crm_contact_readstringNo
overriden_scopes.crm_contact_writestringNo
overriden_scopes.crm_deal_readstringNo
overriden_scopes.crm_deal_writestringNo
overriden_scopes.crm_event_readstringNo
overriden_scopes.crm_event_writestringNo
overriden_scopes.crm_lead_readstringNo
overriden_scopes.crm_lead_writestringNo
overriden_scopes.crm_pipeline_readstringNo
overriden_scopes.crm_pipeline_writestringNo
overriden_scopes.crm_taxonomy_readstringNo
overriden_scopes.martech_list_readstringNo
overriden_scopes.martech_list_writestringNo
overriden_scopes.martech_member_readstringNo
overriden_scopes.martech_member_writestringNo
overriden_scopes.martech_campaign_readstringNo
overriden_scopes.martech_campaign_writestringNo
overriden_scopes.martech_report_readstringNo
overriden_scopes.martech_report_writestringNo
overriden_scopes.ticketing_customer_readstringNo
overriden_scopes.ticketing_customer_writestringNo
overriden_scopes.ticketing_ticket_readstringNo
overriden_scopes.ticketing_ticket_writestringNo
overriden_scopes.ticketing_note_readstringNo
overriden_scopes.ticketing_note_writestringNo
overriden_scopes.ticketing_category_readstringNo
overriden_scopes.ticketing_category_writestringNo
overriden_scopes.hris_employee_readstringNo
overriden_scopes.hris_employee_writestringNo
overriden_scopes.hris_group_readstringNo
overriden_scopes.hris_group_writestringNo
overriden_scopes.hris_payslip_readstringNo
overriden_scopes.hris_payslip_writestringNo
overriden_scopes.hris_timeoff_readstringNo
overriden_scopes.hris_timeoff_writestringNo
overriden_scopes.hris_timeshift_readstringNo
overriden_scopes.hris_timeshift_writestringNo
overriden_scopes.hris_attendance_readstringNo
overriden_scopes.hris_attendance_writestringNo
overriden_scopes.hris_company_readstringNo
overriden_scopes.hris_company_writestringNo
overriden_scopes.hris_location_readstringNo
overriden_scopes.hris_location_writestringNo
overriden_scopes.hris_device_readstringNo
overriden_scopes.hris_device_writestringNo
overriden_scopes.hris_deduction_readstringNo
overriden_scopes.hris_deduction_writestringNo
overriden_scopes.hris_benefit_readstringNo
overriden_scopes.hris_benefit_writestringNo
overriden_scopes.hris_bankaccount_readstringNo
overriden_scopes.hris_bankaccount_writestringNo
overriden_scopes.hris_document_readstringNo
overriden_scopes.hris_document_writestringNo
overriden_scopes.hris_taxonomy_readstringNo
overriden_scopes.hris_taxonomy_writestringNo
overriden_scopes.hris_job_readstringNo
overriden_scopes.hris_job_writestringNo
overriden_scopes.hris_payroll_readstringNo
overriden_scopes.hris_payroll_writestringNo
overriden_scopes.hris_paycode_readstringNo
overriden_scopes.hris_paycode_writestringNo
overriden_scopes.hris_earning_readstringNo
overriden_scopes.hris_earning_writestringNo
overriden_scopes.uc_call_readstringNo
overriden_scopes.uc_call_writestringNo
overriden_scopes.uc_contact_readstringNo
overriden_scopes.uc_contact_writestringNo
overriden_scopes.uc_fax_readstringNo
overriden_scopes.uc_fax_writestringNo
overriden_scopes.uc_comment_readstringNo
overriden_scopes.uc_comment_writestringNo
overriden_scopes.uc_recording_readstringNo
overriden_scopes.uc_scorecard_readstringNo
overriden_scopes.uc_scorecardtemplate_readstringNo
overriden_scopes.storage_file_readstringNo
overriden_scopes.storage_file_writestringNo
overriden_scopes.webhookstringNo
overriden_scopes.genai_model_readstringNo
overriden_scopes.genai_prompt_readstringNo
overriden_scopes.genai_prompt_writestringNo
overriden_scopes.genai_embedding_readstringNo
overriden_scopes.genai_embedding_writestringNo
overriden_scopes.genai_task_readstringNo
overriden_scopes.genai_task_writestringNo
overriden_scopes.genai_agent_readstringNo
overriden_scopes.genai_agent_writestringNo
overriden_scopes.genai_organization_readstringNo
overriden_scopes.genai_organization_writestringNo
overriden_scopes.genai_skill_readstringNo
overriden_scopes.genai_skill_writestringNo
overriden_scopes.genai_memory_readstringNo
overriden_scopes.genai_memory_writestringNo
overriden_scopes.messaging_message_readstringNo
overriden_scopes.messaging_message_writestringNo
overriden_scopes.messaging_channel_readstringNo
overriden_scopes.messaging_channel_writestringNo
overriden_scopes.messaging_event_readstringNo
overriden_scopes.messaging_event_writestringNo
overriden_scopes.kms_space_readstringNo
overriden_scopes.kms_space_writestringNo
overriden_scopes.kms_page_readstringNo
overriden_scopes.kms_page_writestringNo
overriden_scopes.kms_comment_readstringNo
overriden_scopes.kms_comment_writestringNo
overriden_scopes.task_project_readstringNo
overriden_scopes.task_project_writestringNo
overriden_scopes.task_task_readstringNo
overriden_scopes.task_task_writestringNo
overriden_scopes.task_change_readstringNo
overriden_scopes.task_comment_readstringNo
overriden_scopes.task_comment_writestringNo
overriden_scopes.scim_users_readstringNo
overriden_scopes.scim_users_writestringNo
overriden_scopes.scim_groups_readstringNo
overriden_scopes.scim_groups_writestringNo
overriden_scopes.lms_course_readstringNo
overriden_scopes.lms_course_writestringNo
overriden_scopes.lms_class_readstringNo
overriden_scopes.lms_class_writestringNo
overriden_scopes.lms_student_readstringNo
overriden_scopes.lms_student_writestringNo
overriden_scopes.lms_instructor_readstringNo
overriden_scopes.lms_instructor_writestringNo
overriden_scopes.lms_content_readstringNo
overriden_scopes.lms_content_writestringNo
overriden_scopes.lms_collection_readstringNo
overriden_scopes.lms_collection_writestringNo
overriden_scopes.lms_activity_readstringNo
overriden_scopes.lms_activity_writestringNo
overriden_scopes.repo_organization_readstringNo
overriden_scopes.repo_organization_writestringNo
overriden_scopes.repo_repository_readstringNo
overriden_scopes.repo_repository_writestringNo
overriden_scopes.repo_branch_readstringNo
overriden_scopes.repo_branch_writestringNo
overriden_scopes.repo_commit_readstringNo
overriden_scopes.repo_commit_writestringNo
overriden_scopes.repo_pullrequest_readstringNo
overriden_scopes.repo_pullrequest_writestringNo
overriden_scopes.metadata_metadata_readstringNo
overriden_scopes.metadata_metadata_writestringNo
overriden_scopes.calendar_calendar_readstringNo
overriden_scopes.calendar_calendar_writestringNo
overriden_scopes.calendar_event_readstringNo
overriden_scopes.calendar_event_writestringNo
overriden_scopes.calendar_busy_readstringNo
overriden_scopes.calendar_link_readstringNo
overriden_scopes.calendar_link_writestringNo
overriden_scopes.calendar_recording_readstringNo
overriden_scopes.calendar_recording_writestringNo
overriden_scopes.calendar_webinar_readstringNo
overriden_scopes.calendar_webinar_writestringNo
overriden_scopes.calendar_bot_readstringNo
overriden_scopes.calendar_bot_writestringNo
overriden_scopes.calendar_botevent_readstringNo
overriden_scopes.calendar_room_readstringNo
overriden_scopes.calendar_location_readstringNo
overriden_scopes.enrich_person_readstringNo
overriden_scopes.enrich_company_readstringNo
overriden_scopes.ads_ad_readstringNo
overriden_scopes.ads_ad_writestringNo
overriden_scopes.ads_campaign_readstringNo
overriden_scopes.ads_campaign_writestringNo
overriden_scopes.ads_group_readstringNo
overriden_scopes.ads_group_writestringNo
overriden_scopes.ads_report_readstringNo
overriden_scopes.ads_organization_readstringNo
overriden_scopes.ads_organization_writestringNo
overriden_scopes.ads_creative_readstringNo
overriden_scopes.ads_creative_writestringNo
overriden_scopes.ads_asset_readstringNo
overriden_scopes.ads_asset_writestringNo
overriden_scopes.ads_insertionorder_readstringNo
overriden_scopes.ads_insertionorder_writestringNo
overriden_scopes.ads_target_readstringNo
overriden_scopes.ads_promoted_readstringNo
overriden_scopes.analytics_property_readstringNo
overriden_scopes.analytics_property_writestringNo
overriden_scopes.analytics_event_readstringNo
overriden_scopes.analytics_event_writestringNo
overriden_scopes.analytics_session_readstringNo
overriden_scopes.analytics_visitor_readstringNo
overriden_scopes.analytics_visitor_writestringNo
overriden_scopes.analytics_report_readstringNo
overriden_scopes.forms_form_readstringNo
overriden_scopes.forms_form_writestringNo
overriden_scopes.forms_submission_readstringNo
overriden_scopes.forms_submission_writestringNo
overriden_scopes.shipping_shipment_readstringNo
overriden_scopes.shipping_shipment_writestringNo
overriden_scopes.shipping_label_readstringNo
overriden_scopes.shipping_label_writestringNo
overriden_scopes.shipping_tracking_readstringNo
overriden_scopes.shipping_rate_readstringNo
overriden_scopes.shipping_rate_writestringNo
overriden_scopes.shipping_carrier_readstringNo
overriden_scopes.signing_document_readstringNo
overriden_scopes.signing_document_writestringNo
overriden_scopes.signing_signatory_readstringNo
overriden_scopes.signing_signatory_writestringNo
overriden_scopes.signing_template_readstringNo
overriden_scopes.signing_template_writestringNo
overriden_scopes.clubs_group_readstringNo
overriden_scopes.clubs_group_writestringNo
overriden_scopes.clubs_member_readstringNo
overriden_scopes.clubs_member_writestringNo
overriden_scopes.clubs_activity_readstringNo
overriden_scopes.clubs_activity_writestringNo
overriden_scopes.clubs_location_readstringNo
overriden_scopes.clubs_location_writestringNo
overriden_scopes.clubs_event_readstringNo
overriden_scopes.clubs_event_writestringNo
overriden_scopes.datastore_database_readstringNo
overriden_scopes.datastore_database_writestringNo
overriden_scopes.datastore_table_readstringNo
overriden_scopes.datastore_table_writestringNo
overriden_scopes.datastore_record_readstringNo
overriden_scopes.datastore_record_writestringNo
overriden_scopes.datastore_query_readstringNo
overriden_scopes.datastore_query_writestringNo
overriden_scopes.cdp_profile_readstringNo
overriden_scopes.cdp_profile_writestringNo
overriden_scopes.cdp_segment_readstringNo
overriden_scopes.cdp_segment_writestringNo
overriden_scopes.cdp_event_readstringNo
overriden_scopes.cdp_event_writestringNo
overriden_scopes.cdp_source_readstringNo
overriden_scopes.cdp_source_writestringNo
overriden_scopes.cdp_destination_readstringNo
overriden_scopes.cdp_destination_writestringNo
overriden_scopes.cdp_activation_readstringNo
overriden_scopes.cdp_activation_writestringNo
overriden_scopes.performance_cycle_readstringNo
overriden_scopes.performance_review_readstringNo
overriden_scopes.performance_review_writestringNo
overriden_scopes.performance_goal_readstringNo
overriden_scopes.performance_goal_writestringNo
overriden_scopes.performance_feedback_readstringNo
overriden_scopes.performance_feedback_writestringNo
overriden_scopes.social_post_readstringNo
overriden_scopes.social_post_writestringNo
overriden_scopes.social_profile_readstringNo
overriden_scopes.social_profile_writestringNo
overriden_scopes.social_review_readstringNo
overriden_scopes.social_review_writestringNo
overriden_scopes.social_insight_readstringNo
overriden_scopes.social_insight_writestringNo
overriden_scopes.legal_matter_readstringNo
overriden_scopes.legal_matter_writestringNo
overriden_scopes.legal_practicearea_readstringNo
overriden_scopes.legal_practicearea_writestringNo
overriden_scopes.legal_timeentry_readstringNo
overriden_scopes.legal_timeentry_writestringNo
overriden_scopes.legal_expense_readstringNo
overriden_scopes.legal_expense_writestringNo
overriden_scopes.compute_instance_readstringNo
overriden_scopes.compute_instance_writestringNo
overriden_scopes.compute_template_readstringNo
overriden_scopes.compute_template_writestringNo
overriden_scopes.compute_gputype_readstringNo
overriden_scopes.compute_region_readstringNo
overriden_scopes.compute_volume_readstringNo
overriden_scopes.compute_volume_writestringNo
overriden_scopes.compute_snapshot_readstringNo
overriden_scopes.compute_snapshot_writestringNo
overriden_scopes.compute_usage_readstringNo
overriden_scopes.compute_key_readstringNo
overriden_scopes.compute_key_writestringNo
overriden_scopes.compute_service_readstringNo
overriden_scopes.compute_service_writestringNo
overriden_scopes.compute_deployment_readstringNo
overriden_scopes.compute_deployment_writestringNo
overriden_scopes.compute_domain_readstringNo
overriden_scopes.compute_domain_writestringNo
overriden_scopes.compute_envvar_readstringNo
overriden_scopes.compute_envvar_writestringNo
overriden_scopes.healthcare_patient_readstringNo
overriden_scopes.healthcare_patient_writestringNo
overriden_scopes.healthcare_practitioner_readstringNo
overriden_scopes.healthcare_practitioner_writestringNo
overriden_scopes.healthcare_location_readstringNo
overriden_scopes.healthcare_location_writestringNo
overriden_scopes.healthcare_appointment_readstringNo
overriden_scopes.healthcare_appointment_writestringNo
overriden_scopes.healthcare_slot_readstringNo
overriden_scopes.healthcare_slot_writestringNo
overriden_scopes.healthcare_encounter_readstringNo
overriden_scopes.healthcare_encounter_writestringNo
overriden_scopes.healthcare_condition_readstringNo
overriden_scopes.healthcare_condition_writestringNo
overriden_scopes.healthcare_allergy_readstringNo
overriden_scopes.healthcare_allergy_writestringNo
overriden_scopes.healthcare_medication_readstringNo
overriden_scopes.healthcare_medication_writestringNo
overriden_scopes.healthcare_observation_readstringNo
overriden_scopes.healthcare_observation_writestringNo
overriden_scopes.healthcare_immunization_readstringNo
overriden_scopes.healthcare_immunization_writestringNo
overriden_scopes.healthcare_document_readstringNo
overriden_scopes.healthcare_document_writestringNo
overriden_scopes.healthcare_coverage_readstringNo
overriden_scopes.healthcare_coverage_writestringNo
overriden_scopes.healthcare_procedure_readstringNo
overriden_scopes.healthcare_procedure_writestringNo
overriden_scopes.healthcare_report_readstringNo
overriden_scopes.healthcare_report_writestringNo
overriden_scopes.healthcare_careplan_readstringNo
overriden_scopes.healthcare_careplan_writestringNo
overriden_scopes.healthcare_goal_readstringNo
overriden_scopes.healthcare_goal_writestringNo
overriden_scopes.property_listing_readstringNo
overriden_scopes.property_listing_writestringNo
overriden_scopes.property_unittype_readstringNo
overriden_scopes.property_guest_readstringNo
overriden_scopes.property_guest_writestringNo
overriden_scopes.property_reservation_readstringNo
overriden_scopes.property_reservation_writestringNo
overriden_scopes.property_availability_readstringNo
overriden_scopes.property_quote_readstringNo
overriden_scopes.property_quote_writestringNo
overriden_scopes.property_review_readstringNo
overriden_scopes.property_review_writestringNo
overriden_scopes.property_conversation_readstringNo
overriden_scopes.property_conversation_writestringNo
overriden_scopes.plm_part_readstringNo
overriden_scopes.plm_part_writestringNo
overriden_scopes.plm_bomline_readstringNo
overriden_scopes.plm_bomline_writestringNo
overriden_scopes.plm_document_readstringNo
overriden_scopes.plm_document_writestringNo
overriden_scopes.plm_change_readstringNo
overriden_scopes.plm_change_writestringNo
overriden_scopes.plm_category_readstringNo
overriden_scopes.plm_category_writestringNo
success_redirectstringNoPost-OAuth success URL for marketplace installs (e.g. HighLevel). Used by /oauth/code/{workspace}/{env}/{integration}.
failure_redirectstringNoPost-OAuth failure URL for marketplace installs. Used by /oauth/code/{workspace}/{env}/{integration}.
authobjectNo
auth.client_idstringNo
auth.client_secretstringNo
auth.consumer_keystringNo
auth.consumer_secretstringNo
auth.pemstringNothe PEM X.509 certificate in Base64 ASCII format
auth.keystringNothe private KEY X.509 certificate in Base64 ASCII format
auth.dev_api_keystringNo
auth.saml_idp_urlstringNothe SAML IdP SSO/login URL for end-user SAML login
auth.saml_idp_entity_idstringNothe SAML IdP issuer/entity ID
auth.saml_pemstringNothe SAML IdP signing certificate; PEM X.509 in Base64 ASCII format
auth.needs_pkcebooleanNoopt-in PKCE for OAuth2 when the integration app or org requires it
secretsmanager_idstringNothe ID of the SecretsManager object
secretsmanager_keystringNothe key/path/name of the secret within the vault

TypeScript

TypeScript
export type WorkspaceIntegration = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	workspace_id?: string; // (reference to KmsSpace)
	integration_type: string;
	is_active: boolean;
	api_url?: string;
	authorize_url?: string;
	token_url?: string;
	refresh_url?: string;
	base_url?: string;
	prompt_region?: boolean;
	use_unified_redirect?: boolean;
	auth_type?: 'oauth2' | 'other' | 'token'; // the authentication method to use for this workspace integration; when set, it overrides the default auth-method selection (e.g. force 'token' even when Unified OAUTH credentials exist)
	environment?: string; // authentication environment
	categories?: ( 'passthrough' | 'hris' | 'ats' | 'auth' | 'saml' | 'crm' | 'enrich' | 'martech' | 'ticketing' | 'uc' | 'accounting' | 'storage' | 'commerce' | 'payment' | 'genai' | 'messaging' | 'kms' | 'task' | 'scim' | 'lms' | 'repo' | 'metadata' | 'calendar' | 'verification' | 'ads' | 'analytics' | 'forms' | 'shipping' | 'assessment' | 'signing' | 'clubs' | 'datastore' | 'cdp' | 'performance' | 'social' | 'legal' | 'compute' | 'healthcare' | 'property' | 'plm' )[]; // derived from `permissions` (plus the auth, passthrough and saml categories, which have no permissions)
	permissions?: ( 'accounting_account_read' | 'accounting_account_write' | 'accounting_transaction_read' | 'accounting_transaction_write' | 'accounting_journal_read' | 'accounting_journal_write' | 'accounting_invoice_read' | 'accounting_invoice_write' | 'accounting_bill_read' | 'accounting_bill_write' | 'accounting_vendorcredit_read' | 'accounting_vendorcredit_write' | 'accounting_creditmemo_read' | 'accounting_creditmemo_write' | 'accounting_contact_read' | 'accounting_contact_write' | 'accounting_expense_read' | 'accounting_expense_write' | 'accounting_expensereport_read' | 'accounting_expensereport_write' | 'accounting_purchasereceipt_read' | 'accounting_purchasereceipt_write' | 'accounting_taxrate_read' | 'accounting_taxrate_write' | 'accounting_paymentterm_read' | 'accounting_paymentterm_write' | 'accounting_organization_read' | 'accounting_order_read' | 'accounting_order_write' | 'accounting_purchaseorder_read' | 'accounting_purchaseorder_write' | 'accounting_salesorder_read' | 'accounting_salesorder_write' | 'accounting_salesreceipt_read' | 'accounting_salesreceipt_write' | 'accounting_trialbalance_read' | 'accounting_trialbalance_write' | 'accounting_profitloss_read' | 'accounting_profitloss_write' | 'accounting_balancesheet_read' | 'accounting_balancesheet_write' | 'accounting_category_read' | 'accounting_category_write' | 'payment_payment_read' | 'payment_payment_write' | 'accounting_cashflow_read' | 'accounting_cashflow_write' | 'accounting_quote_read' | 'accounting_quote_write' | 'accounting_agedreceivable_read' | 'accounting_agedpayable_read' | 'accounting_project_read' | 'accounting_project_write' | 'accounting_bankfeedaccount_read' | 'accounting_bankfeedaccount_write' | 'accounting_bankfeedtransaction_read' | 'accounting_bankfeedtransaction_write' | 'payment_payout_read' | 'payment_refund_read' | 'payment_link_read' | 'payment_link_write' | 'payment_subscription_read' | 'payment_subscription_write' | 'commerce_item_read' | 'commerce_item_write' | 'commerce_collection_read' | 'commerce_collection_write' | 'commerce_inventory_read' | 'commerce_inventory_write' | 'commerce_location_read' | 'commerce_location_write' | 'commerce_review_read' | 'commerce_review_write' | 'commerce_saleschannel_read' | 'commerce_saleschannel_write' | 'commerce_itemvariant_read' | 'commerce_itemvariant_write' | 'commerce_reservation_read' | 'commerce_reservation_write' | 'commerce_table_read' | 'commerce_table_write' | 'commerce_return_read' | 'commerce_return_write' | 'commerce_availability_read' | 'commerce_availability_write' | 'verification_package_read' | 'verification_request_read' | 'verification_request_write' | 'assessment_package_read' | 'assessment_package_write' | 'assessment_order_write' | 'ats_activity_read' | 'ats_activity_write' | 'ats_application_read' | 'ats_application_write' | 'ats_applicationstatus_read' | 'ats_candidate_read' | 'ats_candidate_write' | 'ats_interview_read' | 'ats_interview_write' | 'ats_job_read' | 'ats_job_write' | 'ats_company_read' | 'ats_company_write' | 'ats_document_read' | 'ats_document_write' | 'ats_scorecard_read' | 'ats_scorecard_write' | 'crm_company_read' | 'crm_company_write' | 'crm_contact_read' | 'crm_contact_write' | 'crm_deal_read' | 'crm_deal_write' | 'crm_event_read' | 'crm_event_write' | 'crm_lead_read' | 'crm_lead_write' | 'crm_pipeline_read' | 'crm_pipeline_write' | 'crm_taxonomy_read' | 'martech_list_read' | 'martech_list_write' | 'martech_member_read' | 'martech_member_write' | 'martech_campaign_read' | 'martech_campaign_write' | 'martech_report_read' | 'martech_report_write' | 'ticketing_customer_read' | 'ticketing_customer_write' | 'ticketing_ticket_read' | 'ticketing_ticket_write' | 'ticketing_note_read' | 'ticketing_note_write' | 'ticketing_category_read' | 'ticketing_category_write' | 'hris_employee_read' | 'hris_employee_write' | 'hris_group_read' | 'hris_group_write' | 'hris_payslip_read' | 'hris_payslip_write' | 'hris_timeoff_read' | 'hris_timeoff_write' | 'hris_timeshift_read' | 'hris_timeshift_write' | 'hris_attendance_read' | 'hris_attendance_write' | 'hris_company_read' | 'hris_company_write' | 'hris_location_read' | 'hris_location_write' | 'hris_device_read' | 'hris_device_write' | 'hris_deduction_read' | 'hris_deduction_write' | 'hris_benefit_read' | 'hris_benefit_write' | 'hris_bankaccount_read' | 'hris_bankaccount_write' | 'hris_document_read' | 'hris_document_write' | 'hris_taxonomy_read' | 'hris_taxonomy_write' | 'hris_job_read' | 'hris_job_write' | 'hris_payroll_read' | 'hris_payroll_write' | 'hris_paycode_read' | 'hris_paycode_write' | 'hris_earning_read' | 'hris_earning_write' | 'uc_call_read' | 'uc_call_write' | 'uc_contact_read' | 'uc_contact_write' | 'uc_fax_read' | 'uc_fax_write' | 'uc_comment_read' | 'uc_comment_write' | 'uc_recording_read' | 'uc_scorecard_read' | 'uc_scorecardtemplate_read' | 'storage_file_read' | 'storage_file_write' | 'webhook' | 'genai_model_read' | 'genai_prompt_read' | 'genai_prompt_write' | 'genai_embedding_read' | 'genai_embedding_write' | 'genai_task_read' | 'genai_task_write' | 'genai_agent_read' | 'genai_agent_write' | 'genai_organization_read' | 'genai_organization_write' | 'genai_skill_read' | 'genai_skill_write' | 'genai_memory_read' | 'genai_memory_write' | 'messaging_message_read' | 'messaging_message_write' | 'messaging_channel_read' | 'messaging_channel_write' | 'messaging_event_read' | 'messaging_event_write' | 'kms_space_read' | 'kms_space_write' | 'kms_page_read' | 'kms_page_write' | 'kms_comment_read' | 'kms_comment_write' | 'task_project_read' | 'task_project_write' | 'task_task_read' | 'task_task_write' | 'task_change_read' | 'task_comment_read' | 'task_comment_write' | 'scim_users_read' | 'scim_users_write' | 'scim_groups_read' | 'scim_groups_write' | 'lms_course_read' | 'lms_course_write' | 'lms_class_read' | 'lms_class_write' | 'lms_student_read' | 'lms_student_write' | 'lms_instructor_read' | 'lms_instructor_write' | 'lms_content_read' | 'lms_content_write' | 'lms_collection_read' | 'lms_collection_write' | 'lms_activity_read' | 'lms_activity_write' | 'repo_organization_read' | 'repo_organization_write' | 'repo_repository_read' | 'repo_repository_write' | 'repo_branch_read' | 'repo_branch_write' | 'repo_commit_read' | 'repo_commit_write' | 'repo_pullrequest_read' | 'repo_pullrequest_write' | 'metadata_metadata_read' | 'metadata_metadata_write' | 'calendar_calendar_read' | 'calendar_calendar_write' | 'calendar_event_read' | 'calendar_event_write' | 'calendar_busy_read' | 'calendar_link_read' | 'calendar_link_write' | 'calendar_recording_read' | 'calendar_recording_write' | 'calendar_webinar_read' | 'calendar_webinar_write' | 'calendar_bot_read' | 'calendar_bot_write' | 'calendar_botevent_read' | 'calendar_room_read' | 'calendar_location_read' | 'enrich_person_read' | 'enrich_company_read' | 'ads_ad_read' | 'ads_ad_write' | 'ads_campaign_read' | 'ads_campaign_write' | 'ads_group_read' | 'ads_group_write' | 'ads_report_read' | 'ads_organization_read' | 'ads_organization_write' | 'ads_creative_read' | 'ads_creative_write' | 'ads_asset_read' | 'ads_asset_write' | 'ads_insertionorder_read' | 'ads_insertionorder_write' | 'ads_target_read' | 'ads_promoted_read' | 'analytics_property_read' | 'analytics_property_write' | 'analytics_event_read' | 'analytics_event_write' | 'analytics_session_read' | 'analytics_visitor_read' | 'analytics_visitor_write' | 'analytics_report_read' | 'forms_form_read' | 'forms_form_write' | 'forms_submission_read' | 'forms_submission_write' | 'shipping_shipment_read' | 'shipping_shipment_write' | 'shipping_label_read' | 'shipping_label_write' | 'shipping_tracking_read' | 'shipping_rate_read' | 'shipping_rate_write' | 'shipping_carrier_read' | 'signing_document_read' | 'signing_document_write' | 'signing_signatory_read' | 'signing_signatory_write' | 'signing_template_read' | 'signing_template_write' | 'clubs_group_read' | 'clubs_group_write' | 'clubs_member_read' | 'clubs_member_write' | 'clubs_activity_read' | 'clubs_activity_write' | 'clubs_location_read' | 'clubs_location_write' | 'clubs_event_read' | 'clubs_event_write' | 'datastore_database_read' | 'datastore_database_write' | 'datastore_table_read' | 'datastore_table_write' | 'datastore_record_read' | 'datastore_record_write' | 'datastore_query_read' | 'datastore_query_write' | 'cdp_profile_read' | 'cdp_profile_write' | 'cdp_segment_read' | 'cdp_segment_write' | 'cdp_event_read' | 'cdp_event_write' | 'cdp_source_read' | 'cdp_source_write' | 'cdp_destination_read' | 'cdp_destination_write' | 'cdp_activation_read' | 'cdp_activation_write' | 'performance_cycle_read' | 'performance_review_read' | 'performance_review_write' | 'performance_goal_read' | 'performance_goal_write' | 'performance_feedback_read' | 'performance_feedback_write' | 'social_post_read' | 'social_post_write' | 'social_profile_read' | 'social_profile_write' | 'social_review_read' | 'social_review_write' | 'social_insight_read' | 'social_insight_write' | 'legal_matter_read' | 'legal_matter_write' | 'legal_practicearea_read' | 'legal_practicearea_write' | 'legal_timeentry_read' | 'legal_timeentry_write' | 'legal_expense_read' | 'legal_expense_write' | 'compute_instance_read' | 'compute_instance_write' | 'compute_template_read' | 'compute_template_write' | 'compute_gputype_read' | 'compute_region_read' | 'compute_volume_read' | 'compute_volume_write' | 'compute_snapshot_read' | 'compute_snapshot_write' | 'compute_usage_read' | 'compute_key_read' | 'compute_key_write' | 'compute_service_read' | 'compute_service_write' | 'compute_deployment_read' | 'compute_deployment_write' | 'compute_domain_read' | 'compute_domain_write' | 'compute_envvar_read' | 'compute_envvar_write' | 'healthcare_patient_read' | 'healthcare_patient_write' | 'healthcare_practitioner_read' | 'healthcare_practitioner_write' | 'healthcare_location_read' | 'healthcare_location_write' | 'healthcare_appointment_read' | 'healthcare_appointment_write' | 'healthcare_slot_read' | 'healthcare_slot_write' | 'healthcare_encounter_read' | 'healthcare_encounter_write' | 'healthcare_condition_read' | 'healthcare_condition_write' | 'healthcare_allergy_read' | 'healthcare_allergy_write' | 'healthcare_medication_read' | 'healthcare_medication_write' | 'healthcare_observation_read' | 'healthcare_observation_write' | 'healthcare_immunization_read' | 'healthcare_immunization_write' | 'healthcare_document_read' | 'healthcare_document_write' | 'healthcare_coverage_read' | 'healthcare_coverage_write' | 'healthcare_procedure_read' | 'healthcare_procedure_write' | 'healthcare_report_read' | 'healthcare_report_write' | 'healthcare_careplan_read' | 'healthcare_careplan_write' | 'healthcare_goal_read' | 'healthcare_goal_write' | 'property_listing_read' | 'property_listing_write' | 'property_unittype_read' | 'property_guest_read' | 'property_guest_write' | 'property_reservation_read' | 'property_reservation_write' | 'property_availability_read' | 'property_quote_read' | 'property_quote_write' | 'property_review_read' | 'property_review_write' | 'property_conversation_read' | 'property_conversation_write' | 'plm_part_read' | 'plm_part_write' | 'plm_bomline_read' | 'plm_bomline_write' | 'plm_document_read' | 'plm_document_write' | 'plm_change_read' | 'plm_change_write' | 'plm_category_read' | 'plm_category_write' )[]; // the unified permission scopes enabled for this integration; requested when an authorization URL omits `scopes`
	overriden_scopes?: {
		accounting_account_read?: string; 
		accounting_account_write?: string; 
		accounting_transaction_read?: string; 
		accounting_transaction_write?: string; 
		accounting_journal_read?: string; 
		accounting_journal_write?: string; 
		accounting_invoice_read?: string; 
		accounting_invoice_write?: string; 
		accounting_bill_read?: string; 
		accounting_bill_write?: string; 
		accounting_vendorcredit_read?: string; 
		accounting_vendorcredit_write?: string; 
		accounting_creditmemo_read?: string; 
		accounting_creditmemo_write?: string; 
		accounting_contact_read?: string; 
		accounting_contact_write?: string; 
		accounting_expense_read?: string; 
		accounting_expense_write?: string; 
		accounting_expensereport_read?: string; 
		accounting_expensereport_write?: string; 
		accounting_purchasereceipt_read?: string; 
		accounting_purchasereceipt_write?: string; 
		accounting_taxrate_read?: string; 
		accounting_taxrate_write?: string; 
		accounting_paymentterm_read?: string; 
		accounting_paymentterm_write?: string; 
		accounting_organization_read?: string; 
		accounting_order_read?: string; 
		accounting_order_write?: string; 
		accounting_purchaseorder_read?: string; 
		accounting_purchaseorder_write?: string; 
		accounting_salesorder_read?: string; 
		accounting_salesorder_write?: string; 
		accounting_salesreceipt_read?: string; 
		accounting_salesreceipt_write?: string; 
		accounting_trialbalance_read?: string; 
		accounting_trialbalance_write?: string; 
		accounting_profitloss_read?: string; 
		accounting_profitloss_write?: string; 
		accounting_balancesheet_read?: string; 
		accounting_balancesheet_write?: string; 
		accounting_category_read?: string; 
		accounting_category_write?: string; 
		payment_payment_read?: string; 
		payment_payment_write?: string; 
		accounting_cashflow_read?: string; 
		accounting_cashflow_write?: string; 
		accounting_quote_read?: string; 
		accounting_quote_write?: string; 
		accounting_agedreceivable_read?: string; 
		accounting_agedpayable_read?: string; 
		accounting_project_read?: string; 
		accounting_project_write?: string; 
		accounting_bankfeedaccount_read?: string; 
		accounting_bankfeedaccount_write?: string; 
		accounting_bankfeedtransaction_read?: string; 
		accounting_bankfeedtransaction_write?: string; 
		payment_payout_read?: string; 
		payment_refund_read?: string; 
		payment_link_read?: string; 
		payment_link_write?: string; 
		payment_subscription_read?: string; 
		payment_subscription_write?: string; 
		commerce_item_read?: string; 
		commerce_item_write?: string; 
		commerce_collection_read?: string; 
		commerce_collection_write?: string; 
		commerce_inventory_read?: string; 
		commerce_inventory_write?: string; 
		commerce_location_read?: string; 
		commerce_location_write?: string; 
		commerce_review_read?: string; 
		commerce_review_write?: string; 
		commerce_saleschannel_read?: string; 
		commerce_saleschannel_write?: string; 
		commerce_itemvariant_read?: string; 
		commerce_itemvariant_write?: string; 
		commerce_reservation_read?: string; 
		commerce_reservation_write?: string; 
		commerce_table_read?: string; 
		commerce_table_write?: string; 
		commerce_return_read?: string; 
		commerce_return_write?: string; 
		commerce_availability_read?: string; 
		commerce_availability_write?: string; 
		verification_package_read?: string; 
		verification_request_read?: string; 
		verification_request_write?: string; 
		assessment_package_read?: string; 
		assessment_package_write?: string; 
		assessment_order_write?: string; 
		ats_activity_read?: string; 
		ats_activity_write?: string; 
		ats_application_read?: string; 
		ats_application_write?: string; 
		ats_applicationstatus_read?: string; 
		ats_candidate_read?: string; 
		ats_candidate_write?: string; 
		ats_interview_read?: string; 
		ats_interview_write?: string; 
		ats_job_read?: string; 
		ats_job_write?: string; 
		ats_company_read?: string; 
		ats_company_write?: string; 
		ats_document_read?: string; 
		ats_document_write?: string; 
		ats_scorecard_read?: string; 
		ats_scorecard_write?: string; 
		crm_company_read?: string; 
		crm_company_write?: string; 
		crm_contact_read?: string; 
		crm_contact_write?: string; 
		crm_deal_read?: string; 
		crm_deal_write?: string; 
		crm_event_read?: string; 
		crm_event_write?: string; 
		crm_lead_read?: string; 
		crm_lead_write?: string; 
		crm_pipeline_read?: string; 
		crm_pipeline_write?: string; 
		crm_taxonomy_read?: string; 
		martech_list_read?: string; 
		martech_list_write?: string; 
		martech_member_read?: string; 
		martech_member_write?: string; 
		martech_campaign_read?: string; 
		martech_campaign_write?: string; 
		martech_report_read?: string; 
		martech_report_write?: string; 
		ticketing_customer_read?: string; 
		ticketing_customer_write?: string; 
		ticketing_ticket_read?: string; 
		ticketing_ticket_write?: string; 
		ticketing_note_read?: string; 
		ticketing_note_write?: string; 
		ticketing_category_read?: string; 
		ticketing_category_write?: string; 
		hris_employee_read?: string; 
		hris_employee_write?: string; 
		hris_group_read?: string; 
		hris_group_write?: string; 
		hris_payslip_read?: string; 
		hris_payslip_write?: string; 
		hris_timeoff_read?: string; 
		hris_timeoff_write?: string; 
		hris_timeshift_read?: string; 
		hris_timeshift_write?: string; 
		hris_attendance_read?: string; 
		hris_attendance_write?: string; 
		hris_company_read?: string; 
		hris_company_write?: string; 
		hris_location_read?: string; 
		hris_location_write?: string; 
		hris_device_read?: string; 
		hris_device_write?: string; 
		hris_deduction_read?: string; 
		hris_deduction_write?: string; 
		hris_benefit_read?: string; 
		hris_benefit_write?: string; 
		hris_bankaccount_read?: string; 
		hris_bankaccount_write?: string; 
		hris_document_read?: string; 
		hris_document_write?: string; 
		hris_taxonomy_read?: string; 
		hris_taxonomy_write?: string; 
		hris_job_read?: string; 
		hris_job_write?: string; 
		hris_payroll_read?: string; 
		hris_payroll_write?: string; 
		hris_paycode_read?: string; 
		hris_paycode_write?: string; 
		hris_earning_read?: string; 
		hris_earning_write?: string; 
		uc_call_read?: string; 
		uc_call_write?: string; 
		uc_contact_read?: string; 
		uc_contact_write?: string; 
		uc_fax_read?: string; 
		uc_fax_write?: string; 
		uc_comment_read?: string; 
		uc_comment_write?: string; 
		uc_recording_read?: string; 
		uc_scorecard_read?: string; 
		uc_scorecardtemplate_read?: string; 
		storage_file_read?: string; 
		storage_file_write?: string; 
		webhook?: string; 
		genai_model_read?: string; 
		genai_prompt_read?: string; 
		genai_prompt_write?: string; 
		genai_embedding_read?: string; 
		genai_embedding_write?: string; 
		genai_task_read?: string; 
		genai_task_write?: string; 
		genai_agent_read?: string; 
		genai_agent_write?: string; 
		genai_organization_read?: string; 
		genai_organization_write?: string; 
		genai_skill_read?: string; 
		genai_skill_write?: string; 
		genai_memory_read?: string; 
		genai_memory_write?: string; 
		messaging_message_read?: string; 
		messaging_message_write?: string; 
		messaging_channel_read?: string; 
		messaging_channel_write?: string; 
		messaging_event_read?: string; 
		messaging_event_write?: string; 
		kms_space_read?: string; 
		kms_space_write?: string; 
		kms_page_read?: string; 
		kms_page_write?: string; 
		kms_comment_read?: string; 
		kms_comment_write?: string; 
		task_project_read?: string; 
		task_project_write?: string; 
		task_task_read?: string; 
		task_task_write?: string; 
		task_change_read?: string; 
		task_comment_read?: string; 
		task_comment_write?: string; 
		scim_users_read?: string; 
		scim_users_write?: string; 
		scim_groups_read?: string; 
		scim_groups_write?: string; 
		lms_course_read?: string; 
		lms_course_write?: string; 
		lms_class_read?: string; 
		lms_class_write?: string; 
		lms_student_read?: string; 
		lms_student_write?: string; 
		lms_instructor_read?: string; 
		lms_instructor_write?: string; 
		lms_content_read?: string; 
		lms_content_write?: string; 
		lms_collection_read?: string; 
		lms_collection_write?: string; 
		lms_activity_read?: string; 
		lms_activity_write?: string; 
		repo_organization_read?: string; 
		repo_organization_write?: string; 
		repo_repository_read?: string; 
		repo_repository_write?: string; 
		repo_branch_read?: string; 
		repo_branch_write?: string; 
		repo_commit_read?: string; 
		repo_commit_write?: string; 
		repo_pullrequest_read?: string; 
		repo_pullrequest_write?: string; 
		metadata_metadata_read?: string; 
		metadata_metadata_write?: string; 
		calendar_calendar_read?: string; 
		calendar_calendar_write?: string; 
		calendar_event_read?: string; 
		calendar_event_write?: string; 
		calendar_busy_read?: string; 
		calendar_link_read?: string; 
		calendar_link_write?: string; 
		calendar_recording_read?: string; 
		calendar_recording_write?: string; 
		calendar_webinar_read?: string; 
		calendar_webinar_write?: string; 
		calendar_bot_read?: string; 
		calendar_bot_write?: string; 
		calendar_botevent_read?: string; 
		calendar_room_read?: string; 
		calendar_location_read?: string; 
		enrich_person_read?: string; 
		enrich_company_read?: string; 
		ads_ad_read?: string; 
		ads_ad_write?: string; 
		ads_campaign_read?: string; 
		ads_campaign_write?: string; 
		ads_group_read?: string; 
		ads_group_write?: string; 
		ads_report_read?: string; 
		ads_organization_read?: string; 
		ads_organization_write?: string; 
		ads_creative_read?: string; 
		ads_creative_write?: string; 
		ads_asset_read?: string; 
		ads_asset_write?: string; 
		ads_insertionorder_read?: string; 
		ads_insertionorder_write?: string; 
		ads_target_read?: string; 
		ads_promoted_read?: string; 
		analytics_property_read?: string; 
		analytics_property_write?: string; 
		analytics_event_read?: string; 
		analytics_event_write?: string; 
		analytics_session_read?: string; 
		analytics_visitor_read?: string; 
		analytics_visitor_write?: string; 
		analytics_report_read?: string; 
		forms_form_read?: string; 
		forms_form_write?: string; 
		forms_submission_read?: string; 
		forms_submission_write?: string; 
		shipping_shipment_read?: string; 
		shipping_shipment_write?: string; 
		shipping_label_read?: string; 
		shipping_label_write?: string; 
		shipping_tracking_read?: string; 
		shipping_rate_read?: string; 
		shipping_rate_write?: string; 
		shipping_carrier_read?: string; 
		signing_document_read?: string; 
		signing_document_write?: string; 
		signing_signatory_read?: string; 
		signing_signatory_write?: string; 
		signing_template_read?: string; 
		signing_template_write?: string; 
		clubs_group_read?: string; 
		clubs_group_write?: string; 
		clubs_member_read?: string; 
		clubs_member_write?: string; 
		clubs_activity_read?: string; 
		clubs_activity_write?: string; 
		clubs_location_read?: string; 
		clubs_location_write?: string; 
		clubs_event_read?: string; 
		clubs_event_write?: string; 
		datastore_database_read?: string; 
		datastore_database_write?: string; 
		datastore_table_read?: string; 
		datastore_table_write?: string; 
		datastore_record_read?: string; 
		datastore_record_write?: string; 
		datastore_query_read?: string; 
		datastore_query_write?: string; 
		cdp_profile_read?: string; 
		cdp_profile_write?: string; 
		cdp_segment_read?: string; 
		cdp_segment_write?: string; 
		cdp_event_read?: string; 
		cdp_event_write?: string; 
		cdp_source_read?: string; 
		cdp_source_write?: string; 
		cdp_destination_read?: string; 
		cdp_destination_write?: string; 
		cdp_activation_read?: string; 
		cdp_activation_write?: string; 
		performance_cycle_read?: string; 
		performance_review_read?: string; 
		performance_review_write?: string; 
		performance_goal_read?: string; 
		performance_goal_write?: string; 
		performance_feedback_read?: string; 
		performance_feedback_write?: string; 
		social_post_read?: string; 
		social_post_write?: string; 
		social_profile_read?: string; 
		social_profile_write?: string; 
		social_review_read?: string; 
		social_review_write?: string; 
		social_insight_read?: string; 
		social_insight_write?: string; 
		legal_matter_read?: string; 
		legal_matter_write?: string; 
		legal_practicearea_read?: string; 
		legal_practicearea_write?: string; 
		legal_timeentry_read?: string; 
		legal_timeentry_write?: string; 
		legal_expense_read?: string; 
		legal_expense_write?: string; 
		compute_instance_read?: string; 
		compute_instance_write?: string; 
		compute_template_read?: string; 
		compute_template_write?: string; 
		compute_gputype_read?: string; 
		compute_region_read?: string; 
		compute_volume_read?: string; 
		compute_volume_write?: string; 
		compute_snapshot_read?: string; 
		compute_snapshot_write?: string; 
		compute_usage_read?: string; 
		compute_key_read?: string; 
		compute_key_write?: string; 
		compute_service_read?: string; 
		compute_service_write?: string; 
		compute_deployment_read?: string; 
		compute_deployment_write?: string; 
		compute_domain_read?: string; 
		compute_domain_write?: string; 
		compute_envvar_read?: string; 
		compute_envvar_write?: string; 
		healthcare_patient_read?: string; 
		healthcare_patient_write?: string; 
		healthcare_practitioner_read?: string; 
		healthcare_practitioner_write?: string; 
		healthcare_location_read?: string; 
		healthcare_location_write?: string; 
		healthcare_appointment_read?: string; 
		healthcare_appointment_write?: string; 
		healthcare_slot_read?: string; 
		healthcare_slot_write?: string; 
		healthcare_encounter_read?: string; 
		healthcare_encounter_write?: string; 
		healthcare_condition_read?: string; 
		healthcare_condition_write?: string; 
		healthcare_allergy_read?: string; 
		healthcare_allergy_write?: string; 
		healthcare_medication_read?: string; 
		healthcare_medication_write?: string; 
		healthcare_observation_read?: string; 
		healthcare_observation_write?: string; 
		healthcare_immunization_read?: string; 
		healthcare_immunization_write?: string; 
		healthcare_document_read?: string; 
		healthcare_document_write?: string; 
		healthcare_coverage_read?: string; 
		healthcare_coverage_write?: string; 
		healthcare_procedure_read?: string; 
		healthcare_procedure_write?: string; 
		healthcare_report_read?: string; 
		healthcare_report_write?: string; 
		healthcare_careplan_read?: string; 
		healthcare_careplan_write?: string; 
		healthcare_goal_read?: string; 
		healthcare_goal_write?: string; 
		property_listing_read?: string; 
		property_listing_write?: string; 
		property_unittype_read?: string; 
		property_guest_read?: string; 
		property_guest_write?: string; 
		property_reservation_read?: string; 
		property_reservation_write?: string; 
		property_availability_read?: string; 
		property_quote_read?: string; 
		property_quote_write?: string; 
		property_review_read?: string; 
		property_review_write?: string; 
		property_conversation_read?: string; 
		property_conversation_write?: string; 
		plm_part_read?: string; 
		plm_part_write?: string; 
		plm_bomline_read?: string; 
		plm_bomline_write?: string; 
		plm_document_read?: string; 
		plm_document_write?: string; 
		plm_change_read?: string; 
		plm_change_write?: string; 
		plm_category_read?: string; 
		plm_category_write?: string; 
	};
	success_redirect?: string; // Post-OAuth success URL for marketplace installs (e.g. HighLevel). Used by `/oauth/code/{workspace}/{env}/{integration}`.
	failure_redirect?: string; // Post-OAuth failure URL for marketplace installs. Used by `/oauth/code/{workspace}/{env}/{integration}`.
	auth?: {
		client_id?: string; 
		client_secret?: string; 
		consumer_key?: string; 
		consumer_secret?: string; 
		pem?: string; // the PEM X.509 certificate in Base64 ASCII format 
		key?: string; // the private KEY X.509 certificate in Base64 ASCII format 
		dev_api_key?: string; 
		saml_idp_url?: string; // the SAML IdP SSO/login URL for end-user SAML login 
		saml_idp_entity_id?: string; // the SAML IdP issuer/entity ID 
		saml_pem?: string; // the SAML IdP signing certificate; PEM X.509 in Base64 ASCII format 
		needs_pkce?: boolean; // opt-in PKCE for OAuth2 when the integration app or org requires it 
	};
	secretsmanager_id?: string; // the ID of the SecretsManager object
	secretsmanager_key?: string; // the key/path/name of the secret within the vault
} 

Zod

Zod
import { z } from 'zod';

export const ZodWorkspaceIntegration = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	workspace_id: z.string().optional().describe("(reference to KmsSpace)"),
	integration_type: z.string(),
	is_active: z.boolean(),
	api_url: z.string().optional(),
	authorize_url: z.string().optional(),
	token_url: z.string().optional(),
	refresh_url: z.string().optional(),
	base_url: z.string().optional(),
	prompt_region: z.boolean().optional(),
	use_unified_redirect: z.boolean().optional(),
	auth_type: z.enum("oauth2", "other", "token").optional().describe("the authentication method to use for this workspace integration; when set, it overrides the default auth-method selection (e.g. force 'token' even when Unified OAUTH credentials exist)"),
	environment: z.string().optional().describe("authentication environment"),
	categories: z( 'passthrough' | 'hris' | 'ats' | 'auth' | 'saml' | 'crm' | 'enrich' | 'martech' | 'ticketing' | 'uc' | 'accounting' | 'storage' | 'commerce' | 'payment' | 'genai' | 'messaging' | 'kms' | 'task' | 'scim' | 'lms' | 'repo' | 'metadata' | 'calendar' | 'verification' | 'ads' | 'analytics' | 'forms' | 'shipping' | 'assessment' | 'signing' | 'clubs' | 'datastore' | 'cdp' | 'performance' | 'social' | 'legal' | 'compute' | 'healthcare' | 'property' | 'plm' ).optional().describe("derived from `permissions` (plus the auth, passthrough and saml categories, which have no permissions)"),
	permissions: z( 'accounting_account_read' | 'accounting_account_write' | 'accounting_transaction_read' | 'accounting_transaction_write' | 'accounting_journal_read' | 'accounting_journal_write' | 'accounting_invoice_read' | 'accounting_invoice_write' | 'accounting_bill_read' | 'accounting_bill_write' | 'accounting_vendorcredit_read' | 'accounting_vendorcredit_write' | 'accounting_creditmemo_read' | 'accounting_creditmemo_write' | 'accounting_contact_read' | 'accounting_contact_write' | 'accounting_expense_read' | 'accounting_expense_write' | 'accounting_expensereport_read' | 'accounting_expensereport_write' | 'accounting_purchasereceipt_read' | 'accounting_purchasereceipt_write' | 'accounting_taxrate_read' | 'accounting_taxrate_write' | 'accounting_paymentterm_read' | 'accounting_paymentterm_write' | 'accounting_organization_read' | 'accounting_order_read' | 'accounting_order_write' | 'accounting_purchaseorder_read' | 'accounting_purchaseorder_write' | 'accounting_salesorder_read' | 'accounting_salesorder_write' | 'accounting_salesreceipt_read' | 'accounting_salesreceipt_write' | 'accounting_trialbalance_read' | 'accounting_trialbalance_write' | 'accounting_profitloss_read' | 'accounting_profitloss_write' | 'accounting_balancesheet_read' | 'accounting_balancesheet_write' | 'accounting_category_read' | 'accounting_category_write' | 'payment_payment_read' | 'payment_payment_write' | 'accounting_cashflow_read' | 'accounting_cashflow_write' | 'accounting_quote_read' | 'accounting_quote_write' | 'accounting_agedreceivable_read' | 'accounting_agedpayable_read' | 'accounting_project_read' | 'accounting_project_write' | 'accounting_bankfeedaccount_read' | 'accounting_bankfeedaccount_write' | 'accounting_bankfeedtransaction_read' | 'accounting_bankfeedtransaction_write' | 'payment_payout_read' | 'payment_refund_read' | 'payment_link_read' | 'payment_link_write' | 'payment_subscription_read' | 'payment_subscription_write' | 'commerce_item_read' | 'commerce_item_write' | 'commerce_collection_read' | 'commerce_collection_write' | 'commerce_inventory_read' | 'commerce_inventory_write' | 'commerce_location_read' | 'commerce_location_write' | 'commerce_review_read' | 'commerce_review_write' | 'commerce_saleschannel_read' | 'commerce_saleschannel_write' | 'commerce_itemvariant_read' | 'commerce_itemvariant_write' | 'commerce_reservation_read' | 'commerce_reservation_write' | 'commerce_table_read' | 'commerce_table_write' | 'commerce_return_read' | 'commerce_return_write' | 'commerce_availability_read' | 'commerce_availability_write' | 'verification_package_read' | 'verification_request_read' | 'verification_request_write' | 'assessment_package_read' | 'assessment_package_write' | 'assessment_order_write' | 'ats_activity_read' | 'ats_activity_write' | 'ats_application_read' | 'ats_application_write' | 'ats_applicationstatus_read' | 'ats_candidate_read' | 'ats_candidate_write' | 'ats_interview_read' | 'ats_interview_write' | 'ats_job_read' | 'ats_job_write' | 'ats_company_read' | 'ats_company_write' | 'ats_document_read' | 'ats_document_write' | 'ats_scorecard_read' | 'ats_scorecard_write' | 'crm_company_read' | 'crm_company_write' | 'crm_contact_read' | 'crm_contact_write' | 'crm_deal_read' | 'crm_deal_write' | 'crm_event_read' | 'crm_event_write' | 'crm_lead_read' | 'crm_lead_write' | 'crm_pipeline_read' | 'crm_pipeline_write' | 'crm_taxonomy_read' | 'martech_list_read' | 'martech_list_write' | 'martech_member_read' | 'martech_member_write' | 'martech_campaign_read' | 'martech_campaign_write' | 'martech_report_read' | 'martech_report_write' | 'ticketing_customer_read' | 'ticketing_customer_write' | 'ticketing_ticket_read' | 'ticketing_ticket_write' | 'ticketing_note_read' | 'ticketing_note_write' | 'ticketing_category_read' | 'ticketing_category_write' | 'hris_employee_read' | 'hris_employee_write' | 'hris_group_read' | 'hris_group_write' | 'hris_payslip_read' | 'hris_payslip_write' | 'hris_timeoff_read' | 'hris_timeoff_write' | 'hris_timeshift_read' | 'hris_timeshift_write' | 'hris_attendance_read' | 'hris_attendance_write' | 'hris_company_read' | 'hris_company_write' | 'hris_location_read' | 'hris_location_write' | 'hris_device_read' | 'hris_device_write' | 'hris_deduction_read' | 'hris_deduction_write' | 'hris_benefit_read' | 'hris_benefit_write' | 'hris_bankaccount_read' | 'hris_bankaccount_write' | 'hris_document_read' | 'hris_document_write' | 'hris_taxonomy_read' | 'hris_taxonomy_write' | 'hris_job_read' | 'hris_job_write' | 'hris_payroll_read' | 'hris_payroll_write' | 'hris_paycode_read' | 'hris_paycode_write' | 'hris_earning_read' | 'hris_earning_write' | 'uc_call_read' | 'uc_call_write' | 'uc_contact_read' | 'uc_contact_write' | 'uc_fax_read' | 'uc_fax_write' | 'uc_comment_read' | 'uc_comment_write' | 'uc_recording_read' | 'uc_scorecard_read' | 'uc_scorecardtemplate_read' | 'storage_file_read' | 'storage_file_write' | 'webhook' | 'genai_model_read' | 'genai_prompt_read' | 'genai_prompt_write' | 'genai_embedding_read' | 'genai_embedding_write' | 'genai_task_read' | 'genai_task_write' | 'genai_agent_read' | 'genai_agent_write' | 'genai_organization_read' | 'genai_organization_write' | 'genai_skill_read' | 'genai_skill_write' | 'genai_memory_read' | 'genai_memory_write' | 'messaging_message_read' | 'messaging_message_write' | 'messaging_channel_read' | 'messaging_channel_write' | 'messaging_event_read' | 'messaging_event_write' | 'kms_space_read' | 'kms_space_write' | 'kms_page_read' | 'kms_page_write' | 'kms_comment_read' | 'kms_comment_write' | 'task_project_read' | 'task_project_write' | 'task_task_read' | 'task_task_write' | 'task_change_read' | 'task_comment_read' | 'task_comment_write' | 'scim_users_read' | 'scim_users_write' | 'scim_groups_read' | 'scim_groups_write' | 'lms_course_read' | 'lms_course_write' | 'lms_class_read' | 'lms_class_write' | 'lms_student_read' | 'lms_student_write' | 'lms_instructor_read' | 'lms_instructor_write' | 'lms_content_read' | 'lms_content_write' | 'lms_collection_read' | 'lms_collection_write' | 'lms_activity_read' | 'lms_activity_write' | 'repo_organization_read' | 'repo_organization_write' | 'repo_repository_read' | 'repo_repository_write' | 'repo_branch_read' | 'repo_branch_write' | 'repo_commit_read' | 'repo_commit_write' | 'repo_pullrequest_read' | 'repo_pullrequest_write' | 'metadata_metadata_read' | 'metadata_metadata_write' | 'calendar_calendar_read' | 'calendar_calendar_write' | 'calendar_event_read' | 'calendar_event_write' | 'calendar_busy_read' | 'calendar_link_read' | 'calendar_link_write' | 'calendar_recording_read' | 'calendar_recording_write' | 'calendar_webinar_read' | 'calendar_webinar_write' | 'calendar_bot_read' | 'calendar_bot_write' | 'calendar_botevent_read' | 'calendar_room_read' | 'calendar_location_read' | 'enrich_person_read' | 'enrich_company_read' | 'ads_ad_read' | 'ads_ad_write' | 'ads_campaign_read' | 'ads_campaign_write' | 'ads_group_read' | 'ads_group_write' | 'ads_report_read' | 'ads_organization_read' | 'ads_organization_write' | 'ads_creative_read' | 'ads_creative_write' | 'ads_asset_read' | 'ads_asset_write' | 'ads_insertionorder_read' | 'ads_insertionorder_write' | 'ads_target_read' | 'ads_promoted_read' | 'analytics_property_read' | 'analytics_property_write' | 'analytics_event_read' | 'analytics_event_write' | 'analytics_session_read' | 'analytics_visitor_read' | 'analytics_visitor_write' | 'analytics_report_read' | 'forms_form_read' | 'forms_form_write' | 'forms_submission_read' | 'forms_submission_write' | 'shipping_shipment_read' | 'shipping_shipment_write' | 'shipping_label_read' | 'shipping_label_write' | 'shipping_tracking_read' | 'shipping_rate_read' | 'shipping_rate_write' | 'shipping_carrier_read' | 'signing_document_read' | 'signing_document_write' | 'signing_signatory_read' | 'signing_signatory_write' | 'signing_template_read' | 'signing_template_write' | 'clubs_group_read' | 'clubs_group_write' | 'clubs_member_read' | 'clubs_member_write' | 'clubs_activity_read' | 'clubs_activity_write' | 'clubs_location_read' | 'clubs_location_write' | 'clubs_event_read' | 'clubs_event_write' | 'datastore_database_read' | 'datastore_database_write' | 'datastore_table_read' | 'datastore_table_write' | 'datastore_record_read' | 'datastore_record_write' | 'datastore_query_read' | 'datastore_query_write' | 'cdp_profile_read' | 'cdp_profile_write' | 'cdp_segment_read' | 'cdp_segment_write' | 'cdp_event_read' | 'cdp_event_write' | 'cdp_source_read' | 'cdp_source_write' | 'cdp_destination_read' | 'cdp_destination_write' | 'cdp_activation_read' | 'cdp_activation_write' | 'performance_cycle_read' | 'performance_review_read' | 'performance_review_write' | 'performance_goal_read' | 'performance_goal_write' | 'performance_feedback_read' | 'performance_feedback_write' | 'social_post_read' | 'social_post_write' | 'social_profile_read' | 'social_profile_write' | 'social_review_read' | 'social_review_write' | 'social_insight_read' | 'social_insight_write' | 'legal_matter_read' | 'legal_matter_write' | 'legal_practicearea_read' | 'legal_practicearea_write' | 'legal_timeentry_read' | 'legal_timeentry_write' | 'legal_expense_read' | 'legal_expense_write' | 'compute_instance_read' | 'compute_instance_write' | 'compute_template_read' | 'compute_template_write' | 'compute_gputype_read' | 'compute_region_read' | 'compute_volume_read' | 'compute_volume_write' | 'compute_snapshot_read' | 'compute_snapshot_write' | 'compute_usage_read' | 'compute_key_read' | 'compute_key_write' | 'compute_service_read' | 'compute_service_write' | 'compute_deployment_read' | 'compute_deployment_write' | 'compute_domain_read' | 'compute_domain_write' | 'compute_envvar_read' | 'compute_envvar_write' | 'healthcare_patient_read' | 'healthcare_patient_write' | 'healthcare_practitioner_read' | 'healthcare_practitioner_write' | 'healthcare_location_read' | 'healthcare_location_write' | 'healthcare_appointment_read' | 'healthcare_appointment_write' | 'healthcare_slot_read' | 'healthcare_slot_write' | 'healthcare_encounter_read' | 'healthcare_encounter_write' | 'healthcare_condition_read' | 'healthcare_condition_write' | 'healthcare_allergy_read' | 'healthcare_allergy_write' | 'healthcare_medication_read' | 'healthcare_medication_write' | 'healthcare_observation_read' | 'healthcare_observation_write' | 'healthcare_immunization_read' | 'healthcare_immunization_write' | 'healthcare_document_read' | 'healthcare_document_write' | 'healthcare_coverage_read' | 'healthcare_coverage_write' | 'healthcare_procedure_read' | 'healthcare_procedure_write' | 'healthcare_report_read' | 'healthcare_report_write' | 'healthcare_careplan_read' | 'healthcare_careplan_write' | 'healthcare_goal_read' | 'healthcare_goal_write' | 'property_listing_read' | 'property_listing_write' | 'property_unittype_read' | 'property_guest_read' | 'property_guest_write' | 'property_reservation_read' | 'property_reservation_write' | 'property_availability_read' | 'property_quote_read' | 'property_quote_write' | 'property_review_read' | 'property_review_write' | 'property_conversation_read' | 'property_conversation_write' | 'plm_part_read' | 'plm_part_write' | 'plm_bomline_read' | 'plm_bomline_write' | 'plm_document_read' | 'plm_document_write' | 'plm_change_read' | 'plm_change_write' | 'plm_category_read' | 'plm_category_write' ).optional().describe("the unified permission scopes enabled for this integration; requested when an authorization URL omits `scopes`"),
	overriden_scopes: z.object({
			accounting_account_read: z.string().optional(),
			accounting_account_write: z.string().optional(),
			accounting_transaction_read: z.string().optional(),
			accounting_transaction_write: z.string().optional(),
			accounting_journal_read: z.string().optional(),
			accounting_journal_write: z.string().optional(),
			accounting_invoice_read: z.string().optional(),
			accounting_invoice_write: z.string().optional(),
			accounting_bill_read: z.string().optional(),
			accounting_bill_write: z.string().optional(),
			accounting_vendorcredit_read: z.string().optional(),
			accounting_vendorcredit_write: z.string().optional(),
			accounting_creditmemo_read: z.string().optional(),
			accounting_creditmemo_write: z.string().optional(),
			accounting_contact_read: z.string().optional(),
			accounting_contact_write: z.string().optional(),
			accounting_expense_read: z.string().optional(),
			accounting_expense_write: z.string().optional(),
			accounting_expensereport_read: z.string().optional(),
			accounting_expensereport_write: z.string().optional(),
			accounting_purchasereceipt_read: z.string().optional(),
			accounting_purchasereceipt_write: z.string().optional(),
			accounting_taxrate_read: z.string().optional(),
			accounting_taxrate_write: z.string().optional(),
			accounting_paymentterm_read: z.string().optional(),
			accounting_paymentterm_write: z.string().optional(),
			accounting_organization_read: z.string().optional(),
			accounting_order_read: z.string().optional(),
			accounting_order_write: z.string().optional(),
			accounting_purchaseorder_read: z.string().optional(),
			accounting_purchaseorder_write: z.string().optional(),
			accounting_salesorder_read: z.string().optional(),
			accounting_salesorder_write: z.string().optional(),
			accounting_salesreceipt_read: z.string().optional(),
			accounting_salesreceipt_write: z.string().optional(),
			accounting_trialbalance_read: z.string().optional(),
			accounting_trialbalance_write: z.string().optional(),
			accounting_profitloss_read: z.string().optional(),
			accounting_profitloss_write: z.string().optional(),
			accounting_balancesheet_read: z.string().optional(),
			accounting_balancesheet_write: z.string().optional(),
			accounting_category_read: z.string().optional(),
			accounting_category_write: z.string().optional(),
			payment_payment_read: z.string().optional(),
			payment_payment_write: z.string().optional(),
			accounting_cashflow_read: z.string().optional(),
			accounting_cashflow_write: z.string().optional(),
			accounting_quote_read: z.string().optional(),
			accounting_quote_write: z.string().optional(),
			accounting_agedreceivable_read: z.string().optional(),
			accounting_agedpayable_read: z.string().optional(),
			accounting_project_read: z.string().optional(),
			accounting_project_write: z.string().optional(),
			accounting_bankfeedaccount_read: z.string().optional(),
			accounting_bankfeedaccount_write: z.string().optional(),
			accounting_bankfeedtransaction_read: z.string().optional(),
			accounting_bankfeedtransaction_write: z.string().optional(),
			payment_payout_read: z.string().optional(),
			payment_refund_read: z.string().optional(),
			payment_link_read: z.string().optional(),
			payment_link_write: z.string().optional(),
			payment_subscription_read: z.string().optional(),
			payment_subscription_write: z.string().optional(),
			commerce_item_read: z.string().optional(),
			commerce_item_write: z.string().optional(),
			commerce_collection_read: z.string().optional(),
			commerce_collection_write: z.string().optional(),
			commerce_inventory_read: z.string().optional(),
			commerce_inventory_write: z.string().optional(),
			commerce_location_read: z.string().optional(),
			commerce_location_write: z.string().optional(),
			commerce_review_read: z.string().optional(),
			commerce_review_write: z.string().optional(),
			commerce_saleschannel_read: z.string().optional(),
			commerce_saleschannel_write: z.string().optional(),
			commerce_itemvariant_read: z.string().optional(),
			commerce_itemvariant_write: z.string().optional(),
			commerce_reservation_read: z.string().optional(),
			commerce_reservation_write: z.string().optional(),
			commerce_table_read: z.string().optional(),
			commerce_table_write: z.string().optional(),
			commerce_return_read: z.string().optional(),
			commerce_return_write: z.string().optional(),
			commerce_availability_read: z.string().optional(),
			commerce_availability_write: z.string().optional(),
			verification_package_read: z.string().optional(),
			verification_request_read: z.string().optional(),
			verification_request_write: z.string().optional(),
			assessment_package_read: z.string().optional(),
			assessment_package_write: z.string().optional(),
			assessment_order_write: z.string().optional(),
			ats_activity_read: z.string().optional(),
			ats_activity_write: z.string().optional(),
			ats_application_read: z.string().optional(),
			ats_application_write: z.string().optional(),
			ats_applicationstatus_read: z.string().optional(),
			ats_candidate_read: z.string().optional(),
			ats_candidate_write: z.string().optional(),
			ats_interview_read: z.string().optional(),
			ats_interview_write: z.string().optional(),
			ats_job_read: z.string().optional(),
			ats_job_write: z.string().optional(),
			ats_company_read: z.string().optional(),
			ats_company_write: z.string().optional(),
			ats_document_read: z.string().optional(),
			ats_document_write: z.string().optional(),
			ats_scorecard_read: z.string().optional(),
			ats_scorecard_write: z.string().optional(),
			crm_company_read: z.string().optional(),
			crm_company_write: z.string().optional(),
			crm_contact_read: z.string().optional(),
			crm_contact_write: z.string().optional(),
			crm_deal_read: z.string().optional(),
			crm_deal_write: z.string().optional(),
			crm_event_read: z.string().optional(),
			crm_event_write: z.string().optional(),
			crm_lead_read: z.string().optional(),
			crm_lead_write: z.string().optional(),
			crm_pipeline_read: z.string().optional(),
			crm_pipeline_write: z.string().optional(),
			crm_taxonomy_read: z.string().optional(),
			martech_list_read: z.string().optional(),
			martech_list_write: z.string().optional(),
			martech_member_read: z.string().optional(),
			martech_member_write: z.string().optional(),
			martech_campaign_read: z.string().optional(),
			martech_campaign_write: z.string().optional(),
			martech_report_read: z.string().optional(),
			martech_report_write: z.string().optional(),
			ticketing_customer_read: z.string().optional(),
			ticketing_customer_write: z.string().optional(),
			ticketing_ticket_read: z.string().optional(),
			ticketing_ticket_write: z.string().optional(),
			ticketing_note_read: z.string().optional(),
			ticketing_note_write: z.string().optional(),
			ticketing_category_read: z.string().optional(),
			ticketing_category_write: z.string().optional(),
			hris_employee_read: z.string().optional(),
			hris_employee_write: z.string().optional(),
			hris_group_read: z.string().optional(),
			hris_group_write: z.string().optional(),
			hris_payslip_read: z.string().optional(),
			hris_payslip_write: z.string().optional(),
			hris_timeoff_read: z.string().optional(),
			hris_timeoff_write: z.string().optional(),
			hris_timeshift_read: z.string().optional(),
			hris_timeshift_write: z.string().optional(),
			hris_attendance_read: z.string().optional(),
			hris_attendance_write: z.string().optional(),
			hris_company_read: z.string().optional(),
			hris_company_write: z.string().optional(),
			hris_location_read: z.string().optional(),
			hris_location_write: z.string().optional(),
			hris_device_read: z.string().optional(),
			hris_device_write: z.string().optional(),
			hris_deduction_read: z.string().optional(),
			hris_deduction_write: z.string().optional(),
			hris_benefit_read: z.string().optional(),
			hris_benefit_write: z.string().optional(),
			hris_bankaccount_read: z.string().optional(),
			hris_bankaccount_write: z.string().optional(),
			hris_document_read: z.string().optional(),
			hris_document_write: z.string().optional(),
			hris_taxonomy_read: z.string().optional(),
			hris_taxonomy_write: z.string().optional(),
			hris_job_read: z.string().optional(),
			hris_job_write: z.string().optional(),
			hris_payroll_read: z.string().optional(),
			hris_payroll_write: z.string().optional(),
			hris_paycode_read: z.string().optional(),
			hris_paycode_write: z.string().optional(),
			hris_earning_read: z.string().optional(),
			hris_earning_write: z.string().optional(),
			uc_call_read: z.string().optional(),
			uc_call_write: z.string().optional(),
			uc_contact_read: z.string().optional(),
			uc_contact_write: z.string().optional(),
			uc_fax_read: z.string().optional(),
			uc_fax_write: z.string().optional(),
			uc_comment_read: z.string().optional(),
			uc_comment_write: z.string().optional(),
			uc_recording_read: z.string().optional(),
			uc_scorecard_read: z.string().optional(),
			uc_scorecardtemplate_read: z.string().optional(),
			storage_file_read: z.string().optional(),
			storage_file_write: z.string().optional(),
			webhook: z.string().optional(),
			genai_model_read: z.string().optional(),
			genai_prompt_read: z.string().optional(),
			genai_prompt_write: z.string().optional(),
			genai_embedding_read: z.string().optional(),
			genai_embedding_write: z.string().optional(),
			genai_task_read: z.string().optional(),
			genai_task_write: z.string().optional(),
			genai_agent_read: z.string().optional(),
			genai_agent_write: z.string().optional(),
			genai_organization_read: z.string().optional(),
			genai_organization_write: z.string().optional(),
			genai_skill_read: z.string().optional(),
			genai_skill_write: z.string().optional(),
			genai_memory_read: z.string().optional(),
			genai_memory_write: z.string().optional(),
			messaging_message_read: z.string().optional(),
			messaging_message_write: z.string().optional(),
			messaging_channel_read: z.string().optional(),
			messaging_channel_write: z.string().optional(),
			messaging_event_read: z.string().optional(),
			messaging_event_write: z.string().optional(),
			kms_space_read: z.string().optional(),
			kms_space_write: z.string().optional(),
			kms_page_read: z.string().optional(),
			kms_page_write: z.string().optional(),
			kms_comment_read: z.string().optional(),
			kms_comment_write: z.string().optional(),
			task_project_read: z.string().optional(),
			task_project_write: z.string().optional(),
			task_task_read: z.string().optional(),
			task_task_write: z.string().optional(),
			task_change_read: z.string().optional(),
			task_comment_read: z.string().optional(),
			task_comment_write: z.string().optional(),
			scim_users_read: z.string().optional(),
			scim_users_write: z.string().optional(),
			scim_groups_read: z.string().optional(),
			scim_groups_write: z.string().optional(),
			lms_course_read: z.string().optional(),
			lms_course_write: z.string().optional(),
			lms_class_read: z.string().optional(),
			lms_class_write: z.string().optional(),
			lms_student_read: z.string().optional(),
			lms_student_write: z.string().optional(),
			lms_instructor_read: z.string().optional(),
			lms_instructor_write: z.string().optional(),
			lms_content_read: z.string().optional(),
			lms_content_write: z.string().optional(),
			lms_collection_read: z.string().optional(),
			lms_collection_write: z.string().optional(),
			lms_activity_read: z.string().optional(),
			lms_activity_write: z.string().optional(),
			repo_organization_read: z.string().optional(),
			repo_organization_write: z.string().optional(),
			repo_repository_read: z.string().optional(),
			repo_repository_write: z.string().optional(),
			repo_branch_read: z.string().optional(),
			repo_branch_write: z.string().optional(),
			repo_commit_read: z.string().optional(),
			repo_commit_write: z.string().optional(),
			repo_pullrequest_read: z.string().optional(),
			repo_pullrequest_write: z.string().optional(),
			metadata_metadata_read: z.string().optional(),
			metadata_metadata_write: z.string().optional(),
			calendar_calendar_read: z.string().optional(),
			calendar_calendar_write: z.string().optional(),
			calendar_event_read: z.string().optional(),
			calendar_event_write: z.string().optional(),
			calendar_busy_read: z.string().optional(),
			calendar_link_read: z.string().optional(),
			calendar_link_write: z.string().optional(),
			calendar_recording_read: z.string().optional(),
			calendar_recording_write: z.string().optional(),
			calendar_webinar_read: z.string().optional(),
			calendar_webinar_write: z.string().optional(),
			calendar_bot_read: z.string().optional(),
			calendar_bot_write: z.string().optional(),
			calendar_botevent_read: z.string().optional(),
			calendar_room_read: z.string().optional(),
			calendar_location_read: z.string().optional(),
			enrich_person_read: z.string().optional(),
			enrich_company_read: z.string().optional(),
			ads_ad_read: z.string().optional(),
			ads_ad_write: z.string().optional(),
			ads_campaign_read: z.string().optional(),
			ads_campaign_write: z.string().optional(),
			ads_group_read: z.string().optional(),
			ads_group_write: z.string().optional(),
			ads_report_read: z.string().optional(),
			ads_organization_read: z.string().optional(),
			ads_organization_write: z.string().optional(),
			ads_creative_read: z.string().optional(),
			ads_creative_write: z.string().optional(),
			ads_asset_read: z.string().optional(),
			ads_asset_write: z.string().optional(),
			ads_insertionorder_read: z.string().optional(),
			ads_insertionorder_write: z.string().optional(),
			ads_target_read: z.string().optional(),
			ads_promoted_read: z.string().optional(),
			analytics_property_read: z.string().optional(),
			analytics_property_write: z.string().optional(),
			analytics_event_read: z.string().optional(),
			analytics_event_write: z.string().optional(),
			analytics_session_read: z.string().optional(),
			analytics_visitor_read: z.string().optional(),
			analytics_visitor_write: z.string().optional(),
			analytics_report_read: z.string().optional(),
			forms_form_read: z.string().optional(),
			forms_form_write: z.string().optional(),
			forms_submission_read: z.string().optional(),
			forms_submission_write: z.string().optional(),
			shipping_shipment_read: z.string().optional(),
			shipping_shipment_write: z.string().optional(),
			shipping_label_read: z.string().optional(),
			shipping_label_write: z.string().optional(),
			shipping_tracking_read: z.string().optional(),
			shipping_rate_read: z.string().optional(),
			shipping_rate_write: z.string().optional(),
			shipping_carrier_read: z.string().optional(),
			signing_document_read: z.string().optional(),
			signing_document_write: z.string().optional(),
			signing_signatory_read: z.string().optional(),
			signing_signatory_write: z.string().optional(),
			signing_template_read: z.string().optional(),
			signing_template_write: z.string().optional(),
			clubs_group_read: z.string().optional(),
			clubs_group_write: z.string().optional(),
			clubs_member_read: z.string().optional(),
			clubs_member_write: z.string().optional(),
			clubs_activity_read: z.string().optional(),
			clubs_activity_write: z.string().optional(),
			clubs_location_read: z.string().optional(),
			clubs_location_write: z.string().optional(),
			clubs_event_read: z.string().optional(),
			clubs_event_write: z.string().optional(),
			datastore_database_read: z.string().optional(),
			datastore_database_write: z.string().optional(),
			datastore_table_read: z.string().optional(),
			datastore_table_write: z.string().optional(),
			datastore_record_read: z.string().optional(),
			datastore_record_write: z.string().optional(),
			datastore_query_read: z.string().optional(),
			datastore_query_write: z.string().optional(),
			cdp_profile_read: z.string().optional(),
			cdp_profile_write: z.string().optional(),
			cdp_segment_read: z.string().optional(),
			cdp_segment_write: z.string().optional(),
			cdp_event_read: z.string().optional(),
			cdp_event_write: z.string().optional(),
			cdp_source_read: z.string().optional(),
			cdp_source_write: z.string().optional(),
			cdp_destination_read: z.string().optional(),
			cdp_destination_write: z.string().optional(),
			cdp_activation_read: z.string().optional(),
			cdp_activation_write: z.string().optional(),
			performance_cycle_read: z.string().optional(),
			performance_review_read: z.string().optional(),
			performance_review_write: z.string().optional(),
			performance_goal_read: z.string().optional(),
			performance_goal_write: z.string().optional(),
			performance_feedback_read: z.string().optional(),
			performance_feedback_write: z.string().optional(),
			social_post_read: z.string().optional(),
			social_post_write: z.string().optional(),
			social_profile_read: z.string().optional(),
			social_profile_write: z.string().optional(),
			social_review_read: z.string().optional(),
			social_review_write: z.string().optional(),
			social_insight_read: z.string().optional(),
			social_insight_write: z.string().optional(),
			legal_matter_read: z.string().optional(),
			legal_matter_write: z.string().optional(),
			legal_practicearea_read: z.string().optional(),
			legal_practicearea_write: z.string().optional(),
			legal_timeentry_read: z.string().optional(),
			legal_timeentry_write: z.string().optional(),
			legal_expense_read: z.string().optional(),
			legal_expense_write: z.string().optional(),
			compute_instance_read: z.string().optional(),
			compute_instance_write: z.string().optional(),
			compute_template_read: z.string().optional(),
			compute_template_write: z.string().optional(),
			compute_gputype_read: z.string().optional(),
			compute_region_read: z.string().optional(),
			compute_volume_read: z.string().optional(),
			compute_volume_write: z.string().optional(),
			compute_snapshot_read: z.string().optional(),
			compute_snapshot_write: z.string().optional(),
			compute_usage_read: z.string().optional(),
			compute_key_read: z.string().optional(),
			compute_key_write: z.string().optional(),
			compute_service_read: z.string().optional(),
			compute_service_write: z.string().optional(),
			compute_deployment_read: z.string().optional(),
			compute_deployment_write: z.string().optional(),
			compute_domain_read: z.string().optional(),
			compute_domain_write: z.string().optional(),
			compute_envvar_read: z.string().optional(),
			compute_envvar_write: z.string().optional(),
			healthcare_patient_read: z.string().optional(),
			healthcare_patient_write: z.string().optional(),
			healthcare_practitioner_read: z.string().optional(),
			healthcare_practitioner_write: z.string().optional(),
			healthcare_location_read: z.string().optional(),
			healthcare_location_write: z.string().optional(),
			healthcare_appointment_read: z.string().optional(),
			healthcare_appointment_write: z.string().optional(),
			healthcare_slot_read: z.string().optional(),
			healthcare_slot_write: z.string().optional(),
			healthcare_encounter_read: z.string().optional(),
			healthcare_encounter_write: z.string().optional(),
			healthcare_condition_read: z.string().optional(),
			healthcare_condition_write: z.string().optional(),
			healthcare_allergy_read: z.string().optional(),
			healthcare_allergy_write: z.string().optional(),
			healthcare_medication_read: z.string().optional(),
			healthcare_medication_write: z.string().optional(),
			healthcare_observation_read: z.string().optional(),
			healthcare_observation_write: z.string().optional(),
			healthcare_immunization_read: z.string().optional(),
			healthcare_immunization_write: z.string().optional(),
			healthcare_document_read: z.string().optional(),
			healthcare_document_write: z.string().optional(),
			healthcare_coverage_read: z.string().optional(),
			healthcare_coverage_write: z.string().optional(),
			healthcare_procedure_read: z.string().optional(),
			healthcare_procedure_write: z.string().optional(),
			healthcare_report_read: z.string().optional(),
			healthcare_report_write: z.string().optional(),
			healthcare_careplan_read: z.string().optional(),
			healthcare_careplan_write: z.string().optional(),
			healthcare_goal_read: z.string().optional(),
			healthcare_goal_write: z.string().optional(),
			property_listing_read: z.string().optional(),
			property_listing_write: z.string().optional(),
			property_unittype_read: z.string().optional(),
			property_guest_read: z.string().optional(),
			property_guest_write: z.string().optional(),
			property_reservation_read: z.string().optional(),
			property_reservation_write: z.string().optional(),
			property_availability_read: z.string().optional(),
			property_quote_read: z.string().optional(),
			property_quote_write: z.string().optional(),
			property_review_read: z.string().optional(),
			property_review_write: z.string().optional(),
			property_conversation_read: z.string().optional(),
			property_conversation_write: z.string().optional(),
			plm_part_read: z.string().optional(),
			plm_part_write: z.string().optional(),
			plm_bomline_read: z.string().optional(),
			plm_bomline_write: z.string().optional(),
			plm_document_read: z.string().optional(),
			plm_document_write: z.string().optional(),
			plm_change_read: z.string().optional(),
			plm_change_write: z.string().optional(),
			plm_category_read: z.string().optional(),
			plm_category_write: z.string().optional()
}).optional(),
	success_redirect: z.string().optional().describe("Post-OAuth success URL for marketplace installs (e.g. HighLevel). Used by `/oauth/code/{workspace}/{env}/{integration}`."),
	failure_redirect: z.string().optional().describe("Post-OAuth failure URL for marketplace installs. Used by `/oauth/code/{workspace}/{env}/{integration}`."),
	auth: z.object({
			client_id: z.string().optional(),
			client_secret: z.string().optional(),
			consumer_key: z.string().optional(),
			consumer_secret: z.string().optional(),
			pem: z.string().optional().describe("the PEM X.509 certificate in Base64 ASCII format"),
			key: z.string().optional().describe("the private KEY X.509 certificate in Base64 ASCII format"),
			dev_api_key: z.string().optional(),
			saml_idp_url: z.string().optional().describe("the SAML IdP SSO/login URL for end-user SAML login"),
			saml_idp_entity_id: z.string().optional().describe("the SAML IdP issuer/entity ID"),
			saml_pem: z.string().optional().describe("the SAML IdP signing certificate; PEM X.509 in Base64 ASCII format"),
			needs_pkce: z.boolean().optional().describe("opt-in PKCE for OAuth2 when the integration app or org requires it")
}).optional(),
	secretsmanager_id: z.string().optional().describe("the ID of the SecretsManager object"),
	secretsmanager_key: z.string().optional().describe("the key/path/name of the secret within the vault")
});

Python

Python
import dataclasses

@dataclasses.dataclass
class WorkspaceIntegrationAuth_type(str, Enum):
	oauth2 = 'oauth2'
	other = 'other'
	token = 'token'

@dataclasses.dataclass
class WorkspaceIntegrationCategories(str, Enum):
	passthrough = 'passthrough'
	hris = 'hris'
	ats = 'ats'
	auth = 'auth'
	saml = 'saml'
	crm = 'crm'
	enrich = 'enrich'
	martech = 'martech'
	ticketing = 'ticketing'
	uc = 'uc'
	accounting = 'accounting'
	storage = 'storage'
	commerce = 'commerce'
	payment = 'payment'
	genai = 'genai'
	messaging = 'messaging'
	kms = 'kms'
	task = 'task'
	scim = 'scim'
	lms = 'lms'
	repo = 'repo'
	metadata = 'metadata'
	calendar = 'calendar'
	verification = 'verification'
	ads = 'ads'
	analytics = 'analytics'
	forms = 'forms'
	shipping = 'shipping'
	assessment = 'assessment'
	signing = 'signing'
	clubs = 'clubs'
	datastore = 'datastore'
	cdp = 'cdp'
	performance = 'performance'
	social = 'social'
	legal = 'legal'
	compute = 'compute'
	healthcare = 'healthcare'
	property = 'property'
	plm = 'plm'

@dataclasses.dataclass
class WorkspaceIntegrationPermissions(str, Enum):
	accounting_account_read = 'accounting_account_read'
	accounting_account_write = 'accounting_account_write'
	accounting_transaction_read = 'accounting_transaction_read'
	accounting_transaction_write = 'accounting_transaction_write'
	accounting_journal_read = 'accounting_journal_read'
	accounting_journal_write = 'accounting_journal_write'
	accounting_invoice_read = 'accounting_invoice_read'
	accounting_invoice_write = 'accounting_invoice_write'
	accounting_bill_read = 'accounting_bill_read'
	accounting_bill_write = 'accounting_bill_write'
	accounting_vendorcredit_read = 'accounting_vendorcredit_read'
	accounting_vendorcredit_write = 'accounting_vendorcredit_write'
	accounting_creditmemo_read = 'accounting_creditmemo_read'
	accounting_creditmemo_write = 'accounting_creditmemo_write'
	accounting_contact_read = 'accounting_contact_read'
	accounting_contact_write = 'accounting_contact_write'
	accounting_expense_read = 'accounting_expense_read'
	accounting_expense_write = 'accounting_expense_write'
	accounting_expensereport_read = 'accounting_expensereport_read'
	accounting_expensereport_write = 'accounting_expensereport_write'
	accounting_purchasereceipt_read = 'accounting_purchasereceipt_read'
	accounting_purchasereceipt_write = 'accounting_purchasereceipt_write'
	accounting_taxrate_read = 'accounting_taxrate_read'
	accounting_taxrate_write = 'accounting_taxrate_write'
	accounting_paymentterm_read = 'accounting_paymentterm_read'
	accounting_paymentterm_write = 'accounting_paymentterm_write'
	accounting_organization_read = 'accounting_organization_read'
	accounting_order_read = 'accounting_order_read'
	accounting_order_write = 'accounting_order_write'
	accounting_purchaseorder_read = 'accounting_purchaseorder_read'
	accounting_purchaseorder_write = 'accounting_purchaseorder_write'
	accounting_salesorder_read = 'accounting_salesorder_read'
	accounting_salesorder_write = 'accounting_salesorder_write'
	accounting_salesreceipt_read = 'accounting_salesreceipt_read'
	accounting_salesreceipt_write = 'accounting_salesreceipt_write'
	accounting_trialbalance_read = 'accounting_trialbalance_read'
	accounting_trialbalance_write = 'accounting_trialbalance_write'
	accounting_profitloss_read = 'accounting_profitloss_read'
	accounting_profitloss_write = 'accounting_profitloss_write'
	accounting_balancesheet_read = 'accounting_balancesheet_read'
	accounting_balancesheet_write = 'accounting_balancesheet_write'
	accounting_category_read = 'accounting_category_read'
	accounting_category_write = 'accounting_category_write'
	payment_payment_read = 'payment_payment_read'
	payment_payment_write = 'payment_payment_write'
	accounting_cashflow_read = 'accounting_cashflow_read'
	accounting_cashflow_write = 'accounting_cashflow_write'
	accounting_quote_read = 'accounting_quote_read'
	accounting_quote_write = 'accounting_quote_write'
	accounting_agedreceivable_read = 'accounting_agedreceivable_read'
	accounting_agedpayable_read = 'accounting_agedpayable_read'
	accounting_project_read = 'accounting_project_read'
	accounting_project_write = 'accounting_project_write'
	accounting_bankfeedaccount_read = 'accounting_bankfeedaccount_read'
	accounting_bankfeedaccount_write = 'accounting_bankfeedaccount_write'
	accounting_bankfeedtransaction_read = 'accounting_bankfeedtransaction_read'
	accounting_bankfeedtransaction_write = 'accounting_bankfeedtransaction_write'
	payment_payout_read = 'payment_payout_read'
	payment_refund_read = 'payment_refund_read'
	payment_link_read = 'payment_link_read'
	payment_link_write = 'payment_link_write'
	payment_subscription_read = 'payment_subscription_read'
	payment_subscription_write = 'payment_subscription_write'
	commerce_item_read = 'commerce_item_read'
	commerce_item_write = 'commerce_item_write'
	commerce_collection_read = 'commerce_collection_read'
	commerce_collection_write = 'commerce_collection_write'
	commerce_inventory_read = 'commerce_inventory_read'
	commerce_inventory_write = 'commerce_inventory_write'
	commerce_location_read = 'commerce_location_read'
	commerce_location_write = 'commerce_location_write'
	commerce_review_read = 'commerce_review_read'
	commerce_review_write = 'commerce_review_write'
	commerce_saleschannel_read = 'commerce_saleschannel_read'
	commerce_saleschannel_write = 'commerce_saleschannel_write'
	commerce_itemvariant_read = 'commerce_itemvariant_read'
	commerce_itemvariant_write = 'commerce_itemvariant_write'
	commerce_reservation_read = 'commerce_reservation_read'
	commerce_reservation_write = 'commerce_reservation_write'
	commerce_table_read = 'commerce_table_read'
	commerce_table_write = 'commerce_table_write'
	commerce_return_read = 'commerce_return_read'
	commerce_return_write = 'commerce_return_write'
	commerce_availability_read = 'commerce_availability_read'
	commerce_availability_write = 'commerce_availability_write'
	verification_package_read = 'verification_package_read'
	verification_request_read = 'verification_request_read'
	verification_request_write = 'verification_request_write'
	assessment_package_read = 'assessment_package_read'
	assessment_package_write = 'assessment_package_write'
	assessment_order_write = 'assessment_order_write'
	ats_activity_read = 'ats_activity_read'
	ats_activity_write = 'ats_activity_write'
	ats_application_read = 'ats_application_read'
	ats_application_write = 'ats_application_write'
	ats_applicationstatus_read = 'ats_applicationstatus_read'
	ats_candidate_read = 'ats_candidate_read'
	ats_candidate_write = 'ats_candidate_write'
	ats_interview_read = 'ats_interview_read'
	ats_interview_write = 'ats_interview_write'
	ats_job_read = 'ats_job_read'
	ats_job_write = 'ats_job_write'
	ats_company_read = 'ats_company_read'
	ats_company_write = 'ats_company_write'
	ats_document_read = 'ats_document_read'
	ats_document_write = 'ats_document_write'
	ats_scorecard_read = 'ats_scorecard_read'
	ats_scorecard_write = 'ats_scorecard_write'
	crm_company_read = 'crm_company_read'
	crm_company_write = 'crm_company_write'
	crm_contact_read = 'crm_contact_read'
	crm_contact_write = 'crm_contact_write'
	crm_deal_read = 'crm_deal_read'
	crm_deal_write = 'crm_deal_write'
	crm_event_read = 'crm_event_read'
	crm_event_write = 'crm_event_write'
	crm_lead_read = 'crm_lead_read'
	crm_lead_write = 'crm_lead_write'
	crm_pipeline_read = 'crm_pipeline_read'
	crm_pipeline_write = 'crm_pipeline_write'
	crm_taxonomy_read = 'crm_taxonomy_read'
	martech_list_read = 'martech_list_read'
	martech_list_write = 'martech_list_write'
	martech_member_read = 'martech_member_read'
	martech_member_write = 'martech_member_write'
	martech_campaign_read = 'martech_campaign_read'
	martech_campaign_write = 'martech_campaign_write'
	martech_report_read = 'martech_report_read'
	martech_report_write = 'martech_report_write'
	ticketing_customer_read = 'ticketing_customer_read'
	ticketing_customer_write = 'ticketing_customer_write'
	ticketing_ticket_read = 'ticketing_ticket_read'
	ticketing_ticket_write = 'ticketing_ticket_write'
	ticketing_note_read = 'ticketing_note_read'
	ticketing_note_write = 'ticketing_note_write'
	ticketing_category_read = 'ticketing_category_read'
	ticketing_category_write = 'ticketing_category_write'
	hris_employee_read = 'hris_employee_read'
	hris_employee_write = 'hris_employee_write'
	hris_group_read = 'hris_group_read'
	hris_group_write = 'hris_group_write'
	hris_payslip_read = 'hris_payslip_read'
	hris_payslip_write = 'hris_payslip_write'
	hris_timeoff_read = 'hris_timeoff_read'
	hris_timeoff_write = 'hris_timeoff_write'
	hris_timeshift_read = 'hris_timeshift_read'
	hris_timeshift_write = 'hris_timeshift_write'
	hris_attendance_read = 'hris_attendance_read'
	hris_attendance_write = 'hris_attendance_write'
	hris_company_read = 'hris_company_read'
	hris_company_write = 'hris_company_write'
	hris_location_read = 'hris_location_read'
	hris_location_write = 'hris_location_write'
	hris_device_read = 'hris_device_read'
	hris_device_write = 'hris_device_write'
	hris_deduction_read = 'hris_deduction_read'
	hris_deduction_write = 'hris_deduction_write'
	hris_benefit_read = 'hris_benefit_read'
	hris_benefit_write = 'hris_benefit_write'
	hris_bankaccount_read = 'hris_bankaccount_read'
	hris_bankaccount_write = 'hris_bankaccount_write'
	hris_document_read = 'hris_document_read'
	hris_document_write = 'hris_document_write'
	hris_taxonomy_read = 'hris_taxonomy_read'
	hris_taxonomy_write = 'hris_taxonomy_write'
	hris_job_read = 'hris_job_read'
	hris_job_write = 'hris_job_write'
	hris_payroll_read = 'hris_payroll_read'
	hris_payroll_write = 'hris_payroll_write'
	hris_paycode_read = 'hris_paycode_read'
	hris_paycode_write = 'hris_paycode_write'
	hris_earning_read = 'hris_earning_read'
	hris_earning_write = 'hris_earning_write'
	uc_call_read = 'uc_call_read'
	uc_call_write = 'uc_call_write'
	uc_contact_read = 'uc_contact_read'
	uc_contact_write = 'uc_contact_write'
	uc_fax_read = 'uc_fax_read'
	uc_fax_write = 'uc_fax_write'
	uc_comment_read = 'uc_comment_read'
	uc_comment_write = 'uc_comment_write'
	uc_recording_read = 'uc_recording_read'
	uc_scorecard_read = 'uc_scorecard_read'
	uc_scorecardtemplate_read = 'uc_scorecardtemplate_read'
	storage_file_read = 'storage_file_read'
	storage_file_write = 'storage_file_write'
	webhook = 'webhook'
	genai_model_read = 'genai_model_read'
	genai_prompt_read = 'genai_prompt_read'
	genai_prompt_write = 'genai_prompt_write'
	genai_embedding_read = 'genai_embedding_read'
	genai_embedding_write = 'genai_embedding_write'
	genai_task_read = 'genai_task_read'
	genai_task_write = 'genai_task_write'
	genai_agent_read = 'genai_agent_read'
	genai_agent_write = 'genai_agent_write'
	genai_organization_read = 'genai_organization_read'
	genai_organization_write = 'genai_organization_write'
	genai_skill_read = 'genai_skill_read'
	genai_skill_write = 'genai_skill_write'
	genai_memory_read = 'genai_memory_read'
	genai_memory_write = 'genai_memory_write'
	messaging_message_read = 'messaging_message_read'
	messaging_message_write = 'messaging_message_write'
	messaging_channel_read = 'messaging_channel_read'
	messaging_channel_write = 'messaging_channel_write'
	messaging_event_read = 'messaging_event_read'
	messaging_event_write = 'messaging_event_write'
	kms_space_read = 'kms_space_read'
	kms_space_write = 'kms_space_write'
	kms_page_read = 'kms_page_read'
	kms_page_write = 'kms_page_write'
	kms_comment_read = 'kms_comment_read'
	kms_comment_write = 'kms_comment_write'
	task_project_read = 'task_project_read'
	task_project_write = 'task_project_write'
	task_task_read = 'task_task_read'
	task_task_write = 'task_task_write'
	task_change_read = 'task_change_read'
	task_comment_read = 'task_comment_read'
	task_comment_write = 'task_comment_write'
	scim_users_read = 'scim_users_read'
	scim_users_write = 'scim_users_write'
	scim_groups_read = 'scim_groups_read'
	scim_groups_write = 'scim_groups_write'
	lms_course_read = 'lms_course_read'
	lms_course_write = 'lms_course_write'
	lms_class_read = 'lms_class_read'
	lms_class_write = 'lms_class_write'
	lms_student_read = 'lms_student_read'
	lms_student_write = 'lms_student_write'
	lms_instructor_read = 'lms_instructor_read'
	lms_instructor_write = 'lms_instructor_write'
	lms_content_read = 'lms_content_read'
	lms_content_write = 'lms_content_write'
	lms_collection_read = 'lms_collection_read'
	lms_collection_write = 'lms_collection_write'
	lms_activity_read = 'lms_activity_read'
	lms_activity_write = 'lms_activity_write'
	repo_organization_read = 'repo_organization_read'
	repo_organization_write = 'repo_organization_write'
	repo_repository_read = 'repo_repository_read'
	repo_repository_write = 'repo_repository_write'
	repo_branch_read = 'repo_branch_read'
	repo_branch_write = 'repo_branch_write'
	repo_commit_read = 'repo_commit_read'
	repo_commit_write = 'repo_commit_write'
	repo_pullrequest_read = 'repo_pullrequest_read'
	repo_pullrequest_write = 'repo_pullrequest_write'
	metadata_metadata_read = 'metadata_metadata_read'
	metadata_metadata_write = 'metadata_metadata_write'
	calendar_calendar_read = 'calendar_calendar_read'
	calendar_calendar_write = 'calendar_calendar_write'
	calendar_event_read = 'calendar_event_read'
	calendar_event_write = 'calendar_event_write'
	calendar_busy_read = 'calendar_busy_read'
	calendar_link_read = 'calendar_link_read'
	calendar_link_write = 'calendar_link_write'
	calendar_recording_read = 'calendar_recording_read'
	calendar_recording_write = 'calendar_recording_write'
	calendar_webinar_read = 'calendar_webinar_read'
	calendar_webinar_write = 'calendar_webinar_write'
	calendar_bot_read = 'calendar_bot_read'
	calendar_bot_write = 'calendar_bot_write'
	calendar_botevent_read = 'calendar_botevent_read'
	calendar_room_read = 'calendar_room_read'
	calendar_location_read = 'calendar_location_read'
	enrich_person_read = 'enrich_person_read'
	enrich_company_read = 'enrich_company_read'
	ads_ad_read = 'ads_ad_read'
	ads_ad_write = 'ads_ad_write'
	ads_campaign_read = 'ads_campaign_read'
	ads_campaign_write = 'ads_campaign_write'
	ads_group_read = 'ads_group_read'
	ads_group_write = 'ads_group_write'
	ads_report_read = 'ads_report_read'
	ads_organization_read = 'ads_organization_read'
	ads_organization_write = 'ads_organization_write'
	ads_creative_read = 'ads_creative_read'
	ads_creative_write = 'ads_creative_write'
	ads_asset_read = 'ads_asset_read'
	ads_asset_write = 'ads_asset_write'
	ads_insertionorder_read = 'ads_insertionorder_read'
	ads_insertionorder_write = 'ads_insertionorder_write'
	ads_target_read = 'ads_target_read'
	ads_promoted_read = 'ads_promoted_read'
	analytics_property_read = 'analytics_property_read'
	analytics_property_write = 'analytics_property_write'
	analytics_event_read = 'analytics_event_read'
	analytics_event_write = 'analytics_event_write'
	analytics_session_read = 'analytics_session_read'
	analytics_visitor_read = 'analytics_visitor_read'
	analytics_visitor_write = 'analytics_visitor_write'
	analytics_report_read = 'analytics_report_read'
	forms_form_read = 'forms_form_read'
	forms_form_write = 'forms_form_write'
	forms_submission_read = 'forms_submission_read'
	forms_submission_write = 'forms_submission_write'
	shipping_shipment_read = 'shipping_shipment_read'
	shipping_shipment_write = 'shipping_shipment_write'
	shipping_label_read = 'shipping_label_read'
	shipping_label_write = 'shipping_label_write'
	shipping_tracking_read = 'shipping_tracking_read'
	shipping_rate_read = 'shipping_rate_read'
	shipping_rate_write = 'shipping_rate_write'
	shipping_carrier_read = 'shipping_carrier_read'
	signing_document_read = 'signing_document_read'
	signing_document_write = 'signing_document_write'
	signing_signatory_read = 'signing_signatory_read'
	signing_signatory_write = 'signing_signatory_write'
	signing_template_read = 'signing_template_read'
	signing_template_write = 'signing_template_write'
	clubs_group_read = 'clubs_group_read'
	clubs_group_write = 'clubs_group_write'
	clubs_member_read = 'clubs_member_read'
	clubs_member_write = 'clubs_member_write'
	clubs_activity_read = 'clubs_activity_read'
	clubs_activity_write = 'clubs_activity_write'
	clubs_location_read = 'clubs_location_read'
	clubs_location_write = 'clubs_location_write'
	clubs_event_read = 'clubs_event_read'
	clubs_event_write = 'clubs_event_write'
	datastore_database_read = 'datastore_database_read'
	datastore_database_write = 'datastore_database_write'
	datastore_table_read = 'datastore_table_read'
	datastore_table_write = 'datastore_table_write'
	datastore_record_read = 'datastore_record_read'
	datastore_record_write = 'datastore_record_write'
	datastore_query_read = 'datastore_query_read'
	datastore_query_write = 'datastore_query_write'
	cdp_profile_read = 'cdp_profile_read'
	cdp_profile_write = 'cdp_profile_write'
	cdp_segment_read = 'cdp_segment_read'
	cdp_segment_write = 'cdp_segment_write'
	cdp_event_read = 'cdp_event_read'
	cdp_event_write = 'cdp_event_write'
	cdp_source_read = 'cdp_source_read'
	cdp_source_write = 'cdp_source_write'
	cdp_destination_read = 'cdp_destination_read'
	cdp_destination_write = 'cdp_destination_write'
	cdp_activation_read = 'cdp_activation_read'
	cdp_activation_write = 'cdp_activation_write'
	performance_cycle_read = 'performance_cycle_read'
	performance_review_read = 'performance_review_read'
	performance_review_write = 'performance_review_write'
	performance_goal_read = 'performance_goal_read'
	performance_goal_write = 'performance_goal_write'
	performance_feedback_read = 'performance_feedback_read'
	performance_feedback_write = 'performance_feedback_write'
	social_post_read = 'social_post_read'
	social_post_write = 'social_post_write'
	social_profile_read = 'social_profile_read'
	social_profile_write = 'social_profile_write'
	social_review_read = 'social_review_read'
	social_review_write = 'social_review_write'
	social_insight_read = 'social_insight_read'
	social_insight_write = 'social_insight_write'
	legal_matter_read = 'legal_matter_read'
	legal_matter_write = 'legal_matter_write'
	legal_practicearea_read = 'legal_practicearea_read'
	legal_practicearea_write = 'legal_practicearea_write'
	legal_timeentry_read = 'legal_timeentry_read'
	legal_timeentry_write = 'legal_timeentry_write'
	legal_expense_read = 'legal_expense_read'
	legal_expense_write = 'legal_expense_write'
	compute_instance_read = 'compute_instance_read'
	compute_instance_write = 'compute_instance_write'
	compute_template_read = 'compute_template_read'
	compute_template_write = 'compute_template_write'
	compute_gputype_read = 'compute_gputype_read'
	compute_region_read = 'compute_region_read'
	compute_volume_read = 'compute_volume_read'
	compute_volume_write = 'compute_volume_write'
	compute_snapshot_read = 'compute_snapshot_read'
	compute_snapshot_write = 'compute_snapshot_write'
	compute_usage_read = 'compute_usage_read'
	compute_key_read = 'compute_key_read'
	compute_key_write = 'compute_key_write'
	compute_service_read = 'compute_service_read'
	compute_service_write = 'compute_service_write'
	compute_deployment_read = 'compute_deployment_read'
	compute_deployment_write = 'compute_deployment_write'
	compute_domain_read = 'compute_domain_read'
	compute_domain_write = 'compute_domain_write'
	compute_envvar_read = 'compute_envvar_read'
	compute_envvar_write = 'compute_envvar_write'
	healthcare_patient_read = 'healthcare_patient_read'
	healthcare_patient_write = 'healthcare_patient_write'
	healthcare_practitioner_read = 'healthcare_practitioner_read'
	healthcare_practitioner_write = 'healthcare_practitioner_write'
	healthcare_location_read = 'healthcare_location_read'
	healthcare_location_write = 'healthcare_location_write'
	healthcare_appointment_read = 'healthcare_appointment_read'
	healthcare_appointment_write = 'healthcare_appointment_write'
	healthcare_slot_read = 'healthcare_slot_read'
	healthcare_slot_write = 'healthcare_slot_write'
	healthcare_encounter_read = 'healthcare_encounter_read'
	healthcare_encounter_write = 'healthcare_encounter_write'
	healthcare_condition_read = 'healthcare_condition_read'
	healthcare_condition_write = 'healthcare_condition_write'
	healthcare_allergy_read = 'healthcare_allergy_read'
	healthcare_allergy_write = 'healthcare_allergy_write'
	healthcare_medication_read = 'healthcare_medication_read'
	healthcare_medication_write = 'healthcare_medication_write'
	healthcare_observation_read = 'healthcare_observation_read'
	healthcare_observation_write = 'healthcare_observation_write'
	healthcare_immunization_read = 'healthcare_immunization_read'
	healthcare_immunization_write = 'healthcare_immunization_write'
	healthcare_document_read = 'healthcare_document_read'
	healthcare_document_write = 'healthcare_document_write'
	healthcare_coverage_read = 'healthcare_coverage_read'
	healthcare_coverage_write = 'healthcare_coverage_write'
	healthcare_procedure_read = 'healthcare_procedure_read'
	healthcare_procedure_write = 'healthcare_procedure_write'
	healthcare_report_read = 'healthcare_report_read'
	healthcare_report_write = 'healthcare_report_write'
	healthcare_careplan_read = 'healthcare_careplan_read'
	healthcare_careplan_write = 'healthcare_careplan_write'
	healthcare_goal_read = 'healthcare_goal_read'
	healthcare_goal_write = 'healthcare_goal_write'
	property_listing_read = 'property_listing_read'
	property_listing_write = 'property_listing_write'
	property_unittype_read = 'property_unittype_read'
	property_guest_read = 'property_guest_read'
	property_guest_write = 'property_guest_write'
	property_reservation_read = 'property_reservation_read'
	property_reservation_write = 'property_reservation_write'
	property_availability_read = 'property_availability_read'
	property_quote_read = 'property_quote_read'
	property_quote_write = 'property_quote_write'
	property_review_read = 'property_review_read'
	property_review_write = 'property_review_write'
	property_conversation_read = 'property_conversation_read'
	property_conversation_write = 'property_conversation_write'
	plm_part_read = 'plm_part_read'
	plm_part_write = 'plm_part_write'
	plm_bomline_read = 'plm_bomline_read'
	plm_bomline_write = 'plm_bomline_write'
	plm_document_read = 'plm_document_read'
	plm_document_write = 'plm_document_write'
	plm_change_read = 'plm_change_read'
	plm_change_write = 'plm_change_write'
	plm_category_read = 'plm_category_read'
	plm_category_write = 'plm_category_write'

@dataclasses.dataclass
class PropertyWorkspaceIntegrationOverriden_scopes:
	accounting_account_read: Optional[str]
	accounting_account_write: Optional[str]
	accounting_transaction_read: Optional[str]
	accounting_transaction_write: Optional[str]
	accounting_journal_read: Optional[str]
	accounting_journal_write: Optional[str]
	accounting_invoice_read: Optional[str]
	accounting_invoice_write: Optional[str]
	accounting_bill_read: Optional[str]
	accounting_bill_write: Optional[str]
	accounting_vendorcredit_read: Optional[str]
	accounting_vendorcredit_write: Optional[str]
	accounting_creditmemo_read: Optional[str]
	accounting_creditmemo_write: Optional[str]
	accounting_contact_read: Optional[str]
	accounting_contact_write: Optional[str]
	accounting_expense_read: Optional[str]
	accounting_expense_write: Optional[str]
	accounting_expensereport_read: Optional[str]
	accounting_expensereport_write: Optional[str]
	accounting_purchasereceipt_read: Optional[str]
	accounting_purchasereceipt_write: Optional[str]
	accounting_taxrate_read: Optional[str]
	accounting_taxrate_write: Optional[str]
	accounting_paymentterm_read: Optional[str]
	accounting_paymentterm_write: Optional[str]
	accounting_organization_read: Optional[str]
	accounting_order_read: Optional[str]
	accounting_order_write: Optional[str]
	accounting_purchaseorder_read: Optional[str]
	accounting_purchaseorder_write: Optional[str]
	accounting_salesorder_read: Optional[str]
	accounting_salesorder_write: Optional[str]
	accounting_salesreceipt_read: Optional[str]
	accounting_salesreceipt_write: Optional[str]
	accounting_trialbalance_read: Optional[str]
	accounting_trialbalance_write: Optional[str]
	accounting_profitloss_read: Optional[str]
	accounting_profitloss_write: Optional[str]
	accounting_balancesheet_read: Optional[str]
	accounting_balancesheet_write: Optional[str]
	accounting_category_read: Optional[str]
	accounting_category_write: Optional[str]
	payment_payment_read: Optional[str]
	payment_payment_write: Optional[str]
	accounting_cashflow_read: Optional[str]
	accounting_cashflow_write: Optional[str]
	accounting_quote_read: Optional[str]
	accounting_quote_write: Optional[str]
	accounting_agedreceivable_read: Optional[str]
	accounting_agedpayable_read: Optional[str]
	accounting_project_read: Optional[str]
	accounting_project_write: Optional[str]
	accounting_bankfeedaccount_read: Optional[str]
	accounting_bankfeedaccount_write: Optional[str]
	accounting_bankfeedtransaction_read: Optional[str]
	accounting_bankfeedtransaction_write: Optional[str]
	payment_payout_read: Optional[str]
	payment_refund_read: Optional[str]
	payment_link_read: Optional[str]
	payment_link_write: Optional[str]
	payment_subscription_read: Optional[str]
	payment_subscription_write: Optional[str]
	commerce_item_read: Optional[str]
	commerce_item_write: Optional[str]
	commerce_collection_read: Optional[str]
	commerce_collection_write: Optional[str]
	commerce_inventory_read: Optional[str]
	commerce_inventory_write: Optional[str]
	commerce_location_read: Optional[str]
	commerce_location_write: Optional[str]
	commerce_review_read: Optional[str]
	commerce_review_write: Optional[str]
	commerce_saleschannel_read: Optional[str]
	commerce_saleschannel_write: Optional[str]
	commerce_itemvariant_read: Optional[str]
	commerce_itemvariant_write: Optional[str]
	commerce_reservation_read: Optional[str]
	commerce_reservation_write: Optional[str]
	commerce_table_read: Optional[str]
	commerce_table_write: Optional[str]
	commerce_return_read: Optional[str]
	commerce_return_write: Optional[str]
	commerce_availability_read: Optional[str]
	commerce_availability_write: Optional[str]
	verification_package_read: Optional[str]
	verification_request_read: Optional[str]
	verification_request_write: Optional[str]
	assessment_package_read: Optional[str]
	assessment_package_write: Optional[str]
	assessment_order_write: Optional[str]
	ats_activity_read: Optional[str]
	ats_activity_write: Optional[str]
	ats_application_read: Optional[str]
	ats_application_write: Optional[str]
	ats_applicationstatus_read: Optional[str]
	ats_candidate_read: Optional[str]
	ats_candidate_write: Optional[str]
	ats_interview_read: Optional[str]
	ats_interview_write: Optional[str]
	ats_job_read: Optional[str]
	ats_job_write: Optional[str]
	ats_company_read: Optional[str]
	ats_company_write: Optional[str]
	ats_document_read: Optional[str]
	ats_document_write: Optional[str]
	ats_scorecard_read: Optional[str]
	ats_scorecard_write: Optional[str]
	crm_company_read: Optional[str]
	crm_company_write: Optional[str]
	crm_contact_read: Optional[str]
	crm_contact_write: Optional[str]
	crm_deal_read: Optional[str]
	crm_deal_write: Optional[str]
	crm_event_read: Optional[str]
	crm_event_write: Optional[str]
	crm_lead_read: Optional[str]
	crm_lead_write: Optional[str]
	crm_pipeline_read: Optional[str]
	crm_pipeline_write: Optional[str]
	crm_taxonomy_read: Optional[str]
	martech_list_read: Optional[str]
	martech_list_write: Optional[str]
	martech_member_read: Optional[str]
	martech_member_write: Optional[str]
	martech_campaign_read: Optional[str]
	martech_campaign_write: Optional[str]
	martech_report_read: Optional[str]
	martech_report_write: Optional[str]
	ticketing_customer_read: Optional[str]
	ticketing_customer_write: Optional[str]
	ticketing_ticket_read: Optional[str]
	ticketing_ticket_write: Optional[str]
	ticketing_note_read: Optional[str]
	ticketing_note_write: Optional[str]
	ticketing_category_read: Optional[str]
	ticketing_category_write: Optional[str]
	hris_employee_read: Optional[str]
	hris_employee_write: Optional[str]
	hris_group_read: Optional[str]
	hris_group_write: Optional[str]
	hris_payslip_read: Optional[str]
	hris_payslip_write: Optional[str]
	hris_timeoff_read: Optional[str]
	hris_timeoff_write: Optional[str]
	hris_timeshift_read: Optional[str]
	hris_timeshift_write: Optional[str]
	hris_attendance_read: Optional[str]
	hris_attendance_write: Optional[str]
	hris_company_read: Optional[str]
	hris_company_write: Optional[str]
	hris_location_read: Optional[str]
	hris_location_write: Optional[str]
	hris_device_read: Optional[str]
	hris_device_write: Optional[str]
	hris_deduction_read: Optional[str]
	hris_deduction_write: Optional[str]
	hris_benefit_read: Optional[str]
	hris_benefit_write: Optional[str]
	hris_bankaccount_read: Optional[str]
	hris_bankaccount_write: Optional[str]
	hris_document_read: Optional[str]
	hris_document_write: Optional[str]
	hris_taxonomy_read: Optional[str]
	hris_taxonomy_write: Optional[str]
	hris_job_read: Optional[str]
	hris_job_write: Optional[str]
	hris_payroll_read: Optional[str]
	hris_payroll_write: Optional[str]
	hris_paycode_read: Optional[str]
	hris_paycode_write: Optional[str]
	hris_earning_read: Optional[str]
	hris_earning_write: Optional[str]
	uc_call_read: Optional[str]
	uc_call_write: Optional[str]
	uc_contact_read: Optional[str]
	uc_contact_write: Optional[str]
	uc_fax_read: Optional[str]
	uc_fax_write: Optional[str]
	uc_comment_read: Optional[str]
	uc_comment_write: Optional[str]
	uc_recording_read: Optional[str]
	uc_scorecard_read: Optional[str]
	uc_scorecardtemplate_read: Optional[str]
	storage_file_read: Optional[str]
	storage_file_write: Optional[str]
	webhook: Optional[str]
	genai_model_read: Optional[str]
	genai_prompt_read: Optional[str]
	genai_prompt_write: Optional[str]
	genai_embedding_read: Optional[str]
	genai_embedding_write: Optional[str]
	genai_task_read: Optional[str]
	genai_task_write: Optional[str]
	genai_agent_read: Optional[str]
	genai_agent_write: Optional[str]
	genai_organization_read: Optional[str]
	genai_organization_write: Optional[str]
	genai_skill_read: Optional[str]
	genai_skill_write: Optional[str]
	genai_memory_read: Optional[str]
	genai_memory_write: Optional[str]
	messaging_message_read: Optional[str]
	messaging_message_write: Optional[str]
	messaging_channel_read: Optional[str]
	messaging_channel_write: Optional[str]
	messaging_event_read: Optional[str]
	messaging_event_write: Optional[str]
	kms_space_read: Optional[str]
	kms_space_write: Optional[str]
	kms_page_read: Optional[str]
	kms_page_write: Optional[str]
	kms_comment_read: Optional[str]
	kms_comment_write: Optional[str]
	task_project_read: Optional[str]
	task_project_write: Optional[str]
	task_task_read: Optional[str]
	task_task_write: Optional[str]
	task_change_read: Optional[str]
	task_comment_read: Optional[str]
	task_comment_write: Optional[str]
	scim_users_read: Optional[str]
	scim_users_write: Optional[str]
	scim_groups_read: Optional[str]
	scim_groups_write: Optional[str]
	lms_course_read: Optional[str]
	lms_course_write: Optional[str]
	lms_class_read: Optional[str]
	lms_class_write: Optional[str]
	lms_student_read: Optional[str]
	lms_student_write: Optional[str]
	lms_instructor_read: Optional[str]
	lms_instructor_write: Optional[str]
	lms_content_read: Optional[str]
	lms_content_write: Optional[str]
	lms_collection_read: Optional[str]
	lms_collection_write: Optional[str]
	lms_activity_read: Optional[str]
	lms_activity_write: Optional[str]
	repo_organization_read: Optional[str]
	repo_organization_write: Optional[str]
	repo_repository_read: Optional[str]
	repo_repository_write: Optional[str]
	repo_branch_read: Optional[str]
	repo_branch_write: Optional[str]
	repo_commit_read: Optional[str]
	repo_commit_write: Optional[str]
	repo_pullrequest_read: Optional[str]
	repo_pullrequest_write: Optional[str]
	metadata_metadata_read: Optional[str]
	metadata_metadata_write: Optional[str]
	calendar_calendar_read: Optional[str]
	calendar_calendar_write: Optional[str]
	calendar_event_read: Optional[str]
	calendar_event_write: Optional[str]
	calendar_busy_read: Optional[str]
	calendar_link_read: Optional[str]
	calendar_link_write: Optional[str]
	calendar_recording_read: Optional[str]
	calendar_recording_write: Optional[str]
	calendar_webinar_read: Optional[str]
	calendar_webinar_write: Optional[str]
	calendar_bot_read: Optional[str]
	calendar_bot_write: Optional[str]
	calendar_botevent_read: Optional[str]
	calendar_room_read: Optional[str]
	calendar_location_read: Optional[str]
	enrich_person_read: Optional[str]
	enrich_company_read: Optional[str]
	ads_ad_read: Optional[str]
	ads_ad_write: Optional[str]
	ads_campaign_read: Optional[str]
	ads_campaign_write: Optional[str]
	ads_group_read: Optional[str]
	ads_group_write: Optional[str]
	ads_report_read: Optional[str]
	ads_organization_read: Optional[str]
	ads_organization_write: Optional[str]
	ads_creative_read: Optional[str]
	ads_creative_write: Optional[str]
	ads_asset_read: Optional[str]
	ads_asset_write: Optional[str]
	ads_insertionorder_read: Optional[str]
	ads_insertionorder_write: Optional[str]
	ads_target_read: Optional[str]
	ads_promoted_read: Optional[str]
	analytics_property_read: Optional[str]
	analytics_property_write: Optional[str]
	analytics_event_read: Optional[str]
	analytics_event_write: Optional[str]
	analytics_session_read: Optional[str]
	analytics_visitor_read: Optional[str]
	analytics_visitor_write: Optional[str]
	analytics_report_read: Optional[str]
	forms_form_read: Optional[str]
	forms_form_write: Optional[str]
	forms_submission_read: Optional[str]
	forms_submission_write: Optional[str]
	shipping_shipment_read: Optional[str]
	shipping_shipment_write: Optional[str]
	shipping_label_read: Optional[str]
	shipping_label_write: Optional[str]
	shipping_tracking_read: Optional[str]
	shipping_rate_read: Optional[str]
	shipping_rate_write: Optional[str]
	shipping_carrier_read: Optional[str]
	signing_document_read: Optional[str]
	signing_document_write: Optional[str]
	signing_signatory_read: Optional[str]
	signing_signatory_write: Optional[str]
	signing_template_read: Optional[str]
	signing_template_write: Optional[str]
	clubs_group_read: Optional[str]
	clubs_group_write: Optional[str]
	clubs_member_read: Optional[str]
	clubs_member_write: Optional[str]
	clubs_activity_read: Optional[str]
	clubs_activity_write: Optional[str]
	clubs_location_read: Optional[str]
	clubs_location_write: Optional[str]
	clubs_event_read: Optional[str]
	clubs_event_write: Optional[str]
	datastore_database_read: Optional[str]
	datastore_database_write: Optional[str]
	datastore_table_read: Optional[str]
	datastore_table_write: Optional[str]
	datastore_record_read: Optional[str]
	datastore_record_write: Optional[str]
	datastore_query_read: Optional[str]
	datastore_query_write: Optional[str]
	cdp_profile_read: Optional[str]
	cdp_profile_write: Optional[str]
	cdp_segment_read: Optional[str]
	cdp_segment_write: Optional[str]
	cdp_event_read: Optional[str]
	cdp_event_write: Optional[str]
	cdp_source_read: Optional[str]
	cdp_source_write: Optional[str]
	cdp_destination_read: Optional[str]
	cdp_destination_write: Optional[str]
	cdp_activation_read: Optional[str]
	cdp_activation_write: Optional[str]
	performance_cycle_read: Optional[str]
	performance_review_read: Optional[str]
	performance_review_write: Optional[str]
	performance_goal_read: Optional[str]
	performance_goal_write: Optional[str]
	performance_feedback_read: Optional[str]
	performance_feedback_write: Optional[str]
	social_post_read: Optional[str]
	social_post_write: Optional[str]
	social_profile_read: Optional[str]
	social_profile_write: Optional[str]
	social_review_read: Optional[str]
	social_review_write: Optional[str]
	social_insight_read: Optional[str]
	social_insight_write: Optional[str]
	legal_matter_read: Optional[str]
	legal_matter_write: Optional[str]
	legal_practicearea_read: Optional[str]
	legal_practicearea_write: Optional[str]
	legal_timeentry_read: Optional[str]
	legal_timeentry_write: Optional[str]
	legal_expense_read: Optional[str]
	legal_expense_write: Optional[str]
	compute_instance_read: Optional[str]
	compute_instance_write: Optional[str]
	compute_template_read: Optional[str]
	compute_template_write: Optional[str]
	compute_gputype_read: Optional[str]
	compute_region_read: Optional[str]
	compute_volume_read: Optional[str]
	compute_volume_write: Optional[str]
	compute_snapshot_read: Optional[str]
	compute_snapshot_write: Optional[str]
	compute_usage_read: Optional[str]
	compute_key_read: Optional[str]
	compute_key_write: Optional[str]
	compute_service_read: Optional[str]
	compute_service_write: Optional[str]
	compute_deployment_read: Optional[str]
	compute_deployment_write: Optional[str]
	compute_domain_read: Optional[str]
	compute_domain_write: Optional[str]
	compute_envvar_read: Optional[str]
	compute_envvar_write: Optional[str]
	healthcare_patient_read: Optional[str]
	healthcare_patient_write: Optional[str]
	healthcare_practitioner_read: Optional[str]
	healthcare_practitioner_write: Optional[str]
	healthcare_location_read: Optional[str]
	healthcare_location_write: Optional[str]
	healthcare_appointment_read: Optional[str]
	healthcare_appointment_write: Optional[str]
	healthcare_slot_read: Optional[str]
	healthcare_slot_write: Optional[str]
	healthcare_encounter_read: Optional[str]
	healthcare_encounter_write: Optional[str]
	healthcare_condition_read: Optional[str]
	healthcare_condition_write: Optional[str]
	healthcare_allergy_read: Optional[str]
	healthcare_allergy_write: Optional[str]
	healthcare_medication_read: Optional[str]
	healthcare_medication_write: Optional[str]
	healthcare_observation_read: Optional[str]
	healthcare_observation_write: Optional[str]
	healthcare_immunization_read: Optional[str]
	healthcare_immunization_write: Optional[str]
	healthcare_document_read: Optional[str]
	healthcare_document_write: Optional[str]
	healthcare_coverage_read: Optional[str]
	healthcare_coverage_write: Optional[str]
	healthcare_procedure_read: Optional[str]
	healthcare_procedure_write: Optional[str]
	healthcare_report_read: Optional[str]
	healthcare_report_write: Optional[str]
	healthcare_careplan_read: Optional[str]
	healthcare_careplan_write: Optional[str]
	healthcare_goal_read: Optional[str]
	healthcare_goal_write: Optional[str]
	property_listing_read: Optional[str]
	property_listing_write: Optional[str]
	property_unittype_read: Optional[str]
	property_guest_read: Optional[str]
	property_guest_write: Optional[str]
	property_reservation_read: Optional[str]
	property_reservation_write: Optional[str]
	property_availability_read: Optional[str]
	property_quote_read: Optional[str]
	property_quote_write: Optional[str]
	property_review_read: Optional[str]
	property_review_write: Optional[str]
	property_conversation_read: Optional[str]
	property_conversation_write: Optional[str]
	plm_part_read: Optional[str]
	plm_part_write: Optional[str]
	plm_bomline_read: Optional[str]
	plm_bomline_write: Optional[str]
	plm_document_read: Optional[str]
	plm_document_write: Optional[str]
	plm_change_read: Optional[str]
	plm_change_write: Optional[str]
	plm_category_read: Optional[str]
	plm_category_write: Optional[str]

@dataclasses.dataclass
class PropertyWorkspaceIntegrationAuth:
	client_id: Optional[str]
	client_secret: Optional[str]
	consumer_key: Optional[str]
	consumer_secret: Optional[str]
	"""the PEM X.509 certificate in Base64 ASCII format"""
	pem: Optional[str]
	"""the private KEY X.509 certificate in Base64 ASCII format"""
	key: Optional[str]
	dev_api_key: Optional[str]
	"""the SAML IdP SSO/login URL for end-user SAML login"""
	saml_idp_url: Optional[str]
	"""the SAML IdP issuer/entity ID"""
	saml_idp_entity_id: Optional[str]
	"""the SAML IdP signing certificate; PEM X.509 in Base64 ASCII format"""
	saml_pem: Optional[str]
	"""opt-in PKCE for OAuth2 when the integration app or org requires it"""
	needs_pkce: Optional[bool]

@dataclasses.dataclass
class WorkspaceIntegration:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""(reference to KmsSpace)"""
	workspace_id: Optional[str]
	integration_type: str
	is_active: bool
	api_url: Optional[str]
	authorize_url: Optional[str]
	token_url: Optional[str]
	refresh_url: Optional[str]
	base_url: Optional[str]
	prompt_region: Optional[bool]
	use_unified_redirect: Optional[bool]
	"""the authentication method to use for this workspace integration; when set, it overrides the default auth-method selection (e.g. force 'token' even when Unified OAUTH credentials exist)"""
	auth_type: Optional[WorkspaceIntegrationAuth_type]
	"""authentication environment"""
	environment: Optional[str]
	"""derived from `permissions` (plus the auth, passthrough and saml categories, which have no permissions)"""
	categories: Optional[List[WorkspaceIntegrationCategories]]
	"""the unified permission scopes enabled for this integration; requested when an authorization URL omits `scopes`"""
	permissions: Optional[List[WorkspaceIntegrationPermissions]]
	overriden_scopes: Optional[PropertyWorkspaceIntegrationOverriden_scopes]
	"""Post-OAuth success URL for marketplace installs (e.g. HighLevel). Used by `/oauth/code/{workspace}/{env}/{integration}`."""
	success_redirect: Optional[str]
	"""Post-OAuth failure URL for marketplace installs. Used by `/oauth/code/{workspace}/{env}/{integration}`."""
	failure_redirect: Optional[str]
	auth: Optional[PropertyWorkspaceIntegrationAuth]
	"""the ID of the SecretsManager object"""
	secretsmanager_id: Optional[str]
	"""the key/path/name of the secret within the vault"""
	secretsmanager_key: Optional[str]
Are we missing anything? Let us know
Was this page helpful?