Comprehensive Permissions Listing
The following is a complete list of permissions available in Socotra. Our API documentation specifies the permissions required to access each API endpoint.
For example, the Create a Quote endpoint requires the quotes.write or quotes.create permission.
Refer to our documentation on Role-Based Access Control for more details.
| Resource | Action |
|---|---|
account-balances | account-balances.write |
accounting | accounting.read |
accounts | accounts.list, accounts.read, accounts.write |
assignments | assignments.write |
auto-renewals | auto-renewals.read, auto-renewals.write |
automation | automation.execute, automation.write |
auxdata | auxdata.list, auxdata.read, auxdata.write |
charges | charges.list, charges.read, charges.write |
compliance | compliance.read, compliance.write |
constraints | constraints.read, constraints.upload |
contacts | contacts.read, contacts.write |
credit-distributions | credit-distributions.list, credit-distributions.read, credit-distributions.write |
credits | credits.list, credits.read |
delinquencies | delinquencies.list, delinquencies.read, delinquencies.write |
delta-files | delta-files.read |
deployments | deployments.cloneProduction, deployments.cloneTest, deployments.datamodel, deployments.deploy, deployments.read, deployments.retire-version |
deserializeJobs | deserializeJobs.list, deserializeJobs.read, deserializeJobs.write |
developer | developer.build, developer.download |
diary | diary.list, diary.read, diary.write |
disbursements | disbursements.list, disbursements.read, disbursements.write |
diverted-events | diverted-events.delete, diverted-events.list, diverted-events.read, diverted-events.resend |
documents | documents.delete-external, documents.read, documents.render-external, documents.replace-external, documents.trigger, documents.update, documents.upload, documents.upload-external |
events | events.list, events.read, events.write |
external-cash-transactions | external-cash-transactions.read |
financial-instruments | financial-instruments.list, financial-instruments.read, financial-instruments.write |
fnols | fnols.list, fnols.read, fnols.write |
fonts | fonts.read, fonts.update, fonts.upload |
holds | holds.list, holds.read, holds.write |
identity | identity.add, identity.custom, identity.delete, identity.read |
installment-lattices | installment-lattices.list, installment-lattices.read |
installments | installments.list, installments.read, installments.write |
invoices | invoices.list, invoices.read, invoices.write |
jobs | jobs.list, jobs.read, jobs.write |
logs | logs.list, logs.read |
mediadata | mediadata.list, mediadata.read, mediadata.write |
metrics | metrics.read |
migration | migration.list, migration.read, migration.write |
moratoriums | moratoriums.deploy, moratoriums.fetch |
payment-providers | payment-providers.list, payment-providers.read, payment-providers.write |
payments | payments.list, payments.read, payments.write |
policies | policies.create-quote, policies.list, policies.moratoriums, policies.read, policies.write |
producers | producers.list, producers.read, producers.write |
public | public.public |
qualifications | qualifications.read, qualifications.write |
quick-quotes | quick-quotes.list, quick-quotes.read, quick-quotes.write |
quotes | quotes.accept, quotes.approve-add, quotes.approve-clear, quotes.block-add, quotes.block-clear, quotes.create, quotes.decline-add, quotes.decline-clear, quotes.discard, quotes.elements-add, quotes.elements-delete, quotes.info-add, quotes.info-clear, quotes.issue, quotes.list, quotes.moratoriums, quotes.precommit, quotes.price, quotes.read, quotes.refuse, quotes.reject-add, quotes.reject-clear, quotes.reserve-policy-number-set, quotes.reset, quotes.schedule-add, quotes.schedule-delete, quotes.schedule-read, quotes.schedule-update, quotes.static-data-add, quotes.static-data-update, quotes.underwrite, quotes.update, quotes.validate, quotes.write |
ratingregistries | ratingregistries.list, ratingregistries.read |
resource-groups | resource-groups.list, resource-groups.read, resource-groups.write |
resources | resources.list, resources.read |
retry-jobs | retry-jobs.write |
riskAssessmentCriteria | riskAssessmentCriteria.read, riskAssessmentCriteria.update, riskAssessmentCriteria.upload |
roles | roles.add, roles.delete, roles.list, roles.read, roles.update |
search | search.read |
secrets | secrets.read, secrets.write |
settings | settings.read |
shortfall-credits | shortfall-credits.list, shortfall-credits.read |
tables | tables.read, tables.upload |
tasks | tasks.list, tasks.read, tasks.write |
templates | templates.read, templates.upload |
tenantEvents | tenantEvents.tenant-events |
tenants | tenants.create-tenant, tenants.custom, tenants.list, tenants.read, tenants.retire, tenants.validate-config, tenants.write |
terms | terms.list, terms.read, terms.write |
transactions | transactions.accept, transactions.approve-add, transactions.approve-clear, transactions.block-add, transactions.block-clear, transactions.change-instruction-add, transactions.change-instruction-delete, transactions.change-instruction-update, transactions.decline-add, transactions.decline-clear, transactions.discard, transactions.elements-add, transactions.elements-delete, transactions.elements-update, transactions.info-add, transactions.info-clear, transactions.initialize, transactions.issue, transactions.precommit, transactions.price, transactions.read, transactions.refuse, transactions.reject-add, transactions.reject-clear, transactions.reset, transactions.schedule-add, transactions.schedule-delete, transactions.schedule-read, transactions.schedule-update, transactions.underwrite, transactions.validate, transactions.write |
uiConfigs | uiConfigs.read, uiConfigs.update, uiConfigs.upload |
user-associations | user-associations.read, user-associations.write |
users | users.add, users.custom, users.delete, users.enable, users.list, users.password-reset, users.read, users.revoke, users.token, users.update, users.update-roles, users.update-tenants, users.write |
webhooks | webhooks.list, webhooks.read, webhooks.write |
workgroups | workgroups.list, workgroups.read, workgroups.write |
workplans | workplans.read, workplans.write |
write-offs | write-offs.list, write-offs.read, write-offs.write |