Fortanix Accounts API

The Accounts API from Fortanix — 9 operation(s) for accounts.

Operations 18

GET /v1/accounts Get all accounts. #
POST /v1/accounts Create a new account. #
GET /v1/accounts/{account-id} Get a specific account. #
DELETE /v1/accounts/{account-id} Delete an account. #
PATCH /v1/accounts/{account-id} Update an account. #
GET /sys/v1/accounts/{acct_id}/usage Get account usage information. See input and output of this API for info on what it can return. #
POST /sys/v1/accounts Create a new account. #
GET /sys/v1/accounts Get info about all accounts. #
POST /sys/v1/accounts/{acct_id}/replication/credentials Create an admin app credential that can be used to perform account replication. #
GET /sys/v1/accounts/{acct_id}/replication/credentials Retrieve all stored replication credentials under the account. #
DELETE /sys/v1/accounts/{acct_id} Delete an account. #
GET /sys/v1/accounts/{acct_id} Get info for a specific account. #
PATCH /sys/v1/accounts/{acct_id} Update account settings such as authentication, logging, etc. #
DELETE /sys/v1/accounts/{acct_id}/replication/credentials/{credential_id} Delete the specified replication credential. #
GET /sys/v1/accounts/{acct_id}/replication/credentials/{credential_id} Retrieve the specified replication credential. #
PATCH /sys/v1/accounts/{acct_id}/replication/credentials/{credential_id} Update the specified replication credential. #
GET /sys/v1/accounts/{acct_id}/replication/recent_scan_summary Fetch a summary of recent scans. #
POST /sys/v1/accounts/{acct_id}/replication/credentials/{credential_id}/self_sign Generate a self-signed cert for the specified credential. #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/fortanix-accounts-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

fortanix-accounts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Fortanix Accounts API
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: '1.0'
  description: 'Operations tagged Accounts across 2 of this provider''s published API definitions: fortanix-ccm-openapi-original.json, fortanix-dsm-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://ccm.fortanix.com
