Socotra Config API
The Config API from Socotra — 19 operation(s) for config.
OpenAPI Specification
openapi: 3.0.1
info:
title: Socotra Insurance Suite OpenAPI Definition Config API
description: Socotra Insurance Suite API
termsOfService: https://www.socotra.com
version: v0
servers:
- url: /
description: Generated server url
tags:
- name: Config
paths:
/config/validateConfig:
post:
operationId: validateConfig
parameters: []
requestBody:
content:
application/zip:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/zip:
schema:
$ref: '#/components/schemas/StreamingResponseBody'
deprecated: false
additionalProperties:
type: ZipFile
deprecated: false
x-securityGroup: tenants
x-securityPermission:
- create-tenant
- validate-config
deprecated: false
tags:
- Config
/config/{tenantLocator}/tenantEvents:
post:
operationId: scheduleTenantEvents
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScheduleTenantEventsRequest'
deprecated: false
required: true
responses:
'200':
description: OK
x-securityGroup: tenantEvents
x-securityPermission:
- tenant-events
deprecated: false
tags:
- Config
/config/{tenantLocator}/moratoriums:
get:
operationId: fetchMoratoriums
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
deprecated: false
additionalProperties:
$ref: '#/components/schemas/MoratoriumRef'
deprecated: false
x-securityGroup: moratoriums
x-securityPermission:
- deploy
- fetch
deprecated: false
tags:
- Config
post:
operationId: deployMoratoriums
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/TenantDeploymentResult'
deprecated: false
x-securityGroup: moratoriums
x-securityPermission:
- deploy
deprecated: false
tags:
- Config
/config/formatConfig:
post:
operationId: formatConfig
description: Converts a configuration's property casing to match requirements
parameters: []
requestBody:
content:
application/zip:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/zip:
schema:
$ref: '#/components/schemas/StreamingResponseBody'
deprecated: false
additionalProperties:
type: ZipFile
deprecated: false
x-securityGroup: tenants
x-securityPermission:
- create-tenant
- validate-config
deprecated: false
tags:
- Config
/config/{tenantLocator}/developer/build:
post:
operationId: buildBundle
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/zip:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/zip:
schema:
$ref: '#/components/schemas/StreamingResponseBody'
deprecated: false
additionalProperties:
type: ZipFile
deprecated: false
x-securityGroup: developer
x-securityPermission:
- build
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/validate:
post:
operationId: validateConfigZip
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
requestBody:
content:
application/zip:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/zip:
schema:
$ref: '#/components/schemas/StreamingResponseBody'
deprecated: false
additionalProperties:
type: ZipFile
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- deploy
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/deploy:
post:
operationId: deployConfigZip
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: overwrite
in: query
required: false
schema:
type: boolean
default: false
deprecated: false
requestBody:
content:
application/zip:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
required: true
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/TenantDeploymentResult'
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- deploy
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/cloneTest:
post:
operationId: cloneConfigToTest
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: tenantName
in: query
required: false
schema:
type: string
deprecated: false
- name: tenantDescription
in: query
required: false
schema:
type: string
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DeploymentCloneResponse'
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- cloneTest
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/cloneProduction:
post:
operationId: cloneConfigToProduction
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: tenantName
in: query
required: false
schema:
type: string
deprecated: false
- name: tenantDescription
in: query
required: false
schema:
type: string
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
$ref: '#/components/schemas/DeploymentCloneResponse'
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- cloneProduction
deprecated: false
tags:
- Config
/config/createTenant:
post:
operationId: createTenant
parameters:
- name: name
in: query
required: false
schema:
type: string
deprecated: false
- name: description
in: query
required: false
schema:
type: string
deprecated: false
requestBody:
content:
application/zip:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
multipart/form-data:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
required: true
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TenantDeploymentResult'
deprecated: false
x-securityGroup: tenants
x-securityPermission:
- create-tenant
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/versions/{staticVersionLocator}/retire:
patch:
operationId: retireConfigVersion
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: staticVersionLocator
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
responses:
'200':
description: OK
x-securityGroup: deployments
x-securityPermission:
- retire-version
deprecated: false
tags:
- Config
/config/events:
get:
operationId: fetchConfigEvents
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeploymentServiceEventTypeDefinitions'
deprecated: false
x-securityGroup: public
x-securityPermission:
- public
deprecated: false
tags:
- Config
/config/{tenantLocator}/developer/download:
get:
operationId: downloadBundle
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/zip:
schema:
$ref: '#/components/schemas/StreamingResponseBody'
deprecated: false
additionalProperties:
type: ZipFile
deprecated: false
x-securityGroup: developer
x-securityPermission:
- download
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments:
get:
operationId: getDeployedConfigMetadata
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/DeployedConfigMetadata'
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- read
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/download:
get:
operationId: downloadCurrentConfiguration
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
responses:
'200':
description: OK
content:
application/zip:
schema:
$ref: '#/components/schemas/StreamingResponseBody'
deprecated: false
additionalProperties:
type: ZipFile
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- deploy
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/download/{version}:
get:
operationId: downloadConfigurationVersion
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: version
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: byStaticLocator
in: query
required: false
schema:
type: boolean
deprecated: false
responses:
'200':
description: OK
content:
application/zip:
schema:
$ref: '#/components/schemas/StreamingResponseBody'
deprecated: false
additionalProperties:
type: ZipFile
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- deploy
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/diff:
get:
operationId: getPartialDeployDifference
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: config
in: query
required: true
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
responses:
'200':
description: OK
content:
'*/*':
schema:
type: object
deprecated: false
additionalProperties:
$ref: '#/components/schemas/MapDifference'
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- deploy
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/datamodel:
get:
operationId: fetchConfigDefinition
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: resolve
in: query
required: false
schema:
type: boolean
default: false
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- deploy
- datamodel
deprecated: false
tags:
- Config
/config/{tenantLocator}/deployments/datamodel/{version}:
get:
operationId: fetchConfigDefinitionForAVersion
parameters:
- name: tenantLocator
in: path
required: true
schema:
type: string
format: uuid
deprecated: false
- name: version
in: path
required: true
schema:
type: string
format: ulid
deprecated: false
- name: resolve
in: query
required: false
schema:
type: boolean
default: false
deprecated: false
- name: byStaticLocator
in: query
required: false
schema:
type: boolean
deprecated: false
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ConfigurationRef'
deprecated: false
x-securityGroup: deployments
x-securityPermission:
- deploy
- datamodel
deprecated: false
tags:
- Config
components:
schemas:
MoratoriumRef:
type: object
required:
- effectiveTime
- applicationMode
- billingHoldScope
- policyHoldScope
- policyMatchCriteria
- type
properties:
type:
type: string
deprecated: false
description:
type: string
deprecated: false
applicationMode:
type: string
description: Indicates whether the moratorium applies to all eligible policies or whether there is an option to opt in or out.
enum:
- optIn
- optOut
- mandatory
deprecated: false
effectiveTime:
type: string
format: date-time
deprecated: false
endTime:
type: string
format: date-time
description: The time the moratorium ends. This can be set after creation and updated to earlier or later.
deprecated: false
policyMatchCriteria:
description: The criteria used to identify which policies are eligible for the moratorium.
$ref: '#/components/schemas/MoratoriumPolicyMatchCriteriaRef'
deprecated: false
effectiveTimeWaived:
type: boolean
description: Indicates whether eligible policies issued after the moratorium effectiveTime are affected.
deprecated: false
policyHoldScope:
description: Must be at least one of either policyHoldScope or billingHoldScope.
$ref: '#/components/schemas/PolicyHoldScopeRef'
deprecated: false
billingHoldScope:
$ref: '#/components/schemas/BillingHoldScopeRef'
deprecated: false
displayName:
type: string
deprecated: false
deprecated: false
NegativeInvoiceHandlingRef:
type: object
required:
- automaticallySettleNegativeInvoices
- prioritizeOverlappingCoveragePeriods
- processingMode
- targetInvoicePriority
- targetInvoices
- yieldExcessToCreditBalance
properties:
automaticallySettleNegativeInvoices:
type: string
enum:
- toOpenInvoices
- toCreditBalance
- never
deprecated: false
prioritizeOverlappingCoveragePeriods:
type: boolean
deprecated: false
targetInvoices:
type: string
enum:
- overlappingCoveragePeriodsOnly
- overlappingCoverageAndEarlier
- allOpenInvoices
deprecated: false
targetInvoicePriority:
type: string
enum:
- byAmount
- smallestFirst
- earliestFirst
deprecated: false
processingMode:
type: string
enum:
- accountLevel
- policyLevel
deprecated: false
yieldExcessToCreditBalance:
type: boolean
deprecated: false
deprecated: false
ResourceGroupRef:
type: object
required:
- selectionStartTime
- resourceNames
properties:
selectionStartTime:
type: string
format: date-time
deprecated: false
resourceNames:
type: array
deprecated: false
items:
type: string
deprecated: false
deprecated: false
ProductRef:
type: object
properties:
extend:
type: string
deprecated: false
abstract:
type: boolean
deprecated: false
defaultInstallmentPlan:
type: string
deprecated: false
defaultBillingPlan:
type: string
deprecated: true
defaultTermDuration:
type: number
deprecated: false
defaultDelinquencyPlan:
type: string
deprecated: false
defaultAutoRenewalPlan:
type: string
deprecated: false
defaultShortfallTolerancePlan:
type: string
deprecated: false
displayName:
type: string
deprecated: false
defaultDurationBasis:
type: string
enum:
- years
- months
- weeks
- days
- hours
deprecated: false
coverageTerms:
type: array
deprecated: false
items:
type: string
deprecated: false
eligibleAccountTypes:
type: array
deprecated: false
items:
type: string
deprecated: false
eligibleTransactionTypes:
type: array
deprecated: false
items:
type: string
deprecated: false
contents:
type: array
deprecated: false
items:
type: string
deprecated: false
documents:
type: array
deprecated: false
items:
type: string
deprecated: false
charges:
type: array
deprecated: false
items:
type: string
deprecated: false
scheduledEvents:
type: array
deprecated: false
items:
type: string
deprecated: false
data:
type: object
deprecated: false
additionalProperties:
$ref: '#/components/schemas/PropertyRef'
deprecated: false
staticData:
type: object
deprecated: false
additionalProperties:
$ref: '#/components/schemas/PropertyRef'
deprecated: false
defaultSearchable:
type: boolean
deprecated: false
pluralType:
type: string
deprecated: true
numberingPlan:
type: string
deprecated: false
numberingString:
type: string
deprecated: false
availability:
$ref: '#/components/schemas/AvailabilityRef'
deprecated: false
withPrecommitReapplication:
type: boolean
deprecated: false
requiresJurisdiction:
type: boolean
deprecated: false
contacts:
type: object
deprecated: false
additionalProperties:
type: array
deprecated: false
items:
type: string
deprecated: false
numberingTrigger:
type: string
enum:
- creation
- validation
deprecated: false
workplanTriggers:
type: object
deprecated: false
additionalProperties:
type: array
deprecated: false
items:
type: string
deprecated: false
riskAssessmentCriteria:
type: string
deprecated: false
producerQualification:
type: string
enum:
- none
- license
- appointment
deprecated: false
externalNumberingPlan:
type: string
deprecated: false
reservedPolicyNumberRequired:
type: boolean
deprecated: false
deprecated: false
EventScheduleRef:
type: object
required:
- anchor
properties:
anchor:
type: string
enum:
- policyStart
- policyEnd
- termStart
- segmentStart
deprecated: false
alignment:
type: string
enum:
- weekStart
- monthStart
- yearStart
deprecated: false
offset:
type: object
deprecated: false
additionalProperties:
type: integer
format: int32
deprecated: false
cadence:
$ref: '#/components/schemas/EventCadenceRef'
deprecated: false
suppressOnStatuses:
type: array
deprecated: false
items:
type: string
enum:
- pending
- expired
- cancelled
- cancelPending
- onRisk
- delinquent
- doNotRenew
deprecated: false
deprecated: false
AssistantRef:
type: object
properties:
patTokenSecretRef:
$ref: '#/components/schemas/SecretKeyRef'
deprecated: false
inquiryIntents:
type: object
deprecated: false
additionalProperties:
$ref: '#/components/schemas/IntentPlan'
deprecated: false
deprecated: false
DeploymentServiceEventTypeDefinitions:
type: object
required:
- moratoriumEvents
properties:
moratoriumEvents:
$ref: '#/components/schemas/MoratoriumEvents'
deprecated: false
deprecated: false
AutoRenewalPlanRef:
type: object
required:
- generateAutoRenewals
properties:
generateAutoRenewals:
type: boolean
deprecated: false
renewalTransactionType:
type: string
deprecated: false
renewalCreateLeadDays:
type: integer
format: int32
deprecated: false
renewalAcceptLeadDays:
type: integer
format: int32
deprecated: false
renewalIssueLeadDays:
type: integer
format: int32
deprecated: false
newTermDuration:
type: integer
format: int32
deprecated: false
deprecated: false
MoratoriumEventData:
type: object
required:
- name
- effectiveTime
- endTime
properties:
name:
type: string
deprecated: false
effectiveTime:
type: string
format: date-time
deprecated: false
endTime:
type: string
format: date-time
deprecated: false
deprecated: false
ScheduleRef:
type: object
required:
- resetOnRenewal
- data
properties:
extend:
type: string
deprecated: false
abstract:
type: boolean
deprecated: false
displayName:
type: string
deprecated: false
data:
type: object
deprecated: false
additionalProperties:
$ref: '#/components/schemas/PropertyRef'
deprecated: false
resetOnRenewal:
type: boolean
deprecated: false
deprecated: false
BillingPlanRef:
type: object
required:
- billingLevel
properties:
displayName:
type: string
deprecated: false
billingLevel:
type: string
enum:
- account
- inherit
- policy
deprecated: false
deprecated: false
ShortfallTolerancePlanRef:
type: object
required:
- currencyTolerances
properties:
currencyTolerances:
type: object
deprecated: false
additionalProperties:
type: number
deprecated: false
deprecated: false
AccountRef:
type: object
required:
- data
properties:
displayName:
type: string
deprecated: false
abstract:
type: boolean
deprecated: false
extend:
type: string
deprecated: false
defaultSearchable:
type: boolean
deprecated: false
data:
type: object
deprecated: false
additionalProperties:
$ref: '#/components/schemas/PropertyRef'
deprecated: false
defaultInvoiceDocument:
type: string
deprecated: false
numberingPlan:
type: string
deprecated: false
invoiceNumberingPlan:
type: string
deprecated: false
paymentExecutionRetryPlan:
type: string
deprecated: false
contacts:
type: object
deprecated: false
additionalProperties:
type: array
deprecated: false
items:
type: string
deprecated: false
numberingTrigger:
type: string
enum:
- creation
- validation
deprecated: false
deprecated: false
DocumentMarginRef:
type: object
properties:
top:
type: number
deprecated: false
bottom:
type: number
deprecated: false
left:
type: number
deprecated: false
right:
type: number
deprecated: false
deprecated: false
SecretKeyRef:
type: object
required:
- name
- key
properties:
name:
type: string
deprecated: false
key:
type: string
deprecated: false
deprecated: false
ReversalTypeRef:
type: object
required:
- creditType
properties:
creditType:
type: string
enum:
- any
- creditDistribution
- payment
deprecated: false
deprecated: false
DeployedConfigMetadata:
type: object
required:
- metadata
- pluginStatus
- pluginVersionStatus
properties:
metadata:
$ref: '#/components/schemas/DeploymentMetadata'
deprecated: false
pluginVersionStatus:
type: object
deprecated: true
additionalProperties:
type: object
deprecated: true
additionalProperties:
type: string
deprecated: true
pluginStatus:
type: object
deprecated: false
additionalProperties:
type: string
deprecated: false
expectedRetirementTime:
type: string
format: date-time
deprecated: false
deprecated: false
MoratoriumPolicyMatchCriteriaRef:
type: object
required:
- criteriaValues
- productsRules
properties:
criteriaValues:
type: object
deprecated: false
additionalProperties:
type: array
deprecated: false
items:
type: string
deprecated: false
productsRules:
type: object
deprecated: false
additionalProperties:
$ref: '#/components/schemas/MoratoriumProductRuleRef'
deprecated: false
deprecated: false
ExternalNumberingPlanRef:
type: object
required:
- triggerQuoteState
properties:
displayName:
type: string
deprecated: false
triggerQuoteState:
type: string
enum:
- dr
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/socotra/refs/heads/main/openapi/socotra-config-api-openapi.yml