@epilot/sdk 2.1.0 → 2.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +24 -0
- package/definitions/environments-runtime.json +1 -1
- package/dist/{README-W4B35MRN.cjs → README-6OOYWQYJ.cjs} +1 -1
- package/dist/{README-VG67PX4R.js → README-JUWX7KNV.js} +1 -1
- package/dist/{_index-S6LFD3ER.js → _index-NWNYWBIF.js} +48 -1
- package/dist/{_index-AMVZBT2K.cjs → _index-ONGE545F.cjs} +48 -1
- package/dist/access-token-2O6ULCCN.js +633 -0
- package/dist/access-token-RKP2A2F7.cjs +633 -0
- package/dist/access-token-runtime-KCKGT4O7.js +5 -0
- package/dist/access-token-runtime-NZWZJPWV.cjs +5 -0
- package/dist/address-HLBX47SQ.cjs +567 -0
- package/dist/address-IJF4N2UV.js +567 -0
- package/dist/address-runtime-2MNO2YRD.cjs +5 -0
- package/dist/address-runtime-YFCNBJBW.js +5 -0
- package/dist/address-suggestions-BYUTV7OU.js +574 -0
- package/dist/address-suggestions-ERVGGO6Z.cjs +574 -0
- package/dist/address-suggestions-runtime-NIMC2J32.js +5 -0
- package/dist/address-suggestions-runtime-ZNGLDADE.cjs +5 -0
- package/dist/ai-agents-6VHVYRCC.cjs +1612 -0
- package/dist/ai-agents-PKCHKKJS.js +1612 -0
- package/dist/ai-agents-runtime-25YRUJHI.js +5 -0
- package/dist/ai-agents-runtime-TILIO3UM.cjs +5 -0
- package/dist/apis/access-token.cjs +8 -8
- package/dist/apis/access-token.d.cts +2 -2
- package/dist/apis/access-token.d.ts +2 -2
- package/dist/apis/access-token.js +4 -4
- package/dist/apis/address-suggestions.cjs +8 -8
- package/dist/apis/address-suggestions.d.cts +2 -2
- package/dist/apis/address-suggestions.d.ts +2 -2
- package/dist/apis/address-suggestions.js +4 -4
- package/dist/apis/address.cjs +8 -8
- package/dist/apis/address.d.cts +2 -2
- package/dist/apis/address.d.ts +2 -2
- package/dist/apis/address.js +4 -4
- package/dist/apis/ai-agents.cjs +8 -8
- package/dist/apis/ai-agents.d.cts +2 -2
- package/dist/apis/ai-agents.d.ts +2 -2
- package/dist/apis/ai-agents.js +4 -4
- package/dist/apis/app.cjs +8 -8
- package/dist/apis/app.d.cts +2 -2
- package/dist/apis/app.d.ts +2 -2
- package/dist/apis/app.js +4 -4
- package/dist/apis/audit-logs.cjs +8 -8
- package/dist/apis/audit-logs.d.cts +2 -2
- package/dist/apis/audit-logs.d.ts +2 -2
- package/dist/apis/audit-logs.js +4 -4
- package/dist/apis/automation.cjs +8 -8
- package/dist/apis/automation.d.cts +2 -2
- package/dist/apis/automation.d.ts +2 -2
- package/dist/apis/automation.js +4 -4
- package/dist/apis/billing.cjs +8 -8
- package/dist/apis/billing.d.cts +2 -2
- package/dist/apis/billing.d.ts +2 -2
- package/dist/apis/billing.js +4 -4
- package/dist/apis/blueprint-manifest.cjs +8 -8
- package/dist/apis/blueprint-manifest.d.cts +2 -2
- package/dist/apis/blueprint-manifest.d.ts +2 -2
- package/dist/apis/blueprint-manifest.js +4 -4
- package/dist/apis/consent.cjs +8 -8
- package/dist/apis/consent.d.cts +2 -2
- package/dist/apis/consent.d.ts +2 -2
- package/dist/apis/consent.js +4 -4
- package/dist/apis/customer-portal.cjs +8 -8
- package/dist/apis/customer-portal.d.cts +2 -2
- package/dist/apis/customer-portal.d.ts +2 -2
- package/dist/apis/customer-portal.js +4 -4
- package/dist/apis/dashboard.cjs +8 -8
- package/dist/apis/dashboard.d.cts +2 -2
- package/dist/apis/dashboard.d.ts +2 -2
- package/dist/apis/dashboard.js +4 -4
- package/dist/apis/data-management.cjs +8 -8
- package/dist/apis/data-management.d.cts +2 -2
- package/dist/apis/data-management.d.ts +2 -2
- package/dist/apis/data-management.js +4 -4
- package/dist/apis/deduplication.cjs +8 -8
- package/dist/apis/deduplication.d.cts +2 -2
- package/dist/apis/deduplication.d.ts +2 -2
- package/dist/apis/deduplication.js +4 -4
- package/dist/apis/design.cjs +8 -8
- package/dist/apis/design.d.cts +2 -2
- package/dist/apis/design.d.ts +2 -2
- package/dist/apis/design.js +4 -4
- package/dist/apis/document.cjs +8 -8
- package/dist/apis/document.d.cts +2 -2
- package/dist/apis/document.d.ts +2 -2
- package/dist/apis/document.js +4 -4
- package/dist/apis/email-settings.cjs +8 -8
- package/dist/apis/email-settings.d.cts +2 -2
- package/dist/apis/email-settings.d.ts +2 -2
- package/dist/apis/email-settings.js +4 -4
- package/dist/apis/email-template.cjs +8 -8
- package/dist/apis/email-template.d.cts +2 -2
- package/dist/apis/email-template.d.ts +2 -2
- package/dist/apis/email-template.js +4 -4
- package/dist/apis/entity-mapping.cjs +8 -8
- package/dist/apis/entity-mapping.d.cts +2 -2
- package/dist/apis/entity-mapping.d.ts +2 -2
- package/dist/apis/entity-mapping.js +4 -4
- package/dist/apis/entity.cjs +8 -8
- package/dist/apis/entity.d.cts +2 -2
- package/dist/apis/entity.d.ts +2 -2
- package/dist/apis/entity.js +4 -4
- package/dist/apis/environments.cjs +8 -8
- package/dist/apis/environments.d.cts +2 -2
- package/dist/apis/environments.d.ts +2 -2
- package/dist/apis/environments.js +4 -4
- package/dist/apis/erp-integration.cjs +8 -8
- package/dist/apis/erp-integration.d.cts +2 -2
- package/dist/apis/erp-integration.d.ts +2 -2
- package/dist/apis/erp-integration.js +4 -4
- package/dist/apis/event-catalog.cjs +8 -8
- package/dist/apis/event-catalog.d.cts +2 -2
- package/dist/apis/event-catalog.d.ts +2 -2
- package/dist/apis/event-catalog.js +4 -4
- package/dist/apis/file.cjs +8 -8
- package/dist/apis/file.d.cts +2 -2
- package/dist/apis/file.d.ts +2 -2
- package/dist/apis/file.js +4 -4
- package/dist/apis/iban.cjs +8 -8
- package/dist/apis/iban.d.cts +2 -2
- package/dist/apis/iban.d.ts +2 -2
- package/dist/apis/iban.js +4 -4
- package/dist/apis/journey.cjs +8 -8
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +4 -4
- package/dist/apis/kanban.cjs +8 -8
- package/dist/apis/kanban.d.cts +2 -2
- package/dist/apis/kanban.d.ts +2 -2
- package/dist/apis/kanban.js +4 -4
- package/dist/apis/message.cjs +8 -8
- package/dist/apis/message.d.cts +2 -2
- package/dist/apis/message.d.ts +2 -2
- package/dist/apis/message.js +4 -4
- package/dist/apis/metering.cjs +8 -8
- package/dist/apis/metering.d.cts +2 -2
- package/dist/apis/metering.d.ts +2 -2
- package/dist/apis/metering.js +4 -4
- package/dist/apis/notes.cjs +8 -8
- package/dist/apis/notes.d.cts +2 -2
- package/dist/apis/notes.d.ts +2 -2
- package/dist/apis/notes.js +4 -4
- package/dist/apis/notification.cjs +8 -8
- package/dist/apis/notification.d.cts +2 -2
- package/dist/apis/notification.d.ts +2 -2
- package/dist/apis/notification.js +4 -4
- package/dist/apis/organization.cjs +8 -8
- package/dist/apis/organization.d.cts +2 -2
- package/dist/apis/organization.d.ts +2 -2
- package/dist/apis/organization.js +4 -4
- package/dist/apis/partner-directory.cjs +8 -8
- package/dist/apis/partner-directory.d.cts +2 -2
- package/dist/apis/partner-directory.d.ts +2 -2
- package/dist/apis/partner-directory.js +4 -4
- package/dist/apis/permissions.cjs +8 -8
- package/dist/apis/permissions.d.cts +2 -2
- package/dist/apis/permissions.d.ts +2 -2
- package/dist/apis/permissions.js +4 -4
- package/dist/apis/pricing-tier.cjs +8 -8
- package/dist/apis/pricing-tier.d.cts +2 -2
- package/dist/apis/pricing-tier.d.ts +2 -2
- package/dist/apis/pricing-tier.js +4 -4
- package/dist/apis/pricing.cjs +8 -8
- package/dist/apis/pricing.d.cts +2 -2
- package/dist/apis/pricing.d.ts +2 -2
- package/dist/apis/pricing.js +4 -4
- package/dist/apis/purpose.cjs +8 -8
- package/dist/apis/purpose.d.cts +2 -2
- package/dist/apis/purpose.d.ts +2 -2
- package/dist/apis/purpose.js +4 -4
- package/dist/apis/sandbox.cjs +8 -8
- package/dist/apis/sandbox.d.cts +2 -2
- package/dist/apis/sandbox.d.ts +2 -2
- package/dist/apis/sandbox.js +4 -4
- package/dist/apis/submission.cjs +8 -8
- package/dist/apis/submission.d.cts +2 -2
- package/dist/apis/submission.d.ts +2 -2
- package/dist/apis/submission.js +4 -4
- package/dist/apis/targeting.cjs +8 -8
- package/dist/apis/targeting.d.cts +2 -2
- package/dist/apis/targeting.d.ts +2 -2
- package/dist/apis/targeting.js +4 -4
- package/dist/apis/template-variables.cjs +8 -8
- package/dist/apis/template-variables.d.cts +2 -2
- package/dist/apis/template-variables.d.ts +2 -2
- package/dist/apis/template-variables.js +4 -4
- package/dist/apis/user.cjs +8 -8
- package/dist/apis/user.d.cts +2 -2
- package/dist/apis/user.d.ts +2 -2
- package/dist/apis/user.js +4 -4
- package/dist/apis/validation-rules.cjs +8 -8
- package/dist/apis/validation-rules.d.cts +2 -2
- package/dist/apis/validation-rules.d.ts +2 -2
- package/dist/apis/validation-rules.js +4 -4
- package/dist/apis/webhooks.cjs +8 -8
- package/dist/apis/webhooks.d.cts +2 -2
- package/dist/apis/webhooks.d.ts +2 -2
- package/dist/apis/webhooks.js +4 -4
- package/dist/apis/workflow-definition.cjs +8 -8
- package/dist/apis/workflow-definition.d.cts +2 -2
- package/dist/apis/workflow-definition.d.ts +2 -2
- package/dist/apis/workflow-definition.js +4 -4
- package/dist/apis/workflow.cjs +8 -8
- package/dist/apis/workflow.d.cts +2 -2
- package/dist/apis/workflow.d.ts +2 -2
- package/dist/apis/workflow.js +4 -4
- package/dist/app-5VPBDFW2.cjs +4047 -0
- package/dist/app-VJW2KKWE.js +4047 -0
- package/dist/app-runtime-SSNHSBR7.cjs +5 -0
- package/dist/app-runtime-U7RGV7KT.js +5 -0
- package/dist/audit-logs-F2NHDISQ.js +312 -0
- package/dist/audit-logs-RFEMBILB.cjs +312 -0
- package/dist/audit-logs-runtime-4WMHPWNX.cjs +5 -0
- package/dist/audit-logs-runtime-76R6WRAB.js +5 -0
- package/dist/automation-HZASSUCS.cjs +4460 -0
- package/dist/automation-WEVRW77F.js +4460 -0
- package/dist/automation-runtime-L5UKEFLA.js +5 -0
- package/dist/automation-runtime-YBGGE5PL.cjs +5 -0
- package/dist/billing-3VZPNG6M.cjs +796 -0
- package/dist/billing-ASWY7HC3.js +796 -0
- package/dist/billing-runtime-C6BMGWCX.js +5 -0
- package/dist/billing-runtime-L4Y7MLM3.cjs +5 -0
- package/dist/blueprint-manifest-5TNVSDKC.cjs +3169 -0
- package/dist/blueprint-manifest-UGGYWGRZ.js +3169 -0
- package/dist/blueprint-manifest-runtime-2RTW5C52.js +5 -0
- package/dist/blueprint-manifest-runtime-AF3FIDVX.cjs +5 -0
- package/dist/chunk-NBYH536J.js +291 -0
- package/dist/chunk-WSZWUQDD.cjs +291 -0
- package/dist/consent-6SIH4NQS.cjs +342 -0
- package/dist/consent-7MNRAINV.js +342 -0
- package/dist/consent-runtime-KZ5D4XZU.cjs +5 -0
- package/dist/consent-runtime-OAPXBJH2.js +5 -0
- package/dist/customer-portal-L5DEQEGC.js +14142 -0
- package/dist/customer-portal-MXILX4KH.cjs +14142 -0
- package/dist/customer-portal-runtime-MRVZ7JR4.js +5 -0
- package/dist/customer-portal-runtime-VGK7RMLC.cjs +5 -0
- package/dist/dashboard-RKUQLIME.cjs +483 -0
- package/dist/dashboard-UDL26RGG.js +483 -0
- package/dist/dashboard-runtime-EXP2AM44.cjs +5 -0
- package/dist/dashboard-runtime-PSKSGLCF.js +5 -0
- package/dist/data-management-W5JQGGGH.js +925 -0
- package/dist/data-management-XFSRLFYA.cjs +925 -0
- package/dist/data-management-runtime-PAC7UFGT.cjs +5 -0
- package/dist/data-management-runtime-XZ347IUB.js +5 -0
- package/dist/deduplication-7RTGTLN5.cjs +193 -0
- package/dist/deduplication-RKLRTNZU.js +193 -0
- package/dist/deduplication-runtime-BBHG7MJW.cjs +5 -0
- package/dist/deduplication-runtime-DLGBF4RN.js +5 -0
- package/dist/design-AO6EGLHD.cjs +1352 -0
- package/dist/design-VLRA2WGV.js +1352 -0
- package/dist/design-runtime-3SKJA7QH.js +5 -0
- package/dist/design-runtime-Y3VGTQLP.cjs +5 -0
- package/dist/document-OVTR7RVH.cjs +744 -0
- package/dist/document-SEZ45XAO.js +744 -0
- package/dist/document-runtime-GFEBGNMS.js +5 -0
- package/dist/document-runtime-RG3F4R6O.cjs +5 -0
- package/dist/email-settings-QGCIUWLC.js +2427 -0
- package/dist/email-settings-SEGEKVMF.cjs +2427 -0
- package/dist/email-settings-runtime-NS7MU3RB.cjs +5 -0
- package/dist/email-settings-runtime-X7F3EPAB.js +5 -0
- package/dist/email-template-26SANLRD.cjs +1308 -0
- package/dist/email-template-346NDG4D.js +1308 -0
- package/dist/email-template-runtime-QBB64BJQ.js +5 -0
- package/dist/email-template-runtime-UI2FS4H5.cjs +5 -0
- package/dist/entity-HSCBRIOS.js +9411 -0
- package/dist/entity-UKAWTND4.cjs +9411 -0
- package/dist/entity-mapping-PK2XAARN.cjs +1506 -0
- package/dist/entity-mapping-UOGYYCZH.js +1506 -0
- package/dist/entity-mapping-runtime-734TTUA2.cjs +5 -0
- package/dist/entity-mapping-runtime-HCOJM6DV.js +5 -0
- package/dist/entity-runtime-QSFVEFJ6.js +5 -0
- package/dist/entity-runtime-XSAICIVR.cjs +5 -0
- package/dist/environments-5IS2ZJYQ.cjs +352 -0
- package/dist/environments-VCREW73K.js +352 -0
- package/dist/environments-runtime-BPR47PW7.js +5 -0
- package/dist/environments-runtime-L6TJCVW6.cjs +5 -0
- package/dist/erp-integration-735KQ73W.js +5295 -0
- package/dist/erp-integration-W7FZDJOB.cjs +5295 -0
- package/dist/erp-integration-runtime-FNJXDO75.js +5 -0
- package/dist/erp-integration-runtime-WXZIQCLJ.cjs +5 -0
- package/dist/event-catalog-MZYFJ23V.cjs +965 -0
- package/dist/event-catalog-ZUFXLY7B.js +965 -0
- package/dist/event-catalog-runtime-5HQSAJVX.cjs +5 -0
- package/dist/event-catalog-runtime-6FA3SCRI.js +5 -0
- package/dist/file-637CTR4Y.cjs +2744 -0
- package/dist/file-EJJBQEQI.js +2744 -0
- package/dist/file-runtime-B6AAGZQF.js +5 -0
- package/dist/file-runtime-SFZIKODF.cjs +5 -0
- package/dist/iban-ETTCKOHK.cjs +148 -0
- package/dist/iban-HXFDAF4I.js +148 -0
- package/dist/iban-runtime-EVXLFPPP.js +5 -0
- package/dist/iban-runtime-TUM5LVHO.cjs +5 -0
- package/dist/index.cjs +105 -100
- package/dist/index.d.cts +20 -4
- package/dist/index.d.ts +20 -4
- package/dist/index.js +56 -51
- package/dist/journey-KW3ZFQAL.js +2194 -0
- package/dist/journey-XIMSLSZC.cjs +2194 -0
- package/dist/journey-runtime-SPBL3F32.cjs +5 -0
- package/dist/journey-runtime-YXIAOTMD.js +5 -0
- package/dist/kanban-M4P7R5TM.cjs +890 -0
- package/dist/kanban-QXQEQIF4.js +890 -0
- package/dist/kanban-runtime-NHEUWTCG.cjs +5 -0
- package/dist/kanban-runtime-R6EWHBFS.js +5 -0
- package/dist/message-2VOVRXBB.cjs +2447 -0
- package/dist/message-M62W3KP2.js +2447 -0
- package/dist/message-runtime-ITR7MPKT.cjs +5 -0
- package/dist/message-runtime-YMKW2N3R.js +5 -0
- package/dist/metering-KEMILE75.cjs +2198 -0
- package/dist/metering-W3TA6ZUQ.js +2198 -0
- package/dist/metering-runtime-HAIWXZXJ.cjs +5 -0
- package/dist/metering-runtime-NJ6NEUMB.js +5 -0
- package/dist/notes-4LVCGLBE.js +1427 -0
- package/dist/notes-OBM5POWI.cjs +1427 -0
- package/dist/notes-runtime-CVNAVKPP.js +5 -0
- package/dist/notes-runtime-E3YYF74V.cjs +5 -0
- package/dist/notification-EEYPLPUV.cjs +1381 -0
- package/dist/notification-MJQGIBM7.js +1381 -0
- package/dist/notification-runtime-7QLZTPHG.cjs +5 -0
- package/dist/notification-runtime-KREP32YP.js +5 -0
- package/dist/organization-2UK7QZLQ.cjs +615 -0
- package/dist/organization-U5HPX627.js +615 -0
- package/dist/organization-runtime-LBCVCZ3W.cjs +5 -0
- package/dist/organization-runtime-P3WZ2BBU.js +5 -0
- package/dist/partner-directory-CG5CYJGB.cjs +1600 -0
- package/dist/partner-directory-XJ7KI7EX.js +1600 -0
- package/dist/partner-directory-runtime-QURDOO4Z.js +5 -0
- package/dist/partner-directory-runtime-RSONSDNJ.cjs +5 -0
- package/dist/permissions-SGPGANEP.js +1415 -0
- package/dist/permissions-WCOABHKQ.cjs +1415 -0
- package/dist/permissions-runtime-D74HOCVO.js +5 -0
- package/dist/permissions-runtime-O5LH7WOU.cjs +5 -0
- package/dist/pricing-3RNPCUR6.js +9362 -0
- package/dist/pricing-VYHPSVKM.cjs +9362 -0
- package/dist/pricing-runtime-6XNS4EOF.cjs +5 -0
- package/dist/pricing-runtime-JRR4FWFI.js +5 -0
- package/dist/pricing-tier-36WV4P4X.js +121 -0
- package/dist/pricing-tier-FKQPW2ND.cjs +121 -0
- package/dist/pricing-tier-runtime-32BCKJ7Y.cjs +5 -0
- package/dist/pricing-tier-runtime-LEGBNNLA.js +5 -0
- package/dist/purpose-JC2E7W3M.cjs +523 -0
- package/dist/purpose-QFQ4W255.js +523 -0
- package/dist/purpose-runtime-C6IGTUA6.cjs +5 -0
- package/dist/purpose-runtime-V5X5ESZV.js +5 -0
- package/dist/sandbox-CLZTN7IW.cjs +445 -0
- package/dist/sandbox-O2NWMZGJ.js +445 -0
- package/dist/sandbox-runtime-4MLOMFPK.js +5 -0
- package/dist/sandbox-runtime-GKEK3GQB.cjs +5 -0
- package/dist/submission-6FD67HIE.cjs +308 -0
- package/dist/submission-MWJU4L32.js +308 -0
- package/dist/submission-runtime-5FD4AQSD.cjs +5 -0
- package/dist/submission-runtime-JPHKPQ77.js +5 -0
- package/dist/targeting-4CQDSEKL.cjs +1369 -0
- package/dist/targeting-RB7LBQMX.js +1369 -0
- package/dist/targeting-runtime-6JFMP262.cjs +5 -0
- package/dist/targeting-runtime-M2VSTKFT.js +5 -0
- package/dist/template-variables-JYHE2VCH.cjs +1447 -0
- package/dist/template-variables-XLIW4GY6.js +1447 -0
- package/dist/template-variables-runtime-62U3ZY5P.js +5 -0
- package/dist/template-variables-runtime-LFOA32UM.cjs +5 -0
- package/dist/{types-BwBvJkY_.d.ts → types-ChU9Acbv.d.cts} +3 -0
- package/dist/{types-BwBvJkY_.d.cts → types-ChU9Acbv.d.ts} +3 -0
- package/dist/user-DKA6DDPX.cjs +2265 -0
- package/dist/user-O4JDAIRO.js +2265 -0
- package/dist/user-runtime-7O2HLFVQ.cjs +5 -0
- package/dist/user-runtime-U4HYUWJU.js +5 -0
- package/dist/validation-rules-AYCAOVDZ.cjs +1344 -0
- package/dist/validation-rules-GCI64B57.js +1344 -0
- package/dist/validation-rules-runtime-6MRCS5X2.js +5 -0
- package/dist/validation-rules-runtime-X7M3QE5I.cjs +5 -0
- package/dist/webhooks-L3FXPRKT.cjs +1431 -0
- package/dist/webhooks-XXLU2KWP.js +1431 -0
- package/dist/webhooks-runtime-EBM4M3SU.cjs +5 -0
- package/dist/webhooks-runtime-XCQYIGQK.js +5 -0
- package/dist/workflow-VLNZNE3S.js +3834 -0
- package/dist/workflow-YJHUCGVK.cjs +3834 -0
- package/dist/workflow-definition-7BA4H6W3.cjs +3100 -0
- package/dist/workflow-definition-VFYWBQQ3.js +3100 -0
- package/dist/workflow-definition-runtime-S7AZHOU7.js +5 -0
- package/dist/workflow-definition-runtime-VRND6VQR.cjs +5 -0
- package/dist/workflow-runtime-RLZO2OQB.js +5 -0
- package/dist/workflow-runtime-WCJ7NRTH.cjs +5 -0
- package/package.json +3 -2
- package/dist/chunk-3XEP56SV.cjs +0 -204
- package/dist/chunk-ULBEEHG4.js +0 -204
- /package/dist/{chunk-CPKBR34V.js → chunk-24T6CJTG.js} +0 -0
- /package/dist/{chunk-VQ7R36AC.js → chunk-265TE2OV.js} +0 -0
- /package/dist/{chunk-ZV6XYUXS.js → chunk-2BPBDRRO.js} +0 -0
- /package/dist/{chunk-KSXTBGIV.js → chunk-3XKBB5AE.js} +0 -0
- /package/dist/{chunk-GLO477NZ.js → chunk-3YSEO476.js} +0 -0
- /package/dist/{chunk-MKX4CKAB.cjs → chunk-46HU6232.cjs} +0 -0
- /package/dist/{chunk-JXBXDTFG.cjs → chunk-4G6LO3JY.cjs} +0 -0
- /package/dist/{chunk-Z4LUE424.cjs → chunk-4QCVVDTA.cjs} +0 -0
- /package/dist/{chunk-LQOLYXGQ.cjs → chunk-4W22EIRF.cjs} +0 -0
- /package/dist/{chunk-372VUPHN.js → chunk-4ZGZDE6D.js} +0 -0
- /package/dist/{chunk-IMT3IE5M.cjs → chunk-4ZMLRFDX.cjs} +0 -0
- /package/dist/{chunk-S7NDMDRX.js → chunk-5JPM6YUD.js} +0 -0
- /package/dist/{chunk-IS2VB342.js → chunk-5MFHAXBT.js} +0 -0
- /package/dist/{chunk-WOXXNKTE.js → chunk-5NKXJA43.js} +0 -0
- /package/dist/{chunk-S3ZNESMC.cjs → chunk-5WNEYQII.cjs} +0 -0
- /package/dist/{chunk-KA3TGFJP.js → chunk-6OYECNL2.js} +0 -0
- /package/dist/{chunk-T46LODOF.js → chunk-6UAS2VVG.js} +0 -0
- /package/dist/{chunk-PETLAONH.js → chunk-6VWCUZ5M.js} +0 -0
- /package/dist/{chunk-YZA5WZUS.js → chunk-75EI2Q64.js} +0 -0
- /package/dist/{chunk-2HOJWFQ4.js → chunk-75ZWZM3L.js} +0 -0
- /package/dist/{chunk-57QIBYDN.js → chunk-7IKQIVUS.js} +0 -0
- /package/dist/{chunk-DJKSULPK.js → chunk-A7AAVJGM.js} +0 -0
- /package/dist/{chunk-QLML3IP5.cjs → chunk-ANN2QTMY.cjs} +0 -0
- /package/dist/{chunk-KPGC2D6E.js → chunk-AUH6NP6Y.js} +0 -0
- /package/dist/{chunk-A6JOROUC.cjs → chunk-BLNXQAMX.cjs} +0 -0
- /package/dist/{chunk-LCIJ4TJ4.cjs → chunk-BM6NCHPL.cjs} +0 -0
- /package/dist/{chunk-XR4QF6KQ.cjs → chunk-BPHOGIQM.cjs} +0 -0
- /package/dist/{chunk-K62XK7KU.js → chunk-BTTPWE2P.js} +0 -0
- /package/dist/{chunk-E26ZO7QM.cjs → chunk-COQMJFAB.cjs} +0 -0
- /package/dist/{chunk-QVAJ5JP4.js → chunk-CSK5ZUTS.js} +0 -0
- /package/dist/{chunk-3ZZ57K3S.cjs → chunk-D32L2HMX.cjs} +0 -0
- /package/dist/{chunk-TIJWJVKZ.js → chunk-D7Q4JGN7.js} +0 -0
- /package/dist/{chunk-CWSHYFVZ.js → chunk-DZ3P537S.js} +0 -0
- /package/dist/{chunk-MSASBR2Y.js → chunk-E2WMGOM5.js} +0 -0
- /package/dist/{chunk-RXSS67VI.cjs → chunk-F5JVW2D5.cjs} +0 -0
- /package/dist/{chunk-XKI2OAYV.cjs → chunk-FARDEGPH.cjs} +0 -0
- /package/dist/{chunk-RWSA3LXE.cjs → chunk-G3VDRMOH.cjs} +0 -0
- /package/dist/{chunk-QDVPPRWI.cjs → chunk-G5FKTWUC.cjs} +0 -0
- /package/dist/{chunk-WMTYO5OX.cjs → chunk-GWKHOJGD.cjs} +0 -0
- /package/dist/{chunk-DNJ54L2G.js → chunk-H45V55VT.js} +0 -0
- /package/dist/{chunk-F472YLJG.cjs → chunk-HAZ3WP7V.cjs} +0 -0
- /package/dist/{chunk-NAWLLC3T.cjs → chunk-HHMXS5NC.cjs} +0 -0
- /package/dist/{chunk-DY2D2IW5.cjs → chunk-IGVVJMX7.cjs} +0 -0
- /package/dist/{chunk-KBOVBUBM.js → chunk-IJR3GZKC.js} +0 -0
- /package/dist/{chunk-73H6TVKN.js → chunk-IQOCHPWU.js} +0 -0
- /package/dist/{chunk-LSIWCIQV.js → chunk-JENQHXFI.js} +0 -0
- /package/dist/{chunk-G2REP2VZ.cjs → chunk-JICWF5VI.cjs} +0 -0
- /package/dist/{chunk-3HJEWWPS.cjs → chunk-JIUTCNTB.cjs} +0 -0
- /package/dist/{chunk-EBCHCYUO.js → chunk-JJWJLY42.js} +0 -0
- /package/dist/{chunk-SMGHAG5C.cjs → chunk-JXJC6WEW.cjs} +0 -0
- /package/dist/{chunk-HPYHWTTA.cjs → chunk-K2UZPY6U.cjs} +0 -0
- /package/dist/{chunk-VGTUK3QD.cjs → chunk-L66IX6GX.cjs} +0 -0
- /package/dist/{chunk-NLSZVGHK.cjs → chunk-LKRBFBFN.cjs} +0 -0
- /package/dist/{chunk-TLWCYLNA.js → chunk-LLZYRINH.js} +0 -0
- /package/dist/{chunk-4SWC43JO.cjs → chunk-M2SSGV7K.cjs} +0 -0
- /package/dist/{chunk-PVSS2WPM.cjs → chunk-M2UDF7PY.cjs} +0 -0
- /package/dist/{chunk-5SNJAD6F.cjs → chunk-M56QQHVA.cjs} +0 -0
- /package/dist/{chunk-QKERXNJJ.cjs → chunk-MB6NKETA.cjs} +0 -0
- /package/dist/{chunk-H4VSK4KF.js → chunk-MEUS7LCE.js} +0 -0
- /package/dist/{chunk-RD7E4OSJ.cjs → chunk-N5NFJW7Y.cjs} +0 -0
- /package/dist/{chunk-FXOX3X7E.cjs → chunk-NEVFKRDU.cjs} +0 -0
- /package/dist/{chunk-O4LRVGOY.js → chunk-O4JDWMYD.js} +0 -0
- /package/dist/{chunk-IH4CMOML.js → chunk-OEBV2PMV.js} +0 -0
- /package/dist/{chunk-VVVATFGK.cjs → chunk-OXJOO2YF.cjs} +0 -0
- /package/dist/{chunk-WOSSSFXB.js → chunk-PSQMDY3B.js} +0 -0
- /package/dist/{chunk-AJKH25H2.cjs → chunk-QOAWSFXA.cjs} +0 -0
- /package/dist/{chunk-UKKJMCNH.js → chunk-QT44OHHL.js} +0 -0
- /package/dist/{chunk-B3ZGAG7B.js → chunk-QTR3RH4N.js} +0 -0
- /package/dist/{chunk-3N67SSL3.js → chunk-RELUU5QZ.js} +0 -0
- /package/dist/{chunk-YYBIU5BQ.js → chunk-RJ3DWFSK.js} +0 -0
- /package/dist/{chunk-ARWMTXJV.cjs → chunk-RUZRPIHW.cjs} +0 -0
- /package/dist/{chunk-4VFQTSJQ.js → chunk-RW5JOHG7.js} +0 -0
- /package/dist/{chunk-EPAIOB5U.cjs → chunk-RXMOHUBP.cjs} +0 -0
- /package/dist/{chunk-MRZ7LGKZ.js → chunk-SBSIGQDU.js} +0 -0
- /package/dist/{chunk-TRJLYZHD.js → chunk-SITPUXIR.js} +0 -0
- /package/dist/{chunk-OGQKJTXF.js → chunk-SZMCMLOQ.js} +0 -0
- /package/dist/{chunk-VVQB5W7U.cjs → chunk-T67ZXTVG.cjs} +0 -0
- /package/dist/{chunk-HPSGM6QP.js → chunk-TME4YJNP.js} +0 -0
- /package/dist/{chunk-MRTAFRO7.js → chunk-TPA4HEAO.js} +0 -0
- /package/dist/{chunk-F376L6PP.cjs → chunk-TTNPMFXL.cjs} +0 -0
- /package/dist/{chunk-OG2DMGU6.cjs → chunk-TXDVGTQD.cjs} +0 -0
- /package/dist/{chunk-XZYZLSUO.cjs → chunk-UNCVJH6J.cjs} +0 -0
- /package/dist/{chunk-MHNSZ4HE.js → chunk-UUVJYJHD.js} +0 -0
- /package/dist/{chunk-C6UTZEHH.js → chunk-VSZEOCIE.js} +0 -0
- /package/dist/{chunk-EQZMT2HF.cjs → chunk-WQBBB6BN.cjs} +0 -0
- /package/dist/{chunk-BH5ZXK4J.cjs → chunk-WTMV77T2.cjs} +0 -0
- /package/dist/{chunk-BWFXLUK5.cjs → chunk-WWOAKRNG.cjs} +0 -0
- /package/dist/{chunk-ITX53XAZ.js → chunk-XSE4CFSM.js} +0 -0
- /package/dist/{chunk-SK3VYIZ6.cjs → chunk-YO4M3BZL.cjs} +0 -0
- /package/dist/{chunk-XYHTQ523.cjs → chunk-Z5TVWG3I.cjs} +0 -0
- /package/dist/{chunk-PXITFTJA.cjs → chunk-ZI33AJQ5.cjs} +0 -0
- /package/dist/{chunk-IP2WWEOU.js → chunk-ZKQ573B7.js} +0 -0
|
@@ -0,0 +1,1415 @@
|
|
|
1
|
+
import "./chunk-YPSWSI3M.js";
|
|
2
|
+
|
|
3
|
+
// src/definitions/permissions.json
|
|
4
|
+
var openapi = "3.0.3";
|
|
5
|
+
var info = {
|
|
6
|
+
title: "Permissions API",
|
|
7
|
+
version: "1.2.0",
|
|
8
|
+
description: "Flexible Role-based Access Control for epilot"
|
|
9
|
+
};
|
|
10
|
+
var tags = [
|
|
11
|
+
{
|
|
12
|
+
name: "Roles",
|
|
13
|
+
description: "Manage roles and grants"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
name: "Assignments",
|
|
17
|
+
description: "Assign roles to users"
|
|
18
|
+
}
|
|
19
|
+
];
|
|
20
|
+
var security = [
|
|
21
|
+
{
|
|
22
|
+
EpilotAuth: []
|
|
23
|
+
},
|
|
24
|
+
{
|
|
25
|
+
EpilotOrg: []
|
|
26
|
+
}
|
|
27
|
+
];
|
|
28
|
+
var paths = {
|
|
29
|
+
"/v1/permissions/me": {
|
|
30
|
+
get: {
|
|
31
|
+
operationId: "listCurrentRoles",
|
|
32
|
+
summary: "listCurrentRoles",
|
|
33
|
+
description: "Returns roles and grants assigned to current user",
|
|
34
|
+
tags: ["Roles"],
|
|
35
|
+
responses: {
|
|
36
|
+
"200": {
|
|
37
|
+
description: "ok",
|
|
38
|
+
content: {
|
|
39
|
+
"application/json": {
|
|
40
|
+
schema: {
|
|
41
|
+
type: "object",
|
|
42
|
+
properties: {
|
|
43
|
+
roles: {
|
|
44
|
+
type: "array",
|
|
45
|
+
items: {
|
|
46
|
+
$ref: "#/components/schemas/Role"
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
},
|
|
57
|
+
"/v1/permissions/roles": {
|
|
58
|
+
get: {
|
|
59
|
+
operationId: "listAllRoles",
|
|
60
|
+
summary: "listAllRoles",
|
|
61
|
+
description: "Returns list of all roles in organization",
|
|
62
|
+
tags: ["Roles"],
|
|
63
|
+
responses: {
|
|
64
|
+
"200": {
|
|
65
|
+
description: "ok",
|
|
66
|
+
content: {
|
|
67
|
+
"application/json": {
|
|
68
|
+
schema: {
|
|
69
|
+
type: "object",
|
|
70
|
+
properties: {
|
|
71
|
+
roles: {
|
|
72
|
+
type: "array",
|
|
73
|
+
items: {
|
|
74
|
+
$ref: "#/components/schemas/Role"
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
post: {
|
|
85
|
+
operationId: "createRole",
|
|
86
|
+
summary: "createRole",
|
|
87
|
+
description: "Create role",
|
|
88
|
+
tags: ["Roles"],
|
|
89
|
+
requestBody: {
|
|
90
|
+
content: {
|
|
91
|
+
"application/json": {
|
|
92
|
+
schema: {
|
|
93
|
+
$ref: "#/components/schemas/CreateRolePayload"
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
},
|
|
98
|
+
responses: {
|
|
99
|
+
"200": {
|
|
100
|
+
description: "ok",
|
|
101
|
+
content: {
|
|
102
|
+
"application/json": {
|
|
103
|
+
schema: {
|
|
104
|
+
$ref: "#/components/schemas/Role"
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
"400": {
|
|
110
|
+
description: "Invalid role configuration",
|
|
111
|
+
content: {
|
|
112
|
+
"application/json": {
|
|
113
|
+
schema: {
|
|
114
|
+
$ref: "#/components/schemas/Error"
|
|
115
|
+
},
|
|
116
|
+
examples: {
|
|
117
|
+
parent_role_invalid_type: {
|
|
118
|
+
summary: "Parent role must be org_role or share_role",
|
|
119
|
+
value: {
|
|
120
|
+
message: "Parent role must be org_role or share_role, got user_role"
|
|
121
|
+
}
|
|
122
|
+
},
|
|
123
|
+
parent_role_different_org: {
|
|
124
|
+
summary: "Parent org_role must be in the same organization",
|
|
125
|
+
value: {
|
|
126
|
+
message: "Parent org_role must be in the same organization"
|
|
127
|
+
}
|
|
128
|
+
},
|
|
129
|
+
parent_role_max_hierarchy: {
|
|
130
|
+
summary: "Parent role cannot itself have a parent",
|
|
131
|
+
value: {
|
|
132
|
+
message: "Parent role cannot itself have a parent (max 2 levels of hierarchy)"
|
|
133
|
+
}
|
|
134
|
+
},
|
|
135
|
+
circular_dependency_self: {
|
|
136
|
+
summary: "Role cannot be its own parent",
|
|
137
|
+
value: {
|
|
138
|
+
message: "Role cannot be its own parent"
|
|
139
|
+
}
|
|
140
|
+
},
|
|
141
|
+
circular_dependency_detected: {
|
|
142
|
+
summary: "Circular dependency detected",
|
|
143
|
+
value: {
|
|
144
|
+
message: "Circular dependency detected: role 123:child would create a cycle"
|
|
145
|
+
}
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
},
|
|
151
|
+
"404": {
|
|
152
|
+
description: "Parent role does not exist",
|
|
153
|
+
content: {
|
|
154
|
+
"application/json": {
|
|
155
|
+
schema: {
|
|
156
|
+
$ref: "#/components/schemas/Error"
|
|
157
|
+
},
|
|
158
|
+
examples: {
|
|
159
|
+
parent_role_not_found: {
|
|
160
|
+
summary: "Parent role does not exist",
|
|
161
|
+
value: {
|
|
162
|
+
message: "Parent role 123:nonexistent does not exist"
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
}
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
},
|
|
172
|
+
"/v1/permissions/roles:search": {
|
|
173
|
+
post: {
|
|
174
|
+
operationId: "searchRoles",
|
|
175
|
+
summary: "searchRoles",
|
|
176
|
+
description: "Search Roles",
|
|
177
|
+
tags: ["Roles"],
|
|
178
|
+
requestBody: {
|
|
179
|
+
content: {
|
|
180
|
+
"application/json": {
|
|
181
|
+
schema: {
|
|
182
|
+
$ref: "#/components/schemas/RoleSearchInput"
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
responses: {
|
|
188
|
+
"200": {
|
|
189
|
+
description: "ok",
|
|
190
|
+
content: {
|
|
191
|
+
"application/json": {
|
|
192
|
+
schema: {
|
|
193
|
+
type: "object",
|
|
194
|
+
properties: {
|
|
195
|
+
hits: {
|
|
196
|
+
type: "number"
|
|
197
|
+
},
|
|
198
|
+
results: {
|
|
199
|
+
type: "array",
|
|
200
|
+
items: {
|
|
201
|
+
$ref: "#/components/schemas/Role"
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
}
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
},
|
|
212
|
+
"/v1/permissions/roles/{roleId}": {
|
|
213
|
+
get: {
|
|
214
|
+
operationId: "getRole",
|
|
215
|
+
summary: "getRole",
|
|
216
|
+
description: "Get role by id",
|
|
217
|
+
tags: ["Roles"],
|
|
218
|
+
parameters: [
|
|
219
|
+
{
|
|
220
|
+
name: "roleId",
|
|
221
|
+
in: "path",
|
|
222
|
+
required: true,
|
|
223
|
+
schema: {
|
|
224
|
+
$ref: "#/components/schemas/RoleId"
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
],
|
|
228
|
+
responses: {
|
|
229
|
+
"200": {
|
|
230
|
+
description: "ok",
|
|
231
|
+
content: {
|
|
232
|
+
"application/json": {
|
|
233
|
+
schema: {
|
|
234
|
+
$ref: "#/components/schemas/Role"
|
|
235
|
+
}
|
|
236
|
+
}
|
|
237
|
+
}
|
|
238
|
+
}
|
|
239
|
+
}
|
|
240
|
+
},
|
|
241
|
+
put: {
|
|
242
|
+
operationId: "putRole",
|
|
243
|
+
summary: "putRole",
|
|
244
|
+
description: "Create or update role",
|
|
245
|
+
tags: ["Roles"],
|
|
246
|
+
parameters: [
|
|
247
|
+
{
|
|
248
|
+
name: "roleId",
|
|
249
|
+
in: "path",
|
|
250
|
+
required: true,
|
|
251
|
+
schema: {
|
|
252
|
+
$ref: "#/components/schemas/RoleId"
|
|
253
|
+
}
|
|
254
|
+
}
|
|
255
|
+
],
|
|
256
|
+
requestBody: {
|
|
257
|
+
content: {
|
|
258
|
+
"application/json": {
|
|
259
|
+
schema: {
|
|
260
|
+
$ref: "#/components/schemas/RolePayload"
|
|
261
|
+
},
|
|
262
|
+
"x-examples": {
|
|
263
|
+
"User role: manager": {
|
|
264
|
+
description: "Example manager role",
|
|
265
|
+
value: {
|
|
266
|
+
id: "123:manager",
|
|
267
|
+
name: "Manager",
|
|
268
|
+
slug: "manager",
|
|
269
|
+
type: "user_role",
|
|
270
|
+
organization_id: "123",
|
|
271
|
+
grants: [
|
|
272
|
+
{
|
|
273
|
+
action: "entity:view",
|
|
274
|
+
resource: "*"
|
|
275
|
+
},
|
|
276
|
+
{
|
|
277
|
+
action: "entity:update",
|
|
278
|
+
resource: "*"
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
action: "user:view"
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
action: "user:invite"
|
|
285
|
+
},
|
|
286
|
+
{
|
|
287
|
+
action: "role:view"
|
|
288
|
+
},
|
|
289
|
+
{
|
|
290
|
+
action: "role:create"
|
|
291
|
+
},
|
|
292
|
+
{
|
|
293
|
+
action: "role:assign"
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
action: "entity:view",
|
|
297
|
+
resource: "file:*",
|
|
298
|
+
conditions: [
|
|
299
|
+
{
|
|
300
|
+
attribute: "_tags",
|
|
301
|
+
operation: "equals",
|
|
302
|
+
values: ["offer", "contract"]
|
|
303
|
+
}
|
|
304
|
+
]
|
|
305
|
+
},
|
|
306
|
+
{
|
|
307
|
+
action: "message:view",
|
|
308
|
+
dependencies: [
|
|
309
|
+
{
|
|
310
|
+
action: "entity:view",
|
|
311
|
+
resource: "message*"
|
|
312
|
+
},
|
|
313
|
+
{
|
|
314
|
+
action: "entity:view",
|
|
315
|
+
resource: "thread*"
|
|
316
|
+
}
|
|
317
|
+
]
|
|
318
|
+
},
|
|
319
|
+
{
|
|
320
|
+
action: "message:send",
|
|
321
|
+
dependencies: [
|
|
322
|
+
{
|
|
323
|
+
action: "entity:*",
|
|
324
|
+
resource: "message*"
|
|
325
|
+
},
|
|
326
|
+
{
|
|
327
|
+
action: "entity:*",
|
|
328
|
+
resource: "thread*"
|
|
329
|
+
}
|
|
330
|
+
]
|
|
331
|
+
},
|
|
332
|
+
{
|
|
333
|
+
action: "workflow:*"
|
|
334
|
+
}
|
|
335
|
+
]
|
|
336
|
+
}
|
|
337
|
+
},
|
|
338
|
+
"User role: employee": {
|
|
339
|
+
description: "Example employee role",
|
|
340
|
+
value: {
|
|
341
|
+
id: "123:employee",
|
|
342
|
+
name: "Employee",
|
|
343
|
+
slug: "employee",
|
|
344
|
+
type: "user_role",
|
|
345
|
+
organization_id: "123",
|
|
346
|
+
grants: [
|
|
347
|
+
{
|
|
348
|
+
action: "entity:view",
|
|
349
|
+
resource: "*"
|
|
350
|
+
},
|
|
351
|
+
{
|
|
352
|
+
action: "entity:update",
|
|
353
|
+
resource: "*"
|
|
354
|
+
},
|
|
355
|
+
{
|
|
356
|
+
action: "user:view"
|
|
357
|
+
},
|
|
358
|
+
{
|
|
359
|
+
action: "message:view",
|
|
360
|
+
dependencies: [
|
|
361
|
+
{
|
|
362
|
+
action: "entity:view",
|
|
363
|
+
resource: "message*"
|
|
364
|
+
},
|
|
365
|
+
{
|
|
366
|
+
action: "entity:view",
|
|
367
|
+
resource: "thread*"
|
|
368
|
+
}
|
|
369
|
+
]
|
|
370
|
+
},
|
|
371
|
+
{
|
|
372
|
+
action: "message:send",
|
|
373
|
+
dependencies: [
|
|
374
|
+
{
|
|
375
|
+
action: "entity:*",
|
|
376
|
+
resource: "message*"
|
|
377
|
+
},
|
|
378
|
+
{
|
|
379
|
+
action: "entity:*",
|
|
380
|
+
resource: "thread*"
|
|
381
|
+
}
|
|
382
|
+
]
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
action: "workflow:execution:*"
|
|
386
|
+
}
|
|
387
|
+
]
|
|
388
|
+
}
|
|
389
|
+
},
|
|
390
|
+
"User role: administrator": {
|
|
391
|
+
description: "Example administrator role",
|
|
392
|
+
value: {
|
|
393
|
+
id: "123:administrator",
|
|
394
|
+
name: "Administrator",
|
|
395
|
+
slug: "administrator",
|
|
396
|
+
type: "user_role",
|
|
397
|
+
organization_id: "123",
|
|
398
|
+
grants: [
|
|
399
|
+
{
|
|
400
|
+
action: "*",
|
|
401
|
+
resource: "*"
|
|
402
|
+
}
|
|
403
|
+
]
|
|
404
|
+
}
|
|
405
|
+
},
|
|
406
|
+
"Organization root role": {
|
|
407
|
+
description: "Example organization root role. Must be satisifed for all org queries.",
|
|
408
|
+
value: {
|
|
409
|
+
id: "123:root",
|
|
410
|
+
name: "Organization root role",
|
|
411
|
+
slug: "root",
|
|
412
|
+
type: "org_role",
|
|
413
|
+
organization_id: "123",
|
|
414
|
+
grants: [
|
|
415
|
+
{
|
|
416
|
+
action: "*",
|
|
417
|
+
resource: "*"
|
|
418
|
+
},
|
|
419
|
+
{
|
|
420
|
+
action: "webhook:*",
|
|
421
|
+
effect: "deny"
|
|
422
|
+
}
|
|
423
|
+
]
|
|
424
|
+
}
|
|
425
|
+
},
|
|
426
|
+
"Share role": {
|
|
427
|
+
description: "Example share role. This can be assigned to users in other organizations",
|
|
428
|
+
value: {
|
|
429
|
+
id: "123:example_share_role",
|
|
430
|
+
name: "Example opportunity share role",
|
|
431
|
+
slug: "example_share_role",
|
|
432
|
+
type: "share_role",
|
|
433
|
+
organization_id: "123",
|
|
434
|
+
grants: [
|
|
435
|
+
{
|
|
436
|
+
action: "entity:view",
|
|
437
|
+
resource: "opportunity:123456"
|
|
438
|
+
},
|
|
439
|
+
{
|
|
440
|
+
action: "entity:edit",
|
|
441
|
+
resource: "opportunity:123456"
|
|
442
|
+
},
|
|
443
|
+
{
|
|
444
|
+
action: "workflow:execution:*"
|
|
445
|
+
},
|
|
446
|
+
{
|
|
447
|
+
action: "message:*"
|
|
448
|
+
},
|
|
449
|
+
{
|
|
450
|
+
action: "entity:*",
|
|
451
|
+
resource: "message*"
|
|
452
|
+
},
|
|
453
|
+
{
|
|
454
|
+
action: "entity:*",
|
|
455
|
+
resource: "thread*"
|
|
456
|
+
}
|
|
457
|
+
]
|
|
458
|
+
}
|
|
459
|
+
},
|
|
460
|
+
"Partner role": {
|
|
461
|
+
description: "Example partner role. This can be given to a partner organization, who can then assign it to their users",
|
|
462
|
+
value: {
|
|
463
|
+
id: "123:example_partner_role",
|
|
464
|
+
name: "Example opportunity share role",
|
|
465
|
+
slug: "example_partner_role",
|
|
466
|
+
type: "partner_role",
|
|
467
|
+
organization_id: "123",
|
|
468
|
+
partner_org_id: "456",
|
|
469
|
+
grants: [
|
|
470
|
+
{
|
|
471
|
+
action: "entity:view",
|
|
472
|
+
resource: "opportunity*"
|
|
473
|
+
},
|
|
474
|
+
{
|
|
475
|
+
action: "entity:edit",
|
|
476
|
+
resource: "opportunity*"
|
|
477
|
+
},
|
|
478
|
+
{
|
|
479
|
+
action: "workflow:execution:*"
|
|
480
|
+
},
|
|
481
|
+
{
|
|
482
|
+
action: "message:*"
|
|
483
|
+
},
|
|
484
|
+
{
|
|
485
|
+
action: "entity:*",
|
|
486
|
+
resource: "message*"
|
|
487
|
+
},
|
|
488
|
+
{
|
|
489
|
+
action: "entity:*",
|
|
490
|
+
resource: "thread*"
|
|
491
|
+
}
|
|
492
|
+
]
|
|
493
|
+
}
|
|
494
|
+
},
|
|
495
|
+
"Portal role": {
|
|
496
|
+
description: "Example portal role. Implicitly used by end users of portals",
|
|
497
|
+
value: {
|
|
498
|
+
id: "123:default_end_customer_portal_role",
|
|
499
|
+
name: "Default End Customer Portal Role",
|
|
500
|
+
slug: "default_end_customer_portal_role",
|
|
501
|
+
type: "portal_role",
|
|
502
|
+
organization_id: "123",
|
|
503
|
+
grants: [
|
|
504
|
+
{
|
|
505
|
+
action: "entity:attribute:view",
|
|
506
|
+
resource: "contact:*/*"
|
|
507
|
+
},
|
|
508
|
+
{
|
|
509
|
+
action: "entity:edit",
|
|
510
|
+
resource: "opportunity*"
|
|
511
|
+
}
|
|
512
|
+
]
|
|
513
|
+
}
|
|
514
|
+
},
|
|
515
|
+
"User role with parent": {
|
|
516
|
+
description: "Example user role that inherits from a parent role",
|
|
517
|
+
value: {
|
|
518
|
+
id: "123:limited_manager",
|
|
519
|
+
name: "Limited Manager",
|
|
520
|
+
slug: "limited_manager",
|
|
521
|
+
type: "user_role",
|
|
522
|
+
organization_id: "123",
|
|
523
|
+
parent_role: "123:manager",
|
|
524
|
+
grants: [
|
|
525
|
+
{
|
|
526
|
+
action: "entity:view",
|
|
527
|
+
resource: "contact:*"
|
|
528
|
+
},
|
|
529
|
+
{
|
|
530
|
+
action: "entity:edit",
|
|
531
|
+
resource: "contact:*"
|
|
532
|
+
}
|
|
533
|
+
]
|
|
534
|
+
}
|
|
535
|
+
}
|
|
536
|
+
}
|
|
537
|
+
}
|
|
538
|
+
}
|
|
539
|
+
},
|
|
540
|
+
responses: {
|
|
541
|
+
"200": {
|
|
542
|
+
description: "ok",
|
|
543
|
+
content: {
|
|
544
|
+
"application/json": {
|
|
545
|
+
schema: {
|
|
546
|
+
$ref: "#/components/schemas/Role"
|
|
547
|
+
}
|
|
548
|
+
}
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
"400": {
|
|
552
|
+
description: "Bad Request - Invalid role configuration",
|
|
553
|
+
content: {
|
|
554
|
+
"application/json": {
|
|
555
|
+
schema: {
|
|
556
|
+
$ref: "#/components/schemas/Error"
|
|
557
|
+
},
|
|
558
|
+
examples: {
|
|
559
|
+
parent_role_invalid_type: {
|
|
560
|
+
summary: "Parent role must be org_role or share_role",
|
|
561
|
+
value: {
|
|
562
|
+
message: "Parent role must be org_role or share_role, got user_role"
|
|
563
|
+
}
|
|
564
|
+
},
|
|
565
|
+
parent_role_different_org: {
|
|
566
|
+
summary: "Parent org_role must be in the same organization",
|
|
567
|
+
value: {
|
|
568
|
+
message: "Parent org_role must be in the same organization"
|
|
569
|
+
}
|
|
570
|
+
},
|
|
571
|
+
parent_role_max_hierarchy: {
|
|
572
|
+
summary: "Parent role cannot itself have a parent",
|
|
573
|
+
value: {
|
|
574
|
+
message: "Parent role cannot itself have a parent (max 2 levels of hierarchy)"
|
|
575
|
+
}
|
|
576
|
+
},
|
|
577
|
+
circular_dependency_self: {
|
|
578
|
+
summary: "Role cannot be its own parent",
|
|
579
|
+
value: {
|
|
580
|
+
message: "Role cannot be its own parent"
|
|
581
|
+
}
|
|
582
|
+
},
|
|
583
|
+
circular_dependency_detected: {
|
|
584
|
+
summary: "Circular dependency detected",
|
|
585
|
+
value: {
|
|
586
|
+
message: "Circular dependency detected: role 123:child would create a cycle"
|
|
587
|
+
}
|
|
588
|
+
}
|
|
589
|
+
}
|
|
590
|
+
}
|
|
591
|
+
}
|
|
592
|
+
},
|
|
593
|
+
"404": {
|
|
594
|
+
description: "Not Found - Parent role does not exist",
|
|
595
|
+
content: {
|
|
596
|
+
"application/json": {
|
|
597
|
+
schema: {
|
|
598
|
+
$ref: "#/components/schemas/Error"
|
|
599
|
+
},
|
|
600
|
+
examples: {
|
|
601
|
+
parent_role_not_found: {
|
|
602
|
+
summary: "Parent role does not exist",
|
|
603
|
+
value: {
|
|
604
|
+
message: "Parent role 123:nonexistent does not exist"
|
|
605
|
+
}
|
|
606
|
+
}
|
|
607
|
+
}
|
|
608
|
+
}
|
|
609
|
+
}
|
|
610
|
+
}
|
|
611
|
+
}
|
|
612
|
+
},
|
|
613
|
+
delete: {
|
|
614
|
+
operationId: "deleteRole",
|
|
615
|
+
summary: "deleteRole",
|
|
616
|
+
description: "Delete role by id",
|
|
617
|
+
tags: ["Roles"],
|
|
618
|
+
parameters: [
|
|
619
|
+
{
|
|
620
|
+
name: "roleId",
|
|
621
|
+
in: "path",
|
|
622
|
+
required: true,
|
|
623
|
+
schema: {
|
|
624
|
+
$ref: "#/components/schemas/RoleId"
|
|
625
|
+
}
|
|
626
|
+
}
|
|
627
|
+
],
|
|
628
|
+
responses: {
|
|
629
|
+
"200": {
|
|
630
|
+
description: "ok",
|
|
631
|
+
content: {
|
|
632
|
+
"application/json": {
|
|
633
|
+
schema: {
|
|
634
|
+
$ref: "#/components/schemas/Role"
|
|
635
|
+
}
|
|
636
|
+
}
|
|
637
|
+
}
|
|
638
|
+
}
|
|
639
|
+
}
|
|
640
|
+
}
|
|
641
|
+
},
|
|
642
|
+
"/v1/permissions/refresh": {
|
|
643
|
+
get: {
|
|
644
|
+
operationId: "refreshPermissions",
|
|
645
|
+
summary: "refreshPermissions",
|
|
646
|
+
description: "Makes sure the user has a role in the organization",
|
|
647
|
+
tags: ["Roles"],
|
|
648
|
+
responses: {
|
|
649
|
+
"200": {
|
|
650
|
+
description: "Refreshed succesfully"
|
|
651
|
+
}
|
|
652
|
+
}
|
|
653
|
+
}
|
|
654
|
+
},
|
|
655
|
+
"/v1/permissions/assignments/{userId}": {
|
|
656
|
+
get: {
|
|
657
|
+
operationId: "getAssignedRolesForUser",
|
|
658
|
+
summary: "getAssignedRolesForUser",
|
|
659
|
+
description: "Get list of assigned roles by user id",
|
|
660
|
+
tags: ["Assignments"],
|
|
661
|
+
parameters: [
|
|
662
|
+
{
|
|
663
|
+
name: "userId",
|
|
664
|
+
in: "path",
|
|
665
|
+
required: true,
|
|
666
|
+
schema: {
|
|
667
|
+
$ref: "#/components/schemas/UserId"
|
|
668
|
+
}
|
|
669
|
+
}
|
|
670
|
+
],
|
|
671
|
+
responses: {
|
|
672
|
+
"200": {
|
|
673
|
+
description: "ok",
|
|
674
|
+
content: {
|
|
675
|
+
"application/json": {
|
|
676
|
+
schema: {
|
|
677
|
+
$ref: "#/components/schemas/Assignments"
|
|
678
|
+
}
|
|
679
|
+
}
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
}
|
|
683
|
+
},
|
|
684
|
+
put: {
|
|
685
|
+
operationId: "assignRoles",
|
|
686
|
+
summary: "assignRoles",
|
|
687
|
+
description: "Assign / unassign roles to users.",
|
|
688
|
+
tags: ["Assignments"],
|
|
689
|
+
parameters: [
|
|
690
|
+
{
|
|
691
|
+
name: "userId",
|
|
692
|
+
in: "path",
|
|
693
|
+
required: true,
|
|
694
|
+
schema: {
|
|
695
|
+
$ref: "#/components/schemas/UserId"
|
|
696
|
+
}
|
|
697
|
+
}
|
|
698
|
+
],
|
|
699
|
+
requestBody: {
|
|
700
|
+
content: {
|
|
701
|
+
"application/json": {
|
|
702
|
+
schema: {
|
|
703
|
+
$ref: "#/components/schemas/Assignments"
|
|
704
|
+
}
|
|
705
|
+
}
|
|
706
|
+
}
|
|
707
|
+
},
|
|
708
|
+
responses: {
|
|
709
|
+
"200": {
|
|
710
|
+
description: "ok",
|
|
711
|
+
content: {
|
|
712
|
+
"application/json": {
|
|
713
|
+
schema: {
|
|
714
|
+
$ref: "#/components/schemas/Assignments"
|
|
715
|
+
}
|
|
716
|
+
}
|
|
717
|
+
}
|
|
718
|
+
}
|
|
719
|
+
}
|
|
720
|
+
}
|
|
721
|
+
},
|
|
722
|
+
"/v1/permissions/assignments/{userId}/{roleId}": {
|
|
723
|
+
post: {
|
|
724
|
+
operationId: "addAssignment",
|
|
725
|
+
summary: "addAssignment",
|
|
726
|
+
description: "Assign a user to a role.\n\nUse the `x-epilot-org-id` header to assign share roles to users in other orgs\n",
|
|
727
|
+
tags: ["Assignments"],
|
|
728
|
+
parameters: [
|
|
729
|
+
{
|
|
730
|
+
name: "userId",
|
|
731
|
+
in: "path",
|
|
732
|
+
required: true,
|
|
733
|
+
schema: {
|
|
734
|
+
$ref: "#/components/schemas/UserId"
|
|
735
|
+
}
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
name: "roleId",
|
|
739
|
+
in: "path",
|
|
740
|
+
required: true,
|
|
741
|
+
schema: {
|
|
742
|
+
$ref: "#/components/schemas/RoleId"
|
|
743
|
+
}
|
|
744
|
+
}
|
|
745
|
+
],
|
|
746
|
+
responses: {
|
|
747
|
+
"201": {
|
|
748
|
+
description: "ok",
|
|
749
|
+
content: {
|
|
750
|
+
"application/json": {
|
|
751
|
+
schema: {
|
|
752
|
+
$ref: "#/components/schemas/Assignment"
|
|
753
|
+
}
|
|
754
|
+
}
|
|
755
|
+
}
|
|
756
|
+
}
|
|
757
|
+
}
|
|
758
|
+
},
|
|
759
|
+
delete: {
|
|
760
|
+
operationId: "removeAssignment",
|
|
761
|
+
summary: "removeAssignment",
|
|
762
|
+
description: "Remove role assignment from user",
|
|
763
|
+
tags: ["Assignments"],
|
|
764
|
+
parameters: [
|
|
765
|
+
{
|
|
766
|
+
name: "userId",
|
|
767
|
+
in: "path",
|
|
768
|
+
required: true,
|
|
769
|
+
schema: {
|
|
770
|
+
$ref: "#/components/schemas/UserId"
|
|
771
|
+
}
|
|
772
|
+
},
|
|
773
|
+
{
|
|
774
|
+
name: "roleId",
|
|
775
|
+
in: "path",
|
|
776
|
+
required: true,
|
|
777
|
+
schema: {
|
|
778
|
+
$ref: "#/components/schemas/RoleId"
|
|
779
|
+
}
|
|
780
|
+
}
|
|
781
|
+
],
|
|
782
|
+
responses: {
|
|
783
|
+
"200": {
|
|
784
|
+
description: "ok",
|
|
785
|
+
content: {
|
|
786
|
+
"application/json": {
|
|
787
|
+
schema: {
|
|
788
|
+
$ref: "#/components/schemas/Assignment"
|
|
789
|
+
}
|
|
790
|
+
}
|
|
791
|
+
}
|
|
792
|
+
}
|
|
793
|
+
}
|
|
794
|
+
}
|
|
795
|
+
},
|
|
796
|
+
"/v1/permissions/assignments": {
|
|
797
|
+
get: {
|
|
798
|
+
operationId: "listAllAssignments",
|
|
799
|
+
summary: "listAllAssignments",
|
|
800
|
+
description: "Returns list of all assignments in organization",
|
|
801
|
+
tags: ["Assignments"],
|
|
802
|
+
responses: {
|
|
803
|
+
"200": {
|
|
804
|
+
description: "ok",
|
|
805
|
+
content: {
|
|
806
|
+
"application/json": {
|
|
807
|
+
schema: {
|
|
808
|
+
type: "object",
|
|
809
|
+
properties: {
|
|
810
|
+
assignments: {
|
|
811
|
+
type: "array",
|
|
812
|
+
items: {
|
|
813
|
+
$ref: "#/components/schemas/Assignment"
|
|
814
|
+
}
|
|
815
|
+
}
|
|
816
|
+
}
|
|
817
|
+
}
|
|
818
|
+
}
|
|
819
|
+
}
|
|
820
|
+
}
|
|
821
|
+
}
|
|
822
|
+
}
|
|
823
|
+
}
|
|
824
|
+
};
|
|
825
|
+
var components = {
|
|
826
|
+
securitySchemes: {
|
|
827
|
+
EpilotAuth: {
|
|
828
|
+
type: "http",
|
|
829
|
+
scheme: "bearer",
|
|
830
|
+
description: "Authorization header with epilot OAuth2 bearer token",
|
|
831
|
+
bearerFormat: "JWT"
|
|
832
|
+
},
|
|
833
|
+
EpilotOrg: {
|
|
834
|
+
description: "Overrides the target organization to allow shared tenantaccess",
|
|
835
|
+
name: "x-epilot-org-id",
|
|
836
|
+
in: "header",
|
|
837
|
+
type: "apiKey"
|
|
838
|
+
}
|
|
839
|
+
},
|
|
840
|
+
schemas: {
|
|
841
|
+
Grant: {
|
|
842
|
+
type: "object",
|
|
843
|
+
properties: {
|
|
844
|
+
action: {
|
|
845
|
+
type: "string",
|
|
846
|
+
example: "entity-read"
|
|
847
|
+
},
|
|
848
|
+
resource: {
|
|
849
|
+
type: "string",
|
|
850
|
+
example: "entity:123:contact:f7c22299-ca72-4bca-8538-0a88eeefc947"
|
|
851
|
+
},
|
|
852
|
+
effect: {
|
|
853
|
+
type: "string",
|
|
854
|
+
default: "allow",
|
|
855
|
+
enum: ["allow", "deny"]
|
|
856
|
+
},
|
|
857
|
+
conditions: {
|
|
858
|
+
type: "array",
|
|
859
|
+
items: {
|
|
860
|
+
$ref: "#/components/schemas/GrantCondition"
|
|
861
|
+
}
|
|
862
|
+
}
|
|
863
|
+
},
|
|
864
|
+
required: ["action"]
|
|
865
|
+
},
|
|
866
|
+
GrantWithDependencies: {
|
|
867
|
+
allOf: [
|
|
868
|
+
{
|
|
869
|
+
$ref: "#/components/schemas/Grant"
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
type: "object",
|
|
873
|
+
properties: {
|
|
874
|
+
dependencies: {
|
|
875
|
+
description: "Provided additional dependencies, exploded when storing the role",
|
|
876
|
+
type: "array",
|
|
877
|
+
items: {
|
|
878
|
+
$ref: "#/components/schemas/Grant"
|
|
879
|
+
}
|
|
880
|
+
}
|
|
881
|
+
}
|
|
882
|
+
}
|
|
883
|
+
]
|
|
884
|
+
},
|
|
885
|
+
GrantCondition: {
|
|
886
|
+
allOf: [
|
|
887
|
+
{
|
|
888
|
+
description: "An additional condition that must be met for the grant",
|
|
889
|
+
type: "object",
|
|
890
|
+
required: ["operation"]
|
|
891
|
+
},
|
|
892
|
+
{
|
|
893
|
+
anyOf: [
|
|
894
|
+
{
|
|
895
|
+
$ref: "#/components/schemas/EqualsCondition"
|
|
896
|
+
}
|
|
897
|
+
]
|
|
898
|
+
}
|
|
899
|
+
]
|
|
900
|
+
},
|
|
901
|
+
EqualsCondition: {
|
|
902
|
+
description: "Check if attribute equals to any of the values",
|
|
903
|
+
type: "object",
|
|
904
|
+
properties: {
|
|
905
|
+
attribute: {
|
|
906
|
+
type: "string",
|
|
907
|
+
example: "workflows.primary.task_name"
|
|
908
|
+
},
|
|
909
|
+
operation: {
|
|
910
|
+
type: "string",
|
|
911
|
+
enum: ["equals"]
|
|
912
|
+
},
|
|
913
|
+
values: {
|
|
914
|
+
type: "array",
|
|
915
|
+
items: {
|
|
916
|
+
example: "Qualification"
|
|
917
|
+
}
|
|
918
|
+
}
|
|
919
|
+
},
|
|
920
|
+
required: ["attribute", "operation", "values"]
|
|
921
|
+
},
|
|
922
|
+
RoleId: {
|
|
923
|
+
type: "string",
|
|
924
|
+
example: "123:owner",
|
|
925
|
+
description: "Format: <organization_id>:<slug>"
|
|
926
|
+
},
|
|
927
|
+
BaseRole: {
|
|
928
|
+
type: "object",
|
|
929
|
+
properties: {
|
|
930
|
+
id: {
|
|
931
|
+
$ref: "#/components/schemas/RoleId"
|
|
932
|
+
},
|
|
933
|
+
name: {
|
|
934
|
+
type: "string",
|
|
935
|
+
example: "Owner",
|
|
936
|
+
description: "Human-friendly name for the role"
|
|
937
|
+
},
|
|
938
|
+
slug: {
|
|
939
|
+
type: "string",
|
|
940
|
+
example: "owner",
|
|
941
|
+
description: "URL-friendly name for the role"
|
|
942
|
+
},
|
|
943
|
+
type: {
|
|
944
|
+
type: "string",
|
|
945
|
+
description: "Type of the role"
|
|
946
|
+
},
|
|
947
|
+
expires_at: {
|
|
948
|
+
type: "string",
|
|
949
|
+
format: "date-time",
|
|
950
|
+
example: "2028-07-21T17:32:28Z",
|
|
951
|
+
description: "date and time then the role will expire"
|
|
952
|
+
},
|
|
953
|
+
organization_id: {
|
|
954
|
+
$ref: "#/components/schemas/OrganizationId"
|
|
955
|
+
},
|
|
956
|
+
grants: {
|
|
957
|
+
type: "array",
|
|
958
|
+
items: {
|
|
959
|
+
$ref: "#/components/schemas/Grant"
|
|
960
|
+
},
|
|
961
|
+
description: "List of grants (permissions) applied to the role"
|
|
962
|
+
}
|
|
963
|
+
},
|
|
964
|
+
required: ["id", "name", "slug", "type", "organization_id", "grants"]
|
|
965
|
+
},
|
|
966
|
+
BaseRoleForCreate: {
|
|
967
|
+
type: "object",
|
|
968
|
+
properties: {
|
|
969
|
+
id: {
|
|
970
|
+
$ref: "#/components/schemas/RoleId"
|
|
971
|
+
},
|
|
972
|
+
name: {
|
|
973
|
+
type: "string",
|
|
974
|
+
example: "Owner",
|
|
975
|
+
description: "Human-friendly name for the role"
|
|
976
|
+
},
|
|
977
|
+
slug: {
|
|
978
|
+
type: "string",
|
|
979
|
+
example: "owner",
|
|
980
|
+
description: "URL-friendly name for the role"
|
|
981
|
+
},
|
|
982
|
+
type: {
|
|
983
|
+
type: "string",
|
|
984
|
+
description: "Type of the role"
|
|
985
|
+
},
|
|
986
|
+
expires_at: {
|
|
987
|
+
type: "string",
|
|
988
|
+
format: "date-time",
|
|
989
|
+
example: "2028-07-21T17:32:28Z",
|
|
990
|
+
description: "date and time then the role will expire"
|
|
991
|
+
},
|
|
992
|
+
organization_id: {
|
|
993
|
+
$ref: "#/components/schemas/OrganizationId"
|
|
994
|
+
},
|
|
995
|
+
grants: {
|
|
996
|
+
type: "array",
|
|
997
|
+
items: {
|
|
998
|
+
$ref: "#/components/schemas/Grant"
|
|
999
|
+
},
|
|
1000
|
+
description: "List of grants (permissions) applied to the role"
|
|
1001
|
+
}
|
|
1002
|
+
},
|
|
1003
|
+
required: ["name", "slug", "type", "grants"]
|
|
1004
|
+
},
|
|
1005
|
+
UserRole: {
|
|
1006
|
+
allOf: [
|
|
1007
|
+
{
|
|
1008
|
+
$ref: "#/components/schemas/BaseRole"
|
|
1009
|
+
},
|
|
1010
|
+
{
|
|
1011
|
+
description: "A standard user role. Must be explicitly assigned to users.",
|
|
1012
|
+
properties: {
|
|
1013
|
+
type: {
|
|
1014
|
+
enum: ["user_role"]
|
|
1015
|
+
},
|
|
1016
|
+
parent_role: {
|
|
1017
|
+
allOf: [
|
|
1018
|
+
{
|
|
1019
|
+
$ref: "#/components/schemas/RoleId"
|
|
1020
|
+
},
|
|
1021
|
+
{
|
|
1022
|
+
description: "Optional parent role that this role inherits from. Must be an `org_role` or `share_role`."
|
|
1023
|
+
}
|
|
1024
|
+
]
|
|
1025
|
+
}
|
|
1026
|
+
}
|
|
1027
|
+
}
|
|
1028
|
+
]
|
|
1029
|
+
},
|
|
1030
|
+
OrgRole: {
|
|
1031
|
+
allOf: [
|
|
1032
|
+
{
|
|
1033
|
+
$ref: "#/components/schemas/BaseRole"
|
|
1034
|
+
},
|
|
1035
|
+
{
|
|
1036
|
+
description: "A role automatically applied to all users in an organization.",
|
|
1037
|
+
properties: {
|
|
1038
|
+
type: {
|
|
1039
|
+
enum: ["org_role"]
|
|
1040
|
+
},
|
|
1041
|
+
pricing_tier: {
|
|
1042
|
+
type: "string",
|
|
1043
|
+
description: "The pricing tier of the organization this root role is based on",
|
|
1044
|
+
example: "Professional"
|
|
1045
|
+
}
|
|
1046
|
+
}
|
|
1047
|
+
}
|
|
1048
|
+
]
|
|
1049
|
+
},
|
|
1050
|
+
ShareRole: {
|
|
1051
|
+
allOf: [
|
|
1052
|
+
{
|
|
1053
|
+
$ref: "#/components/schemas/BaseRole"
|
|
1054
|
+
},
|
|
1055
|
+
{
|
|
1056
|
+
description: "A role that can be assigned to users in other organizations for sharing purposes.",
|
|
1057
|
+
properties: {
|
|
1058
|
+
type: {
|
|
1059
|
+
enum: ["share_role"]
|
|
1060
|
+
}
|
|
1061
|
+
}
|
|
1062
|
+
}
|
|
1063
|
+
]
|
|
1064
|
+
},
|
|
1065
|
+
PartnerRole: {
|
|
1066
|
+
allOf: [
|
|
1067
|
+
{
|
|
1068
|
+
$ref: "#/components/schemas/BaseRole"
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
description: "A role that appears in another organization's role list that can be assigned but not modified by the partner organization.",
|
|
1072
|
+
properties: {
|
|
1073
|
+
type: {
|
|
1074
|
+
enum: ["partner_role"]
|
|
1075
|
+
},
|
|
1076
|
+
partner_org_id: {
|
|
1077
|
+
allOf: [
|
|
1078
|
+
{
|
|
1079
|
+
description: "Partner organization who can assign this role to their users."
|
|
1080
|
+
},
|
|
1081
|
+
{
|
|
1082
|
+
$ref: "#/components/schemas/OrganizationId"
|
|
1083
|
+
}
|
|
1084
|
+
]
|
|
1085
|
+
},
|
|
1086
|
+
vendor_enforced_user_limit: {
|
|
1087
|
+
type: "integer",
|
|
1088
|
+
readOnly: true,
|
|
1089
|
+
description: "Maximum number of users that can be assigned this role (vendor-enforced limit, can only be set via internal auth)"
|
|
1090
|
+
}
|
|
1091
|
+
}
|
|
1092
|
+
}
|
|
1093
|
+
]
|
|
1094
|
+
},
|
|
1095
|
+
PortalRole: {
|
|
1096
|
+
allOf: [
|
|
1097
|
+
{
|
|
1098
|
+
$ref: "#/components/schemas/BaseRole"
|
|
1099
|
+
},
|
|
1100
|
+
{
|
|
1101
|
+
description: "A role that is applied to end customers and installers using the Portals",
|
|
1102
|
+
properties: {
|
|
1103
|
+
type: {
|
|
1104
|
+
enum: ["portal_role"]
|
|
1105
|
+
}
|
|
1106
|
+
}
|
|
1107
|
+
}
|
|
1108
|
+
]
|
|
1109
|
+
},
|
|
1110
|
+
Role: {
|
|
1111
|
+
oneOf: [
|
|
1112
|
+
{
|
|
1113
|
+
$ref: "#/components/schemas/UserRole"
|
|
1114
|
+
},
|
|
1115
|
+
{
|
|
1116
|
+
$ref: "#/components/schemas/OrgRole"
|
|
1117
|
+
},
|
|
1118
|
+
{
|
|
1119
|
+
$ref: "#/components/schemas/ShareRole"
|
|
1120
|
+
},
|
|
1121
|
+
{
|
|
1122
|
+
$ref: "#/components/schemas/PartnerRole"
|
|
1123
|
+
},
|
|
1124
|
+
{
|
|
1125
|
+
$ref: "#/components/schemas/PortalRole"
|
|
1126
|
+
}
|
|
1127
|
+
]
|
|
1128
|
+
},
|
|
1129
|
+
RolePayload: {
|
|
1130
|
+
allOf: [
|
|
1131
|
+
{
|
|
1132
|
+
properties: {
|
|
1133
|
+
grants: {
|
|
1134
|
+
type: "array",
|
|
1135
|
+
items: {
|
|
1136
|
+
$ref: "#/components/schemas/GrantWithDependencies"
|
|
1137
|
+
}
|
|
1138
|
+
}
|
|
1139
|
+
}
|
|
1140
|
+
},
|
|
1141
|
+
{
|
|
1142
|
+
oneOf: [
|
|
1143
|
+
{
|
|
1144
|
+
$ref: "#/components/schemas/UserRole"
|
|
1145
|
+
},
|
|
1146
|
+
{
|
|
1147
|
+
$ref: "#/components/schemas/OrgRole"
|
|
1148
|
+
},
|
|
1149
|
+
{
|
|
1150
|
+
$ref: "#/components/schemas/ShareRole"
|
|
1151
|
+
},
|
|
1152
|
+
{
|
|
1153
|
+
$ref: "#/components/schemas/PartnerRole"
|
|
1154
|
+
},
|
|
1155
|
+
{
|
|
1156
|
+
$ref: "#/components/schemas/PortalRole"
|
|
1157
|
+
}
|
|
1158
|
+
]
|
|
1159
|
+
}
|
|
1160
|
+
]
|
|
1161
|
+
},
|
|
1162
|
+
Assignment: {
|
|
1163
|
+
type: "object",
|
|
1164
|
+
description: "A role attached to an user",
|
|
1165
|
+
properties: {
|
|
1166
|
+
user_id: {
|
|
1167
|
+
$ref: "#/components/schemas/UserId"
|
|
1168
|
+
},
|
|
1169
|
+
roles: {
|
|
1170
|
+
type: "array",
|
|
1171
|
+
items: {
|
|
1172
|
+
$ref: "#/components/schemas/RoleId"
|
|
1173
|
+
}
|
|
1174
|
+
}
|
|
1175
|
+
}
|
|
1176
|
+
},
|
|
1177
|
+
InternalAssignment: {
|
|
1178
|
+
type: "object",
|
|
1179
|
+
description: "A role attached to an user",
|
|
1180
|
+
properties: {
|
|
1181
|
+
userId: {
|
|
1182
|
+
$ref: "#/components/schemas/UserId"
|
|
1183
|
+
},
|
|
1184
|
+
roles: {
|
|
1185
|
+
type: "array",
|
|
1186
|
+
items: {
|
|
1187
|
+
$ref: "#/components/schemas/RoleId"
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
1190
|
+
}
|
|
1191
|
+
},
|
|
1192
|
+
OrgAssignments: {
|
|
1193
|
+
type: "object",
|
|
1194
|
+
description: "All roles attached to an users of an organization",
|
|
1195
|
+
properties: {
|
|
1196
|
+
organizationId: {
|
|
1197
|
+
$ref: "#/components/schemas/OrganizationId"
|
|
1198
|
+
},
|
|
1199
|
+
assignments: {
|
|
1200
|
+
type: "array",
|
|
1201
|
+
items: {
|
|
1202
|
+
$ref: "#/components/schemas/InternalAssignment"
|
|
1203
|
+
}
|
|
1204
|
+
}
|
|
1205
|
+
}
|
|
1206
|
+
},
|
|
1207
|
+
OrgRoles: {
|
|
1208
|
+
type: "object",
|
|
1209
|
+
description: "All roles attached to an users of an organization",
|
|
1210
|
+
properties: {
|
|
1211
|
+
organizationId: {
|
|
1212
|
+
$ref: "#/components/schemas/OrganizationId"
|
|
1213
|
+
},
|
|
1214
|
+
roles: {
|
|
1215
|
+
type: "array",
|
|
1216
|
+
items: {
|
|
1217
|
+
$ref: "#/components/schemas/Role"
|
|
1218
|
+
}
|
|
1219
|
+
}
|
|
1220
|
+
}
|
|
1221
|
+
},
|
|
1222
|
+
Assignments: {
|
|
1223
|
+
type: "array",
|
|
1224
|
+
description: "List of role ids attached to an user",
|
|
1225
|
+
items: {
|
|
1226
|
+
$ref: "#/components/schemas/RoleId"
|
|
1227
|
+
}
|
|
1228
|
+
},
|
|
1229
|
+
UserId: {
|
|
1230
|
+
type: "string",
|
|
1231
|
+
example: "1",
|
|
1232
|
+
description: "Id of a user"
|
|
1233
|
+
},
|
|
1234
|
+
OrganizationId: {
|
|
1235
|
+
type: "string",
|
|
1236
|
+
example: "123",
|
|
1237
|
+
description: "Id of an organization"
|
|
1238
|
+
},
|
|
1239
|
+
Slug: {
|
|
1240
|
+
type: "string",
|
|
1241
|
+
example: "owner",
|
|
1242
|
+
description: "Slug of a role; for a role with id = 123:manager -> 123 is org_id & manager is slug"
|
|
1243
|
+
},
|
|
1244
|
+
RoleSearchInput: {
|
|
1245
|
+
type: "object",
|
|
1246
|
+
properties: {
|
|
1247
|
+
role_ids: {
|
|
1248
|
+
type: "array",
|
|
1249
|
+
description: "List of role ids to filter by",
|
|
1250
|
+
example: ["123:manager", "456:owner"],
|
|
1251
|
+
items: {
|
|
1252
|
+
$ref: "#/components/schemas/RoleId"
|
|
1253
|
+
}
|
|
1254
|
+
},
|
|
1255
|
+
org_ids: {
|
|
1256
|
+
type: "array",
|
|
1257
|
+
description: "List of organization ids to filter by",
|
|
1258
|
+
example: ["123", "456"],
|
|
1259
|
+
items: {
|
|
1260
|
+
$ref: "#/components/schemas/OrganizationId"
|
|
1261
|
+
}
|
|
1262
|
+
},
|
|
1263
|
+
slugs: {
|
|
1264
|
+
type: "array",
|
|
1265
|
+
description: "List of role slugs to filter by",
|
|
1266
|
+
example: ["manager", "owner"],
|
|
1267
|
+
items: {
|
|
1268
|
+
$ref: "#/components/schemas/Slug"
|
|
1269
|
+
}
|
|
1270
|
+
},
|
|
1271
|
+
query: {
|
|
1272
|
+
type: "string",
|
|
1273
|
+
description: "Input to search across fields",
|
|
1274
|
+
example: "Administrator"
|
|
1275
|
+
},
|
|
1276
|
+
limit: {
|
|
1277
|
+
type: "number",
|
|
1278
|
+
description: "The Number of roles to return",
|
|
1279
|
+
example: 1,
|
|
1280
|
+
minimum: 1,
|
|
1281
|
+
default: 50
|
|
1282
|
+
},
|
|
1283
|
+
offset: {
|
|
1284
|
+
type: "number",
|
|
1285
|
+
description: "The number of roles to skip before starting to collect the result set",
|
|
1286
|
+
example: 1,
|
|
1287
|
+
minimum: 1,
|
|
1288
|
+
default: 0
|
|
1289
|
+
}
|
|
1290
|
+
}
|
|
1291
|
+
},
|
|
1292
|
+
CreateRolePayload: {
|
|
1293
|
+
allOf: [
|
|
1294
|
+
{
|
|
1295
|
+
properties: {
|
|
1296
|
+
grants: {
|
|
1297
|
+
type: "array",
|
|
1298
|
+
items: {
|
|
1299
|
+
$ref: "#/components/schemas/GrantWithDependencies"
|
|
1300
|
+
}
|
|
1301
|
+
}
|
|
1302
|
+
}
|
|
1303
|
+
},
|
|
1304
|
+
{
|
|
1305
|
+
$ref: "#/components/schemas/BaseRoleForCreate"
|
|
1306
|
+
},
|
|
1307
|
+
{
|
|
1308
|
+
oneOf: [
|
|
1309
|
+
{
|
|
1310
|
+
description: "A standard user role. Must be explicitly assigned to users.",
|
|
1311
|
+
properties: {
|
|
1312
|
+
type: {
|
|
1313
|
+
enum: ["user_role"]
|
|
1314
|
+
},
|
|
1315
|
+
parent_role: {
|
|
1316
|
+
allOf: [
|
|
1317
|
+
{
|
|
1318
|
+
$ref: "#/components/schemas/RoleId"
|
|
1319
|
+
},
|
|
1320
|
+
{
|
|
1321
|
+
description: "Optional parent role that this role inherits from. Must be an `org_role` or a sharing role of type `share_role` or `partner_role`."
|
|
1322
|
+
}
|
|
1323
|
+
]
|
|
1324
|
+
}
|
|
1325
|
+
}
|
|
1326
|
+
},
|
|
1327
|
+
{
|
|
1328
|
+
description: "A role automatically applied to all users in an organization.",
|
|
1329
|
+
properties: {
|
|
1330
|
+
type: {
|
|
1331
|
+
enum: ["org_role"]
|
|
1332
|
+
},
|
|
1333
|
+
pricing_tier: {
|
|
1334
|
+
type: "string",
|
|
1335
|
+
description: "The pricing tier of the organization this root role is based on",
|
|
1336
|
+
example: "Professional"
|
|
1337
|
+
}
|
|
1338
|
+
}
|
|
1339
|
+
},
|
|
1340
|
+
{
|
|
1341
|
+
description: "A role that can be assigned to users in other organizations for sharing purposes.",
|
|
1342
|
+
properties: {
|
|
1343
|
+
type: {
|
|
1344
|
+
enum: ["share_role"]
|
|
1345
|
+
}
|
|
1346
|
+
}
|
|
1347
|
+
},
|
|
1348
|
+
{
|
|
1349
|
+
description: "A role that appears in another organization's role list that can be assigned but not modified by the partner organization.",
|
|
1350
|
+
properties: {
|
|
1351
|
+
type: {
|
|
1352
|
+
enum: ["partner_role"]
|
|
1353
|
+
},
|
|
1354
|
+
partner_org_id: {
|
|
1355
|
+
allOf: [
|
|
1356
|
+
{
|
|
1357
|
+
description: "Partner organization who can assign this role to their users."
|
|
1358
|
+
},
|
|
1359
|
+
{
|
|
1360
|
+
$ref: "#/components/schemas/OrganizationId"
|
|
1361
|
+
}
|
|
1362
|
+
]
|
|
1363
|
+
}
|
|
1364
|
+
}
|
|
1365
|
+
},
|
|
1366
|
+
{
|
|
1367
|
+
description: "A role that is applied to end customers and installers using the Portals",
|
|
1368
|
+
properties: {
|
|
1369
|
+
type: {
|
|
1370
|
+
enum: ["portal_role"]
|
|
1371
|
+
}
|
|
1372
|
+
}
|
|
1373
|
+
}
|
|
1374
|
+
]
|
|
1375
|
+
}
|
|
1376
|
+
]
|
|
1377
|
+
},
|
|
1378
|
+
Error: {
|
|
1379
|
+
type: "object",
|
|
1380
|
+
description: "Error response",
|
|
1381
|
+
properties: {
|
|
1382
|
+
message: {
|
|
1383
|
+
type: "string",
|
|
1384
|
+
description: "Error message",
|
|
1385
|
+
example: "Parent role 123:nonexistent does not exist"
|
|
1386
|
+
}
|
|
1387
|
+
},
|
|
1388
|
+
required: ["message"]
|
|
1389
|
+
}
|
|
1390
|
+
}
|
|
1391
|
+
};
|
|
1392
|
+
var servers = [
|
|
1393
|
+
{
|
|
1394
|
+
url: "https://permissions.sls.epilot.io"
|
|
1395
|
+
}
|
|
1396
|
+
];
|
|
1397
|
+
var permissions_default = {
|
|
1398
|
+
openapi,
|
|
1399
|
+
info,
|
|
1400
|
+
tags,
|
|
1401
|
+
security,
|
|
1402
|
+
paths,
|
|
1403
|
+
components,
|
|
1404
|
+
servers
|
|
1405
|
+
};
|
|
1406
|
+
export {
|
|
1407
|
+
components,
|
|
1408
|
+
permissions_default as default,
|
|
1409
|
+
info,
|
|
1410
|
+
openapi,
|
|
1411
|
+
paths,
|
|
1412
|
+
security,
|
|
1413
|
+
servers,
|
|
1414
|
+
tags
|
|
1415
|
+
};
|