- url: '{dsmEndpoint}'
  description: DSM Endpoint
  variables:
    dsmEndpoint:
      default: https://amer.smartkey.io
      description: Type your DSM server URL here (include https://)
tags:
- name: Accounts
paths:
  /v1/accounts:
    get:
      tags:
      - Accounts
      summary: Get all accounts.
      description: Get detailed information about all accounts that the current user has permission to see.
      operationId: getAccounts
      x-auth-resource: UserAuth,Reader,Writer,Manager
      parameters:
      - name: scope
        in: query
        description: 'Specify the scope from which to get the accounts. Possible options: USER, SYSTEM.'
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum numbers of accounts to return.
        required: false
        schema:
          type: integer
      - name: previous_id
        in: query
        description: Id of account from previous page of results.
        required: false
        schema:
          type: string
          format: uuid
      - name: sort_by
        in: query
        description: Sort fields. In the format of key1:ASC,key2:DESC,key3:DESC
        required: false
        schema:
          type: string
      responses:
        '200':
          description: All account details for the current user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountListResponse'
      security:
      - bearerToken: []
    post:
      tags:
      - Accounts
      summary: Create a new account.
      description: Create a new account with the specified properties. Only an authenticated user can create an account.
      parameters:
      - $ref: '#/components/parameters/AccountRequest'
      operationId: createAccount
      x-auth-resource: UserAuth,Reader,Writer,Manager
      responses:
        '200':
          description: The details of the account created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
      security:
      - bearerToken: []
    servers:
    - url: https://ccm.fortanix.com
  /v1/accounts/{account-id}:
    get:
      tags:
      - Accounts
      summary: Get a specific account.
      description: Look up an account by account ID. Current user must belong to a particular account.
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/WithTotals'
      operationId: getAccount
      x-auth-resource: UserAuth,Reader,Writer,Manager
      responses:
        '200':
          description: Particular account details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
      security:
      - bearerToken: []
    delete:
      tags:
      - Accounts
      summary: Delete an account.
      description: Remove an account.
      parameters:
      - $ref: '#/components/parameters/AccountId'
      operationId: deleteAccount
      x-auth-resource: NoAuth
      responses:
        '204':
          description: Nothing is returned on success.
      security:
      - bearerToken: []
    patch:
      tags:
      - Accounts
      summary: Update an account.
      description: Update the properties of an account. Only certain properties may be changed with this API.
      parameters:
      - $ref: '#/components/parameters/AccountId'
      - $ref: '#/components/parameters/AccountUpdateRequest'
      operationId: updateAccount
      x-auth-resource: Manager, UserAuth
      responses:
        '200':
          description: Updated account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
      security:
      - bearerToken: []
    servers:
    - url: https://ccm.fortanix.com
  /sys/v1/accounts/{acct_id}/usage:
    get:
      operationId: AccountUsage
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: 'Get account usage information. See input and output of this API

        for info on what it can return.'
      description: 'Get account usage information. See input and output of this API

        for info on what it can return.'
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/CountParams'
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUsageResponse'
    servers:
    - url: '{dsmEndpoint}'
      description: DSM Endpoint
      variables:
        dsmEndpoint:
          default: https://amer.smartkey.io
          description: Type your DSM server URL here (include https://)
  /sys/v1/accounts:
    post:
      operationId: CreateAccount
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Create a new account.
      description: Create a new account.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountRequest_2'
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account_2'
    get:
      operationId: ListAccounts
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Get info about all accounts.
      description: 'A user can have access to multiple accounts and this API gets

        all accounts the calling user has access to.'
      parameters:
      - $ref: '#/components/parameters/GetAccountParams'
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Account_2'
    servers:
    - url: '{dsmEndpoint}'
      description: DSM Endpoint
      variables:
        dsmEndpoint:
          default: https://amer.smartkey.io
          description: Type your DSM server URL here (include https://)
  /sys/v1/accounts/{acct_id}/replication/credentials:
    post:
      operationId: CreateReplicationCredential
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: 'Create an admin app credential that can be used to perform

        account replication.'
      description: 'Note that this does _not_ immediately create a usable credential;

        further processing is necessary before it can be actually used for

        account replication.


        Currently, a single replication account can store up to two

        replication credentials.'
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateReplicationCredentialRequest'
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationCredential'
    get:
      operationId: ListReplicationCredentials
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Retrieve all stored replication credentials under the account.
      description: Retrieve all stored replication credentials under the account.
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListReplicationCredentialsResponse'
    servers:
    - url: '{dsmEndpoint}'
      description: DSM Endpoint
      variables:
        dsmEndpoint:
          default: https://amer.smartkey.io
          description: Type your DSM server URL here (include https://)
  /sys/v1/accounts/{acct_id}:
    delete:
      operationId: DeleteAccount
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Delete an account.
      description: Delete an account.
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Nothing is returned on success
    get:
      operationId: GetAccount
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Get info for a specific account.
      description: 'A user can have access to multiple accounts and this API tries

        to look one up given by the input id.'
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - $ref: '#/components/parameters/GetAccountParams'
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account_2'
    patch:
      operationId: UpdateAccount
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Update account settings such as authentication, logging, etc.
      description: Update account settings such as authentication, logging, etc.
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountRequest_2'
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account_2'
    servers:
    - url: '{dsmEndpoint}'
      description: DSM Endpoint
      variables:
        dsmEndpoint:
          default: https://amer.smartkey.io
          description: Type your DSM server URL here (include https://)
  /sys/v1/accounts/{acct_id}/replication/credentials/{credential_id}:
    delete:
      operationId: DeleteReplicationCredential
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Delete the specified replication credential.
      description: Delete the specified replication credential.
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Nothing is returned on success
    get:
      operationId: GetReplicationCredential
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Retrieve the specified replication credential.
      description: Retrieve the specified replication credential.
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationCredential'
    patch:
      operationId: UpdateReplicationCredential
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Update the specified replication credential.
      description: 'This can be used to associate an app ID with the credential,

        and/or upload cert chains for the credential.'
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateReplicationCredentialRequest'
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationCredential'
    servers:
    - url: '{dsmEndpoint}'
      description: DSM Endpoint
      variables:
        dsmEndpoint:
          default: https://amer.smartkey.io
          description: Type your DSM server URL here (include https://)
  /sys/v1/accounts/{acct_id}/replication/recent_scan_summary:
    get:
      operationId: RecentReplicationScanSummary
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Fetch a summary of recent scans.
      description: Fetch a summary of recent scans.
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecentScanSummary'
    servers:
    - url: '{dsmEndpoint}'
      description: DSM Endpoint
      variables:
        dsmEndpoint:
          default: https://amer.smartkey.io
          description: Type your DSM server URL here (include https://)
  /sys/v1/accounts/{acct_id}/replication/credentials/{credential_id}/self_sign:
    post:
      operationId: ReplicationCredentialSelfSignedCert
      tags:
      - Accounts
      security:
      - bearerToken: []
      - apiKeyAuth: []
      summary: Generate a self-signed cert for the specified credential.
      description: 'Note that this does _not_ immediately associate the certificate

        with the credential; the credential still needs to be updated

        afterwards.'
      parameters:
      - name: acct_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: credential_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReplicationCredentialSelfSignedCertRequest'
      responses:
        2XX:
          description: Success result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReplicationCredentialSelfSignedCertResponse'
    servers:
    - url: '{dsmEndpoint}'
      description: DSM Endpoint
      variables:
        dsmEndpoint:
          default: https://amer.smartkey.io
          description: Type your DSM server URL here (include https://)
components:
  schemas:
    CaConfig:
      type: object
      properties:
        ca_set:
          $ref: '#/components/schemas/CaSet'
        pinned:
          type: array
          items:
            type: string
            format: binary
    AccessRoles:
      type: string
      description: Roles of a user.
      enum:
      - READER
      - WRITER
      - MANAGER
    AuthConfigPassword:
      type: object
      description: Configuration for password-based authentication.
      required:
      - require_2fa
      - administrators_only
      properties:
        require_2fa:
          type: boolean
        administrators_only:
          type: boolean
    TlsConfigRequired:
      type: object
      required:
      - validate_hostname
      - ca
      properties:
        validate_hostname:
          type: boolean
        client_key:
          type: string
          format: binary
        client_cert:
          type: string
          format: binary
        ca:
          $ref: '#/components/schemas/CaConfig'
    AccountRequest:
      type: object
      required:
      - name
      properties:
        name:
          type: string
          description: Name of the account. Accounts must be unique within a CCM instance.
        custom_logo:
          type: string
          format: binary
          description: Logo for an account. Max size 128Kb, .jpg, .png, .svg file formats only.
        auth_configs:
          type: array
          items:
            $ref: '#/components/schemas/AuthenticationConfig'
        node_enrollment:
          $ref: '#/components/schemas/NodeEnrollment'
        component:
          $ref: '#/components/schemas/AccountComponent'
    AccountUpdateRequest:
      type: object
      properties:
        name:
          type: string
        custom_logo:
          type: string
          format: binary
        add_auth_configs:
          type: array
          items:
            $ref: '#/components/schemas/AuthenticationConfig'
        mod_auth_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AuthenticationConfig'
        del_auth_configs:
          type: array
          items:
            type: string
            format: uuid
        enabled:
          type: boolean
        default_group_id:
          type: string
          format: uuid
        marketplace_group_id:
          type: string
          format: uuid
        account_status:
          $ref: '#/components/schemas/AccountStatus'
        azure_cvm_pcr_priority:
          $ref: '#/components/schemas/AzureCvmPcrPriority'
    AzureCvmPcrPriority:
      type: array
      description: Ordered list of exactly the integer elements 0 through 22
      items:
        type: integer
    AuthConfigRef:
      type: object
      required:
      - target_id
      properties:
        target_id:
          type: string
    AuthConfigOauth:
      type: object
      required:
      - idp_name
      - idp_icon_url
      - idp_authorization_endpoint
      - idp_token_endpoint
      - idp_requires_basic_auth
      - tls
      - client_id
      - client_secret
      properties:
        idp_name:
          type: string
        idp_icon_url:
          type: string
        idp_authorization_endpoint:
          type: string
        idp_token_endpoint:
          type: string
        idp_requires_basic_auth:
          type: boolean
        idp_userinfo_endpoint:
          type: string
        tls:
          $ref: '#/components/schemas/TlsConfig'
        client_id:
          type: string
        client_secret:
          type: string
    AuthenticationConfig:
      type: object
      properties:
        password:
          $ref: '#/components/schemas/AuthConfigPassword'
        oauth:
          $ref: '#/components/schemas/AuthConfigOauth'
        cluster_auth_ref:
          $ref: '#/components/schemas/AuthConfigRef'
    CaSet:
      type: string
      enum:
      - GLOBAL_ROOTS
    NodeEnrollment:
      type: object
      required:
      - attestation_enforcement_disabled_insecure
      properties:
        attestation_enforcement_disabled_insecure:
          type: boolean
    Account:
      type: object
      required:
      - acct_id
      - node_enrollment
      - component
      properties:
        name:
          type: string
          description: Name of the account. Account names must be unique within a CCM instance.
        acct_id:
          type: string
          format: uuid
          description: Account ID uniquely identifying this account.
        created_at:
          type: integer
          format: int64
          description: When this account was created.
        roles:
          type: array
          description: Role of the current user in a particular account.
          items:
            $ref: '#/components/schemas/AccessRoles'
        custom_logo:
          type: string
          format: binary
          description: Logo of the particular account. Max size 128Kb, .jpg, .png, .svg file formats only.
        status:
          $ref: '#/components/schemas/UserAccountStatus'
        auth_configs:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/AuthenticationConfig'
        node_enrollment:
          $ref: '#/components/schemas/NodeEnrollment'
        totals:
          $ref: '#/components/schemas/ObjectCounts'
        component:
          $ref: '#/components/schemas/AccountComponent'
        default_group_id:
          type: string
          format: uuid
          description: Default group_id in an account.
        marketplace_group_id:
          type: string
          format: uuid
          description: Marketplace group_id for the account
        account_status:
          $ref: '#/components/schemas/AccountStatus'
        azure_cvm_pcr_priority:
          $ref: '#/components/schemas/AzureCvmPcrPriority'
    UserAccountStatus:
      type: string
      description: Status of an Account for a user.
      enum:
      - ACTIVE
      - PENDING
      - DISABLED
    TlsConfig:
      type: object
      properties:
        disabled:
          type: object
        opportunistic:
          type: object
        required:
          $ref: '#/components/schemas/TlsConfigRequired'
    AccountListResponse:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Account'
    ObjectCounts:
      type: object
      required:
      - datasets
      - final_workflows
      - nodes
      properties:
        datasets:
          type: integer
          minimum: 0
        final_workflows:
          type: integer
          minimum: 0
        nodes:
          type: integer
          minimum: 0
    AccountStatus:
      type: string
      enum:
      - Active
      - Deactivated
    AccountComponent:
      type: string
      description: Get the account type.
      enum:
      - DEFAULT
      - CONFIDENTIAL_AI
    ClientFileLogging:
      oneOf:
      - $ref: '#/components/schemas/ClientFileLoggingVariantEnabled'
      - $ref: '#/components/schemas/ClientFileLoggingVariantDisabled'
      discriminator:
        propertyName: mode
        mapping:
          enabled: ClientFileLoggingVariantEnabled
          disabled: ClientFileLoggingVariantDisabled
    SigningKeysVariantStored:
      allOf:
      - type: object
        properties:
          kind:
            type: string
            enum:
            - stored
        required:
        - kind
      - $ref: '#/components/schemas/SigningKeysStored'
    FpeDate:
      description: 'A structure for specifying a token part representing a date that occurs after a specified date

        and/or occurs before a specified date. Depending on the subparts that make up the date, one of

        the three options is used.'
      oneOf:
      - title: FpeDateVariantDayMonthYear
        type: object
        properties:
          dmy_date:
            $ref: '#/components/schemas/FpeDateDayMonthYear'
        required:
        - dmy_date
      - title: FpeDateVariantMonthDay
        type: object
        properties:
          month_day_date:
            $ref: '#/components/schemas/FpeDateMonthDay'
        required:
        - month_day_date
      - title: FpeDateVariantMonthYear
        type: object
        properties:
          month_year_date:
            $ref: '#/components/schemas/FpeDateMonthYear'
        required:
        - month_year_date
    ApiPath:
      allOf:
      - type: object
        properties:
          api_path:
            type: string
          method:
            type: string
          context:
            $ref: '#/components/schemas/TepKeyContext'
          key_path:
            type: string
        required:
        - api_path
        - method
        - context
        - key_path
    FpeDataPart:
      description: Structure for specifying (part of) a complex tokenization data type.
      oneOf:
      - $ref: '#/components/schemas/FpeEncryptedPart'
      - $ref: '#/components/schemas/FpeDataPartLiteral'
      - $ref: '#/components/schemas/FpeCompoundPart'
    AccountPurpose:
      description: Describes the purpose of the account.
      oneOf:
      - $ref: '#/components/schemas/AccountPurposeVariantStandard'
      - $ref: '#/components/schemas/AccountPurposeVariantAccountReplication'
      discriminator:
        propertyName: $type
        mapping:
          Standard: AccountPurposeVariantStandard
          AccountReplication: AccountPurposeVariantAccountReplication
    NotificationPref:
      description: Notification preferences.
      type: string
      enum:
      - None
      - Email
      - Phone
      - Both
    CipherMode:
      description: Cipher mode used for symmetric key algorithms.
      type: string
      enum:
      - ECB
      - CBC
      - CBCNOPAD
      - CFB
      - OFB
      - CTR
      - GCM
      - CCM
      - KW
      - KWP
      - FF1
    CountAccuracy:
      description: An indicator of how accurate a count of objects is.
      oneOf:
      - $ref: '#/components/schemas/CountAccuracyVariantExact'
      - $ref: '#/components/schemas/CountAccuracyVariantApproximate'
      discriminator:
        propertyName: $type
        mapping:
          Exact: CountAccuracyVariantExact
          Approximate: CountAccuracyVariantApproximate
    AccountPurposeTypeVariantAccountReplication:
      allOf:
      - type: object
        properties:
          $type:
            type: string
            enum:
            - AccountReplication
        required:
        - $type
      - type: object
        properties: {}
    TlsConfigVariantOpportunistic:
      allOf:
      - type: object
        properties:
          mode:
            type: string
            enum:
            - opportunistic
        required:
        - mode
      - type: object
        properties: {}
    AccountReplicationScanSettings:
      allOf:
      - type: object
        description: 'Settings for how DSM should go about replicating objects from the source account once a connection

          has been established.


          Today, account replication is performed using "basic" replication, which exports key material in

          the clear (over a TLS connection).'
        properties:
          auto_scan:
            $ref: '#/components/schemas/AutoScanSettings'
        required:
        - auto_scan
    FpeDayMonthDate:
      allOf:
      - type: object
        description: 'A structure for specifying a particular date consisting of a day and a month, for use in an

          FpeDate structure.'
        properties:
          month:
            type: integer
            minimum: 0
            maximum: 255
            description: The month, which should be an integer from 1 to 12.
          day:
            type: integer
            minimum: 0
            maximum: 255
            description: 'The day, which should be an integer from 1 to either 29, 30, or 31, depending on the month

              and year. Here, February is treated as having 29 days.'
        required:
        - month
        - day
    FpeInputProcessing:
      description: Options to apply some pre- and post-processing to the input.
      oneOf:
      - title: FpeInputProcessingVariantStripUnknown
        type: string
        enum:
        - strip_unknown
      - title: FpeInputProcessingVariantPassthroughUnknown
        type: string
        enum:
        - passthrough_unknown
      - title: FpeInputProcessingVariantPassthroughSpecific
        type: object
        properties:
          passthrough_specific:
            $ref: '#/components/schemas/FpeInputProcessingPassthroughSpecific'
        required:
        - passthrough_specific
    CommonClientConfig:
      allOf:
      - type: object
        properties:
          retry_timeout_millis:
            type:
            - integer
            - 'null'
          cache_ttl:
            type:
            - integer
            - 'null'
          log:
            $ref: '#/components/schemas/ClientLogConfig'
          h2_num_connections:
            type:
            - integer
            - 'null'
          quorum_approval:
            $ref: '#/components/schemas/QuorumApprovalConfig'
    RemovableKmipClientConfig:
      oneOf:
      - type: string
        enum:
        - remove
      - $ref: '#/components/schemas/KmipClientConfig'
    SplunkLoggingConfigRequest:
      allOf:
      - type: object
        properties:
          enabled:
            type:
            - boolean
            - 'null'
          host:
            type:
            - string
            - 'null'
          port:
            type:
            - integer
            - 'null'
            minimum: 0
            maximum: 65535
          index:
            type:
            - string
            - 'null'
            description: The Splunk index that will receive log items.
          token:
            type: string
            description: The Splunk authentication token.
          tls:
            $ref: '#/components/schemas/TlsConfig_2'
          use_fqdn_hostname:
            type:
            - boolean
            - 'null'
            description: Enable sending the cluster FQDN as the hostname in log entries.
    KeyExpiryAlertTrigger:
      oneOf:
      - $ref: '#/components/schemas/KeyExpiryAlertTriggerVariantDaysAhead'
      discriminator:
        propertyName: $type
        mapping:
          DaysAhead: KeyExpiryAlertTriggerVariantDaysAhead
    ReplicationCredentialVariantCertificate:
      allOf:
      - type: object
        properties:
          $type:
            type: string
            enum:
            - Certificate
        required:
        - $type
      - $ref: '#/components/schemas/CertificateReplicationCredential'
    SigningKeysStored:
      allOf:
      - type: object
        properties:
          keys:
            type: object
            additionalProperties:
              type: string
              format: byte
            description: Mapping key ids to DER-encoded public key.
        required:
        - keys
    CertificateOptionsPolicy:
      allOf:
      - type: object
        properties: {}
    AccountPurposeVariantAccountReplication:
      allOf:
      - type: object
        properties:
          $type:
            type: string
            enum:
            - AccountReplication
        required:
        - $type
      - $ref: '#/components/schemas/AccountReplicationConfiguration'
    Des3OptionsPolicy:
      allOf:
      - type: object
        description: 'Cryptographic policy for triple DES objects. Setting `key_sizes: [168]`

          forbids two-key triple DES.'
        properties:
          key_sizes:
            type:
            - array
            - 'null'
            items:
              type: integer
              minimum: 0
              maximum: 4294967295
          random_iv:
            type:
            - boolean
            - 'null'
    ApprovalRequestSettingsRequest:
      allOf:
      - type: object
        description: A request struct for modifying settings that apply to quorum approval requests.
        properties:
          approval_request_expiry:
            type:
            - integer
            - 'null'
            description: 'The number of seconds after which an approval request expires. Changing this

              setting will not change the expiry of existing approval requests, but it may

              still affect the "updated" expiry period assigned to existing requests upon

              their approval (see below for details).


              Upon creation, an approval request''s expiry date is (time of creation +

              expiry period). However, when the request is approved by all its approvers,

              its expiry date will be changed to (time

# --- truncated at 32 KB (157 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/fortanix/refs/heads/main/openapi/fortanix-accounts-api-openapi.yml