# Deprecated API Items



{/* This file is auto-generated by scripts/generate-derived-docs.ts. Do not edit manually. */}

<Callout>
  The following entities, parameters, and properties have been marked as
  deprecated, which means you should avoid using them. They will be removed in
  future releases.
</Callout>

Endpoints [#endpoints]

POST /auth/identity [#post-authidentity]

* Endpoint: <ApiLink name="createIdentityProvider">POST /auth/identity</ApiLink>
* Status: deprecated

GET /auth/users/{locator}/accessmask [#get-authuserslocatoraccessmask]

* Endpoint: <ApiLink name="fetchUserMasks">GET /auth/users/\{locator}/accessmask</ApiLink>
* Status: deprecated

PATCH /auth/users/{locator}/accessmask [#patch-authuserslocatoraccessmask]

* Endpoint: <ApiLink name="addDataSecurityMask">PATCH /auth/users/\{locator}/accessmask</ApiLink>
* Status: deprecated

DELETE /auth/users/{locator}/accessmask/{tenantLocator} [#delete-authuserslocatoraccessmasktenantlocator]

* Endpoint: <ApiLink name="deleteUserMasks">DELETE /auth/users/\{locator}/accessmask/\{tenantLocator}</ApiLink>
* Status: deprecated

GET /auth/users/{locator}/accessmask/{tenantLocator} [#get-authuserslocatoraccessmasktenantlocator]

* Endpoint: <ApiLink name="fetchUserMasksForTenant">GET /auth/users/\{locator}/accessmask/\{tenantLocator}</ApiLink>
* Status: deprecated

GET /auth/users/{locator}/accessmask/{tenantLocator}/{type} [#get-authuserslocatoraccessmasktenantlocatortype]

* Endpoint: <ApiLink name="fetchUserMask">GET /auth/users/\{locator}/accessmask/\{tenantLocator}/\{type}</ApiLink>
* Status: deprecated

GET /billing/{tenantLocator}/jobs/installments/quotes/{locator}/list [#get-billingtenantlocatorjobsinstallmentsquoteslocatorlist]

* Endpoint: <ApiLink name="fetchInstallmentsJobDataForQuotes">GET /billing/\{tenantLocator}/jobs/installments/quotes/\{locator}/list</ApiLink>
* Status: deprecated

PATCH /payment-execution/{tenantLocator}/paymentProviders/{locator}/inactivate [#patch-payment-executiontenantlocatorpaymentproviderslocatorinactivate]

* Endpoint: <ApiLink name="inactivatePaymentProviderConfiguration">PATCH /payment-execution/\{tenantLocator}/paymentProviders/\{locator}/inactivate</ApiLink>
* Status: deprecated

GET /policy/{tenantLocator}/policies/snapshot/list [#get-policytenantlocatorpoliciessnapshotlist]

* Endpoint: <ApiLink name="fetchMultipleSnapshots">GET /policy/\{tenantLocator}/policies/snapshot/list</ApiLink>
* Status: deprecated

GET /policy/{tenantLocator}/transactions/{locator}/affectedTransactions/list [#get-policytenantlocatortransactionslocatoraffectedtransactionslist]

* Endpoint: <ApiLink name="fetchAffectedTransactionsForListEndpoint">GET /policy/\{tenantLocator}/transactions/\{locator}/affectedTransactions/list</ApiLink>
* Status: deprecated

GET /policy/{tenantLocator}/transactions/{locator}/segments/{segmentLocator} [#get-policytenantlocatortransactionslocatorsegmentssegmentlocator]

* Endpoint: <ApiLink name="fetchPolicySegmentEx">GET /policy/\{tenantLocator}/transactions/\{locator}/segments/\{segmentLocator}</ApiLink>
* Status: deprecated

GET /policy/{tenantLocator}/transactions/{locator}/segments/list [#get-policytenantlocatortransactionslocatorsegmentslist]

* Endpoint: <ApiLink name="fetchTransactionSegments">GET /policy/\{tenantLocator}/transactions/\{locator}/segments/list</ApiLink>
* Status: deprecated

Schemas [#schemas]

AccountResponse [#accountresponse]

* Schema: <ApiLink name="AccountResponse">AccountResponse</ApiLink>
* Deprecated properties: `state`

ChargeRef [#chargeref]

* Schema: <ApiLink name="ChargeRef">ChargeRef</ApiLink>
* Deprecated properties: `displayName`

ConfigurationRef [#configurationref]

* Schema: <ApiLink name="ConfigurationRef">ConfigurationRef</ApiLink>
* Deprecated properties: `billingPlans`, `defaultAnchorMode`, `defaultBillingLevel`, `defaultBillingPlan`, `defaultDueLeadDays`, `defaultGenerateLeadDays`, `defaultLapseType`, `defaultRegion`

DeployedConfigMetadata [#deployedconfigmetadata]

* Schema: <ApiLink name="DeployedConfigMetadata">DeployedConfigMetadata</ApiLink>
* Deprecated properties: `pluginVersionStatus`

DeploymentMetadata [#deploymentmetadata]

* Schema: <ApiLink name="DeploymentMetadata">DeploymentMetadata</ApiLink>
* Deprecated properties: `version2`

DocumentJobInfo [#documentjobinfo]

* Schema: <ApiLink name="DocumentJobInfo">DocumentJobInfo</ApiLink>
* Deprecated properties: `state`

DocumentSummary [#documentsummary]

* Schema: <ApiLink name="DocumentSummary">DocumentSummary</ApiLink>
* Deprecated properties: `state`

ElementRef [#elementref]

* Schema: <ApiLink name="ElementRef">ElementRef</ApiLink>
* Deprecated properties: `pluralType`

PolicyMigrationRequest [#policymigrationrequest]

* Schema: <ApiLink name="PolicyMigrationRequest">PolicyMigrationRequest</ApiLink>
* Deprecated properties: `preferences`

ProductRef [#productref]

* Schema: <ApiLink name="ProductRef">ProductRef</ApiLink>
* Deprecated properties: `defaultBillingPlan`, `pluralType`

QuickQuotePriceResponse [#quickquotepriceresponse]

* Schema: <ApiLink name="QuickQuotePriceResponse">QuickQuotePriceResponse</ApiLink>
* Deprecated properties: `state`
