openapi: 3.1.0
info:
  title: Apiture Authentication and Authorization Provider SAML API
  description: This specifies an API provided by the Apiture authentication and authorization (OIDC) provider. The API provides operations related to encryption, signing, code compilation and code execution necessary for Apiture Digital Banking services and APIs to implement dynamic single-sign-on integrations required for FinTech Connector features. This API contains publicly accessible read-only operations to retrieve SAML metadata hosted by the provider.
  version: 0.3.1
  contact:
    name: Apiture
    url: https://developer.apiture.com
    email: api@apiture.com
  termsOfService: https://developer.apiture.com/docs/Apiture-API-License-Agreement.pdf
  license:
    name: Apiture API License
    url: https://developer.apiture.com/docs/Apiture-API-License-Agreement.pdf
x-apiture-namespace: systemSamlProvider
tags:
  - name: Metadata
    description: SAML Metadata management and operations.
  - name: Code Generation
    description: Code Generation for SAML integration
servers:
  - url: /system
paths:
  /saml/identityProvider/metadata:
    get:
      summary: Read Apiture identity provider SAML Metadata
      description: Retrieve the SAML Metadata for the Apiture identity provider.
      operationId: getApitureIdentityProviderSamlMetadata
      x-apiture-api: systemSamlProvider
      x-apiture-unauthenticated: true
      tags:
        - Metadata
      responses:
        '200':
          description: SAML metadata conformant with SAML V2.0 Metadata Interoperability Profile Version 1.0.
          content:
            application/samlmetadata+xml:
              schema:
                $ref: '#/components/schemas/serviceProviderXmlMetadata'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
    put:
      summary: Create or update Apiture SAML identity provider metadata and key
      description: Create or update the Apiture identity provider metadata file and certificate information, including the private key information used by the provider internally.
      operationId: setApitureIdentityProviderMetadataAndCert
      x-apiture-api: systemSamlProvider
      tags:
        - Metadata
      requestBody:
        description: The SAML metadata and X.509 certificate private key information.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/newSamlProviderMetadata'
      security:
        - clientCredentials:
            - samlPlatform/write
      responses:
        '200':
          description: OK. The response is the updated SAML metadata. The private key and password will not be returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/samlProviderMetadata'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /saml/serviceProvider/{serviceProviderMetadataId}/metadata:
    parameters:
      - $ref: '#/components/parameters/serviceProviderMetadataIdPathParam'
    get:
      summary: Return service-provider metadata
      description: Return service-provider metadata reference hosted by Apiture.
      operationId: getHostedServiceProviderMetadata
      x-apiture-api: systemSamlProvider
      x-apiture-unauthenticated: true
      tags:
        - Metadata
      responses:
        '200':
          description: SAML metadata conformant with SAML V2.0 Metadata Interoperability Profile Version 1.0.
          content:
            application/samlmetadata+xml:
              schema:
                $ref: '#/components/schemas/serviceProviderXmlMetadata'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
    delete:
      summary: Delete service-provider metadata
      description: Delete the service-provider metadata reference hosted by Apiture.
      operationId: deleteHostedServiceProviderMetadata
      x-apiture-api: systemSamlProvider
      tags:
        - Metadata
      security:
        - clientCredentials:
            - samlPlatform/write
      responses:
        '204':
          description: No Content.
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
    put:
      summary: Create or update service provider metadata
      description: Create or update service provider metadata hosted by Apiture on behalf of a service provider. The metadata is updated via ADB APIs and services.
      operationId: setHostedServiceProviderMetadata
      x-apiture-api: systemSamlProvider
      tags:
        - Metadata
      security:
        - clientCredentials:
            - samlPlatform/write
      requestBody:
        description: The SAML metadata
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/serviceProviderMetadataRequest'
      responses:
        '200':
          description: OK. The response is the updated SAML metadata. The private key and password will not be returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/samlProviderMetadata'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /saml/algorithms:
    get:
      summary: Retrieve supported signature, digest and encryption algorithms
      description: Returns the lists of algorithms the provider currently supported for the specified function.
      operationId: getSupportedAlgorithms
      x-apiture-api: systemSamlProvider
      tags:
        - Code Generation
      security:
        - clientCredentials:
            - samlPlatform/read
      responses:
        '200':
          description: Return supported signature, digest and encryption algorithms.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/samlAlgorithms'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /saml/request:
    post:
      summary: Generate a SAML Request
      description: Generate a SAML request based on the provided integration definition, customer parameter schema, customer parameter data, and integration data schema. This operation is meant for Apiture Digital Banking back-end use.
      operationId: computeRequest
      x-apiture-api: systemSamlProvider
      tags:
        - Code Generation
      security:
        - clientCredentials:
            - samlPlatform/read
      requestBody:
        description: The details required to compute the SAML request.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/samlRequestInput'
      responses:
        '200':
          description: Successfully computed SAML request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/samlRequest'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          x-apiture-errors:
            - $ref: '#/components/x-apiture-errors/invalidJsonSchema'
            - $ref: '#/components/x-apiture-errors/invalidIntegrationCode'
            - $ref: '#/components/x-apiture-errors/codeExecutionError'
          description: |-
            Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

            This problem response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidJsonSchema/v1.0.0`](https://static.api.apiture.com/errors/invalidJsonSchema/v1.0.0)<br>
              Unable to interpret schema input or convert the schema to TypeScript code.
              Remediation: Correct the code or data according to the `detail` and / or `problems`.
            The `attributes` object in the error may have the properties defined for [`invalidJsonSchema`](https://static.api.apiture.com/errors/invalidJsonSchema/v1.0.0).
            * [`https://static.api.apiture.com/errors/invalidIntegrationCode/v1.0.0`](https://static.api.apiture.com/errors/invalidIntegrationCode/v1.0.0)<br>
              The integration code does not compile.
              Remediation: Correct the code according to the `detail` and / or `problems`.
            The `attributes` object in the error may have the properties defined for [`invalidIntegrationCode`](https://static.api.apiture.com/errors/invalidIntegrationCode/v1.0.0).
            * [`https://static.api.apiture.com/errors/codeExecutionError/v1.0.0`](https://static.api.apiture.com/errors/codeExecutionError/v1.0.0)<br>
              Errors occurred while executing TypeScript code.
              Remediation: Correct the code or data according to the `detail` and / or `problems`.
            The `attributes` object in the error may have the properties defined for [`codeExecutionError`](https://static.api.apiture.com/errors/codeExecutionError/v1.0.0).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /saml/validation:
    post:
      summary: Validate code and schema definitions
      description: Validates that the supplied TypeScript code and schema definitions meet requirements and compile successfully.
      operationId: computeValidate
      x-apiture-api: systemSamlProvider
      tags:
        - Code Generation
      security:
        - clientCredentials:
            - samlPlatform/read
      requestBody:
        description: The code and definitions required to validate the TypeScript.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/integrationValidationRequest'
      responses:
        '200':
          description: The successfully validated information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/integrationValidationResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          x-apiture-errors:
            - $ref: '#/components/x-apiture-errors/invalidJsonSchema'
            - $ref: '#/components/x-apiture-errors/invalidIntegrationCode'
            - $ref: '#/components/x-apiture-errors/codeExecutionError'
          description: |-
            Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

            This problem response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidJsonSchema/v1.0.0`](https://static.api.apiture.com/errors/invalidJsonSchema/v1.0.0)<br>
              Unable to interpret schema input or convert the schema to TypeScript code.
              Remediation: Correct the code or data according to the `detail` and / or `problems`.
            The `attributes` object in the error may have the properties defined for [`invalidJsonSchema`](https://static.api.apiture.com/errors/invalidJsonSchema/v1.0.0).
            * [`https://static.api.apiture.com/errors/invalidIntegrationCode/v1.0.0`](https://static.api.apiture.com/errors/invalidIntegrationCode/v1.0.0)<br>
              The integration code does not compile.
              Remediation: Correct the code according to the `detail` and / or `problems`.
            The `attributes` object in the error may have the properties defined for [`invalidIntegrationCode`](https://static.api.apiture.com/errors/invalidIntegrationCode/v1.0.0).
            * [`https://static.api.apiture.com/errors/codeExecutionError/v1.0.0`](https://static.api.apiture.com/errors/codeExecutionError/v1.0.0)<br>
              Errors occurred while executing TypeScript code.
              Remediation: Correct the code or data according to the `detail` and / or `problems`.
            The `attributes` object in the error may have the properties defined for [`codeExecutionError`](https://static.api.apiture.com/errors/codeExecutionError/v1.0.0).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
  /saml/parameterTypesSource:
    post:
      summary: Compute TypeScript and sample JSON from JSON Schema
      description: Generate a TypeScript fragment for integration JSON schemas. This allows Apiture Digital banking to return TypeScript typing to allow editors to preview and check property names and types in real-time while editing.
      operationId: generateIntegrationSourceCodeAndSampleDataFromJsonSchema
      x-apiture-api: systemSamlProvider
      tags:
        - Code Generation
      security:
        - clientCredentials:
            - samlPlatform/read
      requestBody:
        description: 'Convert input and configuration schema definitions to TypeScript code. This function will output `IntegrationInput` and `ConfigurationValues` definitions based on the supplied schema and also supply `IntegrationOutput` and `MessageOutput` type definitions necessary to define a SAML integration via a function using a method signature "function process(data: IntegrationInput, configuration: ConfigurationValues, output IntegrationOutput, messages: MessageOutput): void".'
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/samlCodeGenerationRequest'
      responses:
        '200':
          description: TypeScript response object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/sourceCodeAndSampleData'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '422':
          x-apiture-errors:
            - $ref: '#/components/x-apiture-errors/invalidJsonSchema'
            - $ref: '#/components/x-apiture-errors/invalidIntegrationCode'
            - $ref: '#/components/x-apiture-errors/codeExecutionError'
          description: |-
            Unprocessable Entity. The request body and/or query parameters were well formed but otherwise invalid.

            This problem response may have one of the following `type` values:
            * [`https://static.api.apiture.com/errors/invalidJsonSchema/v1.0.0`](https://static.api.apiture.com/errors/invalidJsonSchema/v1.0.0)<br>
              Unable to interpret schema input or convert the schema to TypeScript code.
              Remediation: Correct the code or data according to the `detail` and / or `problems`.
            The `attributes` object in the error may have the properties defined for [`invalidJsonSchema`](https://static.api.apiture.com/errors/invalidJsonSchema/v1.0.0).
            * [`https://static.api.apiture.com/errors/invalidIntegrationCode/v1.0.0`](https://static.api.apiture.com/errors/invalidIntegrationCode/v1.0.0)<br>
              The integration code does not compile.
              Remediation: Correct the code according to the `detail` and / or `problems`.
            The `attributes` object in the error may have the properties defined for [`invalidIntegrationCode`](https://static.api.apiture.com/errors/invalidIntegrationCode/v1.0.0).
            * [`https://static.api.apiture.com/errors/codeExecutionError/v1.0.0`](https://static.api.apiture.com/errors/codeExecutionError/v1.0.0)<br>
              Errors occurred while executing TypeScript code.
              Remediation: Correct the code or data according to the `detail` and / or `problems`.
            The `attributes` object in the error may have the properties defined for [`codeExecutionError`](https://static.api.apiture.com/errors/codeExecutionError/v1.0.0).
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/problemResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/problemResponse'
        '429':
          $ref: '#/components/responses/429'
        4XX:
          $ref: '#/components/responses/4XX'
        5XX:
          $ref: '#/components/responses/5XX'
components:
  parameters:
    serviceProviderMetadataIdPathParam:
      name: serviceProviderMetadataId
      description: The service provider metadata identifier. This is an opaque string.
      in: path
      schema:
        $ref: '#/components/schemas/resourceId'
      required: true
  schemas:
    integrationValidationRequest:
      title: Integration Validation Request (v1.0.0)
      description: Integration Validation Request.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - properties:
            integrationDefinition:
              $ref: '#/components/schemas/integrationDefinition'
            inputDataSchema:
              type: string
              maxLength: 102400
              format: json
              description: The input data JSON schema.
      x-apiture-version: 1.0.0
    integrationValidationResponse:
      title: Integration Validation Response (v1.0.0)
      description: Integration Validation Response.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - properties:
            code:
              type: string
              maxLength: 102400
              format: json
              description: The validated TypeScript code including generated type definitions.
      x-apiture-version: 1.0.0
    samlRequestInput:
      title: Saml Request Input (v1.0.0)
      description: Input data to generate a SAML request.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - properties:
            integrationDefinition:
              $ref: '#/components/schemas/integrationDefinition'
            inputDataSchema:
              description: The input data JSON schema.
              $ref: '#/components/schemas/jsonSchema'
            inputData:
              description: Data about the customer gathered by Apiture Digital Banking to provide assertions for the request. The structure of the object needs to conform to the JSON schema supplied by the `inputDataSchema` property.
              $ref: '#/components/schemas/jsonObject'
            parameterData:
              description: Integration instance configuration data supplied by the Apiture Digital Banking platform based on FXIM integration configuration properties. The structure of the object needs to conform to the JSON schema as specified by the `parameterSchema` property of the `integrationDefinition`.
              $ref: '#/components/schemas/jsonObject'
            encrypt:
              type: boolean
              description: Encrypt the SAML assertion values.
              example: true
            sign:
              type: boolean
              description: Sign the resulting SAML request. All SAML requests intended for use in live environments need to be signed. SAML requests intended for debugging or test purposes should not be signed.
              example: true
      x-apiture-version: 1.0.0
    samlCodeGenerationRequest:
      title: Saml Code Generation Request (v1.0.0)
      description: Saml Code Generation Request.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            inputDataSchema:
              description: The input data JSON schema.
              $ref: '#/components/schemas/jsonSchema'
            parameterDataSchema:
              $ref: '#/components/schemas/jsonSchema'
          example:
            inputDataSchema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              properties:
                userName:
                  type: string
                  format: text
                  maxLength: 32
            parameterDataSchema:
              $schema: https://json-schema.org/draft/2020-12/schema'
              type: object
              properties:
                mySetting:
                  type: string
                  format: text
                  maxLength: 120
      x-apiture-version: 1.0.0
    sourceCodeAndSampleData:
      title: Integration Definition Source Code (v1.0.0)
      description: Source code snippet (TypeScript) associated with the integration data and parameters.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - properties:
            code:
              type: string
              maxLength: 102400
              format: text
              description: The TypeScript output.
            sampleData:
              $ref: '#/components/schemas/jsonObject'
              description: The sample data matching the specified JSON schema.
      example:
        code: 'type IntegrationInput = { userName: string }; type ConfigurationValues = { mySetting: string };'
      x-apiture-version: 1.0.0
    samlRequest:
      title: SAML Request (v1.0.0)
      description: SAML Request.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            samlRequest:
              type: string
              format: xml
              description: The SAML request XML output.
              maxLength: 102400
            consoleOutput:
              description: Console output written by the code for logging and debugging purposes.
              type: string
              maxLength: 102400
              format: text
          example:
            samlRequest: |-
              <samlp:AuthnRequest xmlns:samlp='urn:oasis:names:tc:SAML:2.0:protocol'
                                  ID='_aaf23196-1773-2113-474a-fe114412ab72'
                                  Version='2.0' IssueInstant='2004-12-05T09:21:59Z'
                                  Destination='https://idp.example.com/SSOService.php'
                                  ProtocolBinding='urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST'
                                  AssertionConsumerServiceURL='https://sp.example.com/ACS/SSO/SSO.php' />
      x-apiture-version: 1.0.0
    samlAlgorithms:
      title: SAML Algorithms (v1.0.0)
      description: SAML Algorithms.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            signatureAlgorithms:
              type: array
              maxItems: 100
              items:
                type: string
                maxLength: 15
                pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
              description: A list of supported signature algorithms.
            digestAlgorithms:
              type: array
              maxItems: 100
              items:
                type: string
                maxLength: 15
                pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
              description: A list of supported digest algorithms.
            encryptionAlgorithms:
              type: array
              maxItems: 100
              items:
                type: string
                maxLength: 15
                pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
              description: A list of supported encryption algorithms.
          example:
            signatureAlgorithms:
              - RSA-SHA256
              - RSA-SHA512
              - ECDSA-SHA256
            digestAlgorithms:
              - SHA256
              - SHA384
              - SHA512
            encryptionAlgorithms:
              - AES256-GCM
              - AES256-CBC
              - AES192-CBC
      x-apiture-version: 1.0.0
    newSamlProviderMetadata:
      title: Saml Provider Metadata (v1.0.0)
      description: Saml Provider Metadata.
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - type: object
          properties:
            metadata:
              $ref: '#/components/schemas/serviceProviderXmlMetadata'
            privateKey:
              type: string
              maxLength: 4096
              format: text
              description: The private key matching the identity provider public signing certificate. The private key information is expected to be base64 encoded and enclosed between `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----` delimiters.
              example: '-----BEGIN RSA PRIVATE KEY----- [...] -----END RSA PRIVATE KEY-----'
            passphrase:
              type: string
              description: The passphrase used to decrypt the private key.
              maxLength: 255
              format: text
              example: P/\$$w0rdS3cr3+!
      x-apiture-version: 1.0.0
    samlProviderMetadata:
      title: SAML Provider Metadata (v1.0.0)
      description: SAML Provider Metadata.
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - properties:
            metadata:
              type: string
              description: The updated SAML metadata file content.
              maxLength: 102400
              format: xml
            url:
              type: string
              format: uri
              maxLength: 255
              description: The public URL that can be used to retrieve the metadata.
              example: https://auth.apiture.com/identityProvider/metadata
      x-apiture-version: 1.0.0
    serviceProviderXmlMetadata:
      title: Service Provider XML Metadata (v1.0.0)
      description: Service Provider XML Metadata, conformant with [SAML V2.0 Metadata Interoperability Profile Version 1.0](https://docs.oasis-open.org/security/saml/Post2.0/sstc-metadata-iop.pdf)
      type: string
      maxLength: 102400
      format: xml
      example: |-
        <EntityDescriptor ID="63dd531a-0ed9-451d-b2bc-747904ac5870"
          entityID="https://auth.apiture.com/saml"
          validUntil="2025-12-31T23:59:59Z"
          cacheDuration="PT5M"
          xmlns="urn:oasis:names:tc:SAML:2.0:metadata"
          xmlns:saml2="urn:oasis:names:tc:SAML:2.0:assertion">

          <SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol">
              <AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
                                        Location="https://serviceprovider.company.com/saml/acs"
                                        index="1" />
              <AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
                                        Location="https://serviceprovider.company.com/saml/acs"
                                        index="2" />
              <AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Artifact"
                                        Location="https://serviceprovider.company.com/saml/acs"
                                        index="3" />

              <SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST"
                                   Location="https://serviceprovider.company.com/saml/slo" />
              <SingleLogoutService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"
                                   Location="https://serviceprovider.company.com/saml/slo" />

              <ArtifactResolutionService Binding="urn:oasis:names:tc:SAML:2.0:bindings:SOAP"
                                         Location="https://serviceprovider.company.com/saml/ars"
                                         index="0" />

              <KeyDescriptor use="signing">
                  <KeyInfo
                      xmlns="http://www.w3.org/2000/09/xmldsig#">
                      <X509Data>
                          <X509Certificate>SP_PUBLIC_SIGNING_CERTIFICATE_USED_FOR_SIGNING_REQUESTS</X509Certificate>
                      </X509Data>
                  </KeyInfo>
              </KeyDescriptor>

              <KeyDescriptor use="encryption">
                  <KeyInfo
                      xmlns="http://www.w3.org/2000/09/xmldsig#">
                      <X509Data>
                          <X509Certificate>SP_PUBLIC_ENCRYPTION_CERTIFICATE</X509Certificate>
                      </X509Data>
                  </KeyInfo>
                  <EncryptionMethod Algorithm="http://www.w3.org/2009/xmlenc11#aes256-gcm" />
                  <EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#aes256-cbc" />
              </KeyDescriptor>
          </SPSSODescriptor>

          <Organization>
              <OrganizationName xml:lang="en-GB">Service Provider</OrganizationName>
              <OrganizationDisplayName xml:lang="en-GB">Service Provider</OrganizationDisplayName>
              <OrganizationURL xml:lang="en-GB">https://apiture.com/</OrganizationURL>
          </Organization>

          <ContactPerson contactType="technical">
              <Company>Service Provider</Company>
              <GivenName>Responsible</GivenName>
              <SurName>party</SurName>
              <EmailAddress>responsible.party@serviceprovider.com</EmailAddress>
          </ContactPerson>
        </EntityDescriptor>
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/serviceProviderXmlMetadata
      x-apiture-version: 1.0.0
    serviceProviderMetadataRequest:
      title: Service Provider Metadata Request (v1.0.0)
      description: Service Provider Metadata, conformant with [SAML V2.0 Metadata Interoperability Profile Version 1.0](https://docs.oasis-open.org/security/saml/Post2.0/sstc-metadata-iop.pdf)
      type: object
      required:
        - metadata
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/serviceProviderMetadataFields'
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/serviceProviderMetadataRequest
      x-apiture-version: 1.0.0
    problemResponse:
      title: Problem Response (v0.4.1)
      x-apiture-version: 0.4.1
      description: API problem or error response, as per [RFC 9457 application/problem+json](https://tools.ietf.org/html/rfc9457).
      type: object
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/apiProblem'
      example:
        id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
        type: https://static.api.apiture.com/errors/noSuchAccount/v1.0.0
        title: Account Not Found
        status: 422
        occurredAt: '2022-04-25T12:42:21.375Z'
        detail: No account exists for the given account reference
        instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/problemResponse
    resourceId:
      x-apiture-version: 1.0.1
      title: Resource Identifier (v1.0.1)
      description: The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.
      type: string
      pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
      minLength: 6
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/resourceId
    abstractBody:
      title: Abstract Body (v0.2.0)
      x-apiture-version: 0.2.0
      description: An abstract schema used to define other request and response body model schemas.
      x-apiture-fragment: true
      type: object
      properties: {}
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/abstractBody
    integrationDefinition:
      x-apiture-version: 6.0.0
      title: Integration Definition (v6.0.0)
      description: The definition of a third party integration.
      required:
        - id
        - description
        - staged
        - partnerDomain
        - availability
        - state
        - label
        - defaultRelayState
        - usesSpecificCustomerId
      allOf:
        - $ref: '#/components/schemas/abstractBody'
        - $ref: '#/components/schemas/mutableIntegrationDefinitionFields'
        - $ref: '#/components/schemas/immutableIntegrationDefinitionFields'
        - type: object
          properties:
            staged:
              type: boolean
              description: If `true`, the integration definition is staged for deployment but not live in production. If `false`, this is the live, deployed version of an integration definition.
            code:
              title: Integration code
              description: TypeScript code to compute the SAML request assertion values from input data.
              type: string
              format: text
              maxLength: 102400
      example:
        id: MY_INTEG
        description: Fintech1 Integration.
        staged: false
        state: enabled
        activeInstanceCount: 14
        partnerDomain: fintech-partner.com
        availability:
          web: true
          mobile: true
          retail: true
          commercial: true
          institutions: single
        institutionId: TCF
        label: Fintech1 Feature
        mobileLabel: Fintech1 Feature
        usesSpecificCustomerId: true
        specificCustomerIdLabel: Customer Id
        specificCustomerIdDescription: Customer Id
        code: |-
          createSAMLRequest(user: UserData, param: Parameters, integration: Integration) {
            integration.assertions.add('answer', '42');
          }
        audienceUrl: https://my.audience.com/
        defaultRelayState: RelStat123
        signatureAlgorithm: RSA-SHA256
        digestAlgorithm: SHA256
        encryptionAlgorithm: AES256-GCM
        assertionEncryptionSupported: true
        serviceProviderMetadataUrl: https://my.audience.com/saml/metadata.xml
        serviceProviderHostsMetadata: true
        targetMethod: SAML-POST
        targetUrlTemplate: https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D
        createdAt: '2024-10-16T06:04:35.375Z'
        updatedAt: '2024-10-18T07:14:35.0'
        parameterSchema:
          type: object
          properties:
            value1:
              description: ...
              type: string
              format: text
              minLength: 1
              maxLength: 200
            value2:
              description: ...
              type: integer
              format: int32
              minimum: 1
              maximum: 100
            value3:
              description: ...
              type: string
              enum:
                - a
                - b
                - c
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinition
    jsonSchema:
      title: JSON Schema (v1.0.0)
      description: A 2020/12 JSON Schema as per [jsonschema.org](http://jsonschema.org).
      type: object
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/jsonSchema
      x-apiture-version: 1.0.0
    jsonObject:
      title: JSON Object (v1.0.0)
      description: A JSON object.
      type: object
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/jsonObject
      x-apiture-version: 1.0.0
    serviceProviderMetadataFields:
      title: Service Provider Metadata Fields (v1.0.0)
      description: Properties used to construct other service provider schema.
      x-apiture-fragment: true
      properties:
        metadata:
          $ref: '#/components/schemas/serviceProviderXmlMetadata'
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/serviceProviderMetadataFields
      x-apiture-version: 1.0.0
    apiProblem:
      x-apiture-version: 1.2.1
      title: API Problem (v1.2.1)
      description: API problem or error, as per [RFC 7807 application/problem+json](https://tools.ietf.org/html/rfc7807).
      type: object
      properties:
        type:
          type: string
          format: uri-reference
          description: |
            A [URI reference (RFC3986)](https://tools.ietf.org/html/rfc3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be `"about:blank"`.
          example: https://static.api.apiture.com/errors/forbidden/v1.0.0
          maxLength: 2048
        title:
          type: string
          description: |
            A short, human-readable summary of the problem type. The title is usually the same for all problem with the same `type`.
          maxLength: 120
          format: text
          example: User is not authorized to perform the requested action or access the requested resource.
        status:
          type: integer
          format: int32
          description: |
            The [HTTP status code](https://datatracker.ietf.org/doc/html/rfc7231#section-6) for this occurrence of the problem.
          minimum: 100
          maximum: 599
          example: 403
        detail:
          type: string
          description: |
            A human-readable explanation specific to this occurrence of the problem.
          maxLength: 256
          format: text
          example: User is not authorized to perform this operation.
        instance:
          type: string
          format: uri-reference
          description: |
            A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment
          example: https://prduction.api.apiture.com/banking/accounts/ad80fc3e722q5402a#189c13ff-c54c-45f7-b8e0-c88984ba724d
          maxLength: 2048
        id:
          description: The unique identifier for this problem. This is an immutable opaque string.
          $ref: '#/components/schemas/readOnlyResourceId'
        occurredAt:
          description: The timestamp when the problem occurred, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC.
          $ref: '#/components/schemas/readOnlyTimestamp'
        problems:
          description: Optional root-causes if there are multiple problems in the request or API call processing.
          type: array
          maxItems: 128
          items:
            $ref: '#/components/schemas/apiProblem'
        attributes:
          type: object
          description: Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.
      example:
        id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
        type: https://static.api.apiture.com/errors/accountNotFound/v1.0.0
        title: Account Not Found
        status: 422
        occurredAt: '2022-04-25T12:42:21.375Z'
        detail: No account exists at the given account_url
        instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/apiProblem
    requiredIdentityChallenge:
      x-apiture-version: 1.2.3
      title: Required Challenge (v1.2.3)
      description: A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 [Unauthorized problem response](#schema-apiProblem) when the 401 problem type name is `challengeRequired`. See the "Challenge API" for details.
      type: object
      required:
        - operationId
        - challengeId
        - factors
      properties:
        operationId:
          $ref: '#/components/schemas/challengeOperationId'
        challengeId:
          description: The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses.
          $ref: '#/components/schemas/readOnlyResourceId'
        factors:
          description: 'A list of challenge factors. The user must complete one of these challenge factors. The `labels` in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. ***Note**: The same channel may be used by multiple factors in the array of factors. For example, the user''s primary mobile phone number may be used for both an `sms` factor and a `voice` factor.'
          type: array
          minItems: 1
          maxItems: 8
          items:
            $ref: '#/components/schemas/challengeFactor'
      example:
        operationId: createTransfer
        challengeId: 0504076c566a3cf7009c
        factors:
          - type: sms
            labels:
              - '9876'
            id: 85c0ee5753fcd0b0953f
          - type: voice
            labels:
              - '9876'
            id: d089e10a80a8627df37b
          - type: voice
            labels:
              - '6754'
            id: 10506ecf9d1c2ee00403
          - type: email
            labels:
              - an****nk@example.com
              - an****98@example.com
            id: e917d671cb2f030b56f1
          - type: authenticatorToken
            labels:
              - Acme fob
            id: fe6c452d7da0bbb4e407
          - type: securityQuestions
            securityQuestions:
              questions:
                - id: q1
                  prompt: What is your mother's maiden name?
                - id: q4
                  prompt: What is your high school's name?
                - id: q9
                  prompt: What is the name of your first pet?
            id: df33c6f88a37d6b3f0a6
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/requiredIdentityChallenge
    mutableIntegrationDefinitionFields:
      x-apiture-version: 3.0.0
      title: Mutable Integration Definition Fields (v3.0.0)
      description: Mutable Integration Definition fields used to compose other schemas.
      x-apiture-fragment: true
      type: object
      properties:
        description:
          description: The description of the client application.
          type: string
          format: text
          minLength: 4
          maxLength: 4000
        label:
          description: The label to be used in the online banking web client menu.
          type: string
          maxLength: 128
          minLength: 4
          format: text
        mobileLabel:
          description: The label to be used in the mobile banking application, if different from the `label`.
          type: string
          maxLength: 128
          minLength: 4
          format: text
        availability:
          $ref: '#/components/schemas/integrationDefinitionAvailability'
        institutionId:
          description: The unique immutable identifier of the financial institution the integration definition is executed for. The identifier is used for logging purposes. Only applicable if `availability.institutions` is `single`.
          $ref: '#/components/schemas/institutionId'
        audienceUrl:
          description: The audience URL for the SAML request.
          type: string
          format: uri
          maxLength: 255
        defaultRelayState:
          description: The default relay state for the SAML request.
          type: string
          format: text
          maxLength: 255
        signatureAlgorithm:
          description: The signature algorithm used for the SAML request. The value has to match one of the `signatureAlgorithms` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: string
          maxLength: 15
          pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
        digestAlgorithm:
          description: The digest / hash algorithm used for the SAML request. The value has to match one of the `digestAlgorithms` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: string
          maxLength: 15
          pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
        encryptionAlgorithm:
          description: The encryption algorithm used for the SAML request. The value has to match one of the `encryptionAlgorithms` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: string
          maxLength: 15
          pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
        assertionEncryptionSupported:
          description: '`true` if this integration supports assertion value encryption.'
          type: boolean
        serviceProviderHostsMetadata:
          description: If `true`, the SAML metadata at the `serviceProviderMetadataUrl` is hosted by the service provider. If `false`, the `serviceProviderMetadataUrl` represents a relative path.
          type: boolean
        serviceProviderMetadataUrl:
          description: The SAML Metadata URL for the service provider integration target. When `serviceProviderHostsMetadata` is `false`, this is assumed to point to an URL hosted by the Apiture platform provider,
          type: string
          format: uri-reference
          minLength: 1
          maxLength: 255
          example: https://auth.apiture.com/saml/sp/743d1fe4-f123-488e-9a20-1b5194bfa86c/metadata
        parameterSchema:
          description: JSON schema defining custom integration parameters required by the integration. The integration instance values for these parameters are configured in the financial institution admin application.
          $ref: '#/components/schemas/jsonObject'
        requiredProperties:
          description: Additional properties, separate from customer, institution, integration and environment properties, that this integration requires to be set. Each value has to match the `name` of one of the `additionalProperties` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: array
          maxItems: 100
          items:
            $ref: '#/components/schemas/integrationPropertyName'
        usesSpecificCustomerId:
          description: If `true`, the integration uses an integration-specific customer identifier. A value for an integration-specific customer identifier has to be provided when defining an integration instance in the administration API.
          type: boolean
        specificCustomerIdLabel:
          description: Label for the integration-specific customer identifier shown in the financial institution admin application. when defining an integration instance in the administration API. Required if `usesSpecificCustomerId` is `true`.
          type: string
          format: text
          minLength: 1
          maxLength: 255
        specificCustomerIdDescription:
          description: Description for the integration-specific customer identifier when defining an integration instance in the administration API. Required if `usesSpecificCustomerId` is `true`.
          type: string
          format: text
          minLength: 1
          maxLength: 255
        targetUrlTemplate:
          description: The URL template to redirect or post to (depending on the `targetMethod`). The URL template string may contain one or more of the substitution variables `{{base64Saml}}`, `{{institutionId}}`, `{{configuration.<name>}}`,`{{vendorCustId}}`. The respective value(s) for the variable is replaced at runtime. For example, when the configuration for `vendorCustomerId` for an instance is set to `fin` in the financial institution admin application, The URL `https://{{configuration.vendorCustomerId}}.foo.com/` translates to `https://fin.foo.com/`.
          type: string
          format: uri
          minLength: 1
          maxLength: 255
        targetMethod:
          description: The method used to provide the data to the integration target. The value has to match one of the `targetMethods` returned by [`getSupportedIntegrationParameters`](#op-getSupportedIntegrationParameters).
          type: string
          minLength: 1
          maxLength: 15
          pattern: ^[-a-zA-Z0-9-_ ]{0,15}$
      example:
        id: MY_INTEG
        description: Fintech1 Integration.
        staged: false
        state: enabled
        activeInstanceCount: 14
        label: Fintech1 SSO Integration
        mobileLabel: Fintech1 feature
        usesSpecificCustomerId: true
        specificCustomerIdLabel: Customer ID
        specificCustomerIdDescription: Unique Fintech1 Customer ID (GUID)
        availability:
          web: true
          mobile: true
          retail: true
          commercial: true
          institutions: single
        institutionId: TCF
        partnerDomain: fintech-partner.com
        audienceUrl: https://my.audience.com/
        defaultRelayState: RelStat123
        signatureAlgorithm: RSA-SHA256
        digestAlgorithm: SHA256
        encryptionAlgorithm: AES256-GCM
        assertionEncryptionSupported: true
        serviceProviderMetadataUrl: https://my.audience.com/saml/metadata.xml
        serviceProviderHostsMetadata: true
        targetMethod: SAML-POST
        targetUrlTemplate: https://my-integration.example.com/sp/saml?cust=%7B%7BinstitutionId%7D%7D
        parameterSchema:
          type: object
          properties:
            value1:
              description: ...
              type: string
              format: text
              minLength: 1
              maxLength: 200
            value2:
              description: ...
              type: integer
              format: int32
              minimum: 1
              maximum: 100
            value3:
              description: ...
              type: string
              enum:
                - a
                - b
                - c
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/mutableIntegrationDefinitionFields
    immutableIntegrationDefinitionFields:
      x-apiture-version: 3.0.0
      title: Immutable Integration Definition Fields (v3.0.0)
      description: Immutable Integration Definition Fields.
      x-apiture-fragment: true
      type: object
      allOf:
        - $ref: '#/components/schemas/timestampFields'
        - properties:
            id:
              description: A client-specified ID for this integration. If omitted, the system will generate a unique ID.
              $ref: '#/components/schemas/integrationDefinitionId'
            partnerDomain:
              description: The unique ID of the partner who implements the integration.
              $ref: '#/components/schemas/integrationPartnerDomain'
            state:
              $ref: '#/components/schemas/integrationDefinitionState'
            activeInstanceCount:
              type: integer
              minimum: 0
              maximum: 10000
              format: int32
              description: The number of active (not disabled) integration instances configured for this integration definition. Integration definitions that have an `activeInstanceCount` greater than 0 cannot be deleted.
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/immutableIntegrationDefinitionFields
    readOnlyResourceId:
      x-apiture-version: 1.0.1
      title: Read-only Resource Identifier (v1.0.1)
      description: The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.
      readOnly: true
      allOf:
        - $ref: '#/components/schemas/resourceId'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/readOnlyResourceId
    readOnlyTimestamp:
      title: Read-Only Timestamp (v1.0.0)
      description: 'A readonly or derived timestamp (an instant in time) formatted in [RFC 3339](https://tools.ietf.org/html/rfc3339) `date-time` UTC format: `YYYY-MM-DDThh:mm:ss.sssZ`.'
      type: string
      minLength: 20
      maxLength: 30
      format: date-time
      readOnly: true
      example: '2021-10-30T19:06:04.250Z'
      x-apiture-since: 0.4.0
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/readOnlyTimestamp
      x-apiture-version: 1.0.0
    challengeOperationId:
      x-apiture-version: 1.0.1
      title: Challenge Operation ID (v1.0.1)
      description: The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.
      type: string
      pattern: ^[-a-zA-Z0-9$_]{6,48}$
      minLength: 6
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeOperationId
    challengeFactor:
      x-apiture-version: 1.2.1
      title: Challenge Factor (v1.2.1)
      description: A challenge factor. See [`requiredIdentityChallenge`](#schema-requiredIdentityChallenge) for multiple examples.
      type: object
      required:
        - type
      properties:
        id:
          description: |-
            The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this `id` value as the `factorId` when starting or verifying a challenge factor.

            *Note*: The `id` will become `required` in a future update to this schema.
          $ref: '#/components/schemas/challengeFactorId'
        type:
          $ref: '#/components/schemas/challengeFactorType'
        labels:
          description: A list of text label which identifies the channel(s) through which the user completes the challenge. For an `sms` or `voice` challenge, the only label item is the last four digits of the corresponding phone number. For an `email` challenge, each label is the masked email address.
          type: array
          minItems: 1
          maxItems: 4
          items:
            type: string
            maxLength: 300
            format: text
        securityQuestions:
          $ref: '#/components/schemas/challengeSecurityQuestions'
      example:
        type: sms
        labels:
          - '9876'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeFactor
    integrationDefinitionAvailability:
      x-apiture-version: 3.0.0
      title: Integration Definition Availability (v3.0.0)
      description: Defines the run-time contexts in which this integration is available.
      type: object
      required:
        - web
        - mobile
        - retail
        - commercial
        - institutions
      properties:
        web:
          description: The integration is available within the online banking (web) client application.
          type: boolean
        mobile:
          description: The integration is available within the mobile application.
          type: boolean
        retail:
          description: The integration is available to retail (personal) banking customers.
          type: boolean
          x-apiture-note: formerly called _personal_
        commercial:
          description: The integration is available to commercial (business and small business ) banking customers.
          x-apiture-note: formerly called _business_
          type: boolean
        institutions:
          $ref: '#/components/schemas/integrationDefinitionInstitutionAvailability'
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinitionAvailability
    institutionId:
      x-apiture-version: 1.1.0
      title: Institution ID (v1.1.0)
      description: The unique immutable identifier of a financial institution.
      type: string
      pattern: ^[A-Z0-9_]{2,8}$
      maxLength: 8
      minLength: 2
      example: TIBURON
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/institutionId
    integrationPropertyName:
      title: Integration Property Name (v1.0.0)
      description: The name of a data property that may be assigned in an integration.
      type: string
      pattern: ^[a-zA-Z][a-zA-Z0-9]{1,31}$
      minLength: 2
      maxLength: 32
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/integrationPropertyName
      x-apiture-version: 1.0.0
    timestampFields:
      x-apiture-version: 1.1.0
      title: Timestamp Fields (v1.1.0)
      description: Timestamps which describe when a resource was created or last updated.
      x-apiture-fragment: true
      allOf:
        - $ref: '#/components/schemas/createdAtField'
        - type: object
          properties:
            updatedAt:
              description: The date-time when the resource was last updated, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.
              $ref: '#/components/schemas/readOnlyTimestamp'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/timestampFields
    integrationDefinitionId:
      title: Integration Definition Identifier (v1.0.0)
      description: The unique, human-readable identifier for the integration definition.
      type: string
      minLength: 2
      maxLength: 16
      pattern: ^[A-Z0-9_]{2,16}$
      example: ULTRA_PAY
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinitionId
      x-apiture-version: 1.0.0
    integrationPartnerDomain:
      title: Integration Partner Domain (v1.0.0)
      description: The internet domain name (in lowercase) of an integration partner.
      type: string
      format: text
      minLength: 4
      maxLength: 100
      pattern: ^((?!-))(xn--)?[a-z0-9][a-z0-9-_]{0,61}[a-z0-9]{0,1}\.(xn--)?([a-z0-9\-]{1,61}|[a-z0-9-]{1,30}\.[a-z]{2,})$
      example: fintech-partner.com
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/integrationPartnerDomain
      x-apiture-version: 1.0.0
    integrationDefinitionState:
      title: Integration Definition State (v1.0.0)
      description: |+
        The state of an integration definition.

        <strong><code>integrationDefinitionState</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>disabled</code></strong></td><td>Disabled</td>
            </tr>
        <tr>
            <td><strong><code>enabled</code></strong></td><td>Enabled</td>
            </tr>
        </table>

      type: string
      x-apiture-enum: integrationDefinitionState
      enum:
        - disabled
        - enabled
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinitionState
      x-apiture-version: 1.0.0
    challengeFactorId:
      title: Challenge Factor ID (v1.0.0)
      description: The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.
      type: string
      pattern: ^[-a-zA-Z0-9$_]{3,48}$
      minLength: 3
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeFactorId
      x-apiture-version: 1.0.0
    challengeFactorType:
      title: Challenge Factor Type (v1.0.0)
      description: |+
        The name of challenge factor.

        <strong><code>challengeFactorType</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>sms</code></strong></td><td>SMS: <p>One-time passcode sent to the primary mobile phone number</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>email</code></strong></td><td>Email: <p>One-time passcode sent to the primary email address</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>voice</code></strong></td><td>Voice: <p>One-time passcode communicated via automated voice phone call</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>authenticatorToken</code></strong></td><td>authenticator Token: <p>One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>securityQuestions</code></strong></td><td>Security Questions: <p>Prompt with the user&#39;s security questions registered with their security profile</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: challengeFactorType
      enum:
        - sms
        - email
        - voice
        - securityQuestions
        - authenticatorToken
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeFactorType
      x-apiture-version: 1.0.0
    challengeSecurityQuestions:
      x-apiture-version: 1.0.1
      title: Challenge Security Questions (v1.0.1)
      description: Describes a `securityQuestions` challenge. This is omitted if the challenge `type` is not `securityQuestions`.
      type: object
      required:
        - questions
      properties:
        questions:
          description: The array of security questions.
          type: array
          minItems: 1
          maxItems: 8
          items:
            $ref: '#/components/schemas/challengeSecurityQuestion'
      example:
        questions:
          - id: q1
            prompt: What is your mother's maiden name?
          - id: q4
            prompt: What is your high school's name?
          - id: q9
            prompt: What is the name of your first pet?
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeSecurityQuestions
    integrationDefinitionInstitutionAvailability:
      title: Integration Definition Visibility (v1.0.0)
      description: |+
        Integration Definition Visibility.

        <strong><code>integrationDefinitionInstitutionAvailability</code></strong> strings may have one of the following
        [enumerated values](https://developer.apiture.com/docs/concepts/label-groups#enumerations):

        <table>
        <tr>
          <th>Value</th><th>Description</th>
        </tr>

        <tr>
            <td><strong><code>single</code></strong></td><td>Single Institution: <p>The integration is only available to a single financial institution</p>
        </td>
            </tr>
        <tr>
            <td><strong><code>all</code></strong></td><td>All Institutions: <p>The integration is available to all financial institutions</p>
        </td>
            </tr>
        </table>

      type: string
      x-apiture-enum: integrationDefinitionInstitutionAvailability
      enum:
        - single
        - all
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/schemas/integrationDefinitionInstitutionAvailability
      x-apiture-version: 1.0.0
    createdAtField:
      description: A field used to represent the `createdAt` date-time for a resource.
      x-apiture-fragment: true
      type: object
      properties:
        createdAt:
          description: The date-time when this resource was created, in [RFC 3339](https://tools.ietf.org/html/rfc3339) date-time `YYYY-MM-DDThh:mm:ss.sssZ` format, UTC. This is derived and immutable.
          $ref: '#/components/schemas/readOnlyTimestamp'
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/createdAtField
      x-apiture-version: 1.0.0
      title: ' (v1.0.0)'
    challengeSecurityQuestion:
      x-apiture-version: 1.0.1
      title: Challenge Security Question (v1.0.1)
      description: A single security question within the `questions` array of the [`challengeSecurityQuestions`](#schema-challengeSecurityQuestions)
      type: object
      required:
        - id
        - prompt
      properties:
        id:
          description: The unique ID of security question prompt. This should be included in the [`challengeVerification`](#schema-challengeVerification) response as the `promptId`.
          $ref: '#/components/schemas/challengePromptId'
        prompt:
          description: The text prompt of this security question.
          type: string
          format: text
          maxLength: 80
      example:
        id: 74699fa628911e762ea5
        prompt: What is your mother's maiden name?
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengeSecurityQuestion
    challengePromptId:
      title: Challenge Prompt ID (v1.0.0)
      description: The unique ID of a prompt (such as a security question) in a challenge factor.
      type: string
      pattern: ^[-_:.~$a-zA-Z0-9]+$
      minLength: 1
      maxLength: 48
      x-resolved-from: ../../common/openapi.yaml#/components/schemas/challengePromptId
      x-apiture-version: 1.0.0
  securitySchemes:
    clientCredentials:
      type: oauth2
      description: Client Credentials OAuth2 flow that allows a secure service application to access resources. (This access is not used with insecure clients such as web or mobile applications.) See details at [Secure Access](https://dx.apiture.com/docs/api/guides/secure-access/).
      flows:
        clientCredentials:
          tokenUrl: https://dev-oidc.apiture-comm-nonprod.com/oidc/token
          scopes:
            bankingAdmin/read: Read a wide variety of banking and other financial institution and customer data.
            bankingAdmin/write: Write a wide variety of banking and other financial institution and customer data.
            adminData/read: Read access to non-banking data and resources.
            adminData/write: Read, write, and delete access to non-banking data and resources.
            samlPlatform/write: Write access to security-critical Apiture internal key and certificate data.
            samlPlatform/read: Read access to integration resources, e.g. supported codes.
            samlAdmin/write: Write, delete and execute access to service provider metadata and SAML computation operations.
            systemIntegrations/read: Read access to integration definition resources.
            systemIntegrations/write: Write, delete and execute access to integration definition resources.
      x-resolved-from: ../../common/openapi.yaml#/components/securitySchemes/clientCredentials
  responses:
    '400':
      description: |
        Bad Request. The request body, request headers, and/or query parameters are not well-formed.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/badRequest/v1.0.0`](https://static.api.apiture.com/errors/badRequest/v1.0.0)<br>
          The request body and/or parameters was not well-formed.
          Remediation: Correct any syntax or schema errors in the request body or parameters.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/badRequest'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/badRequest/v1.0.0
              title: Bad Request
              status: 400
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: Input did not parse as JSON
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/badRequest/v1.0.0
              title: Bad Request
              status: 400
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: Input did not parse as JSON
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/400
    '401':
      description: |
        Unauthorized. The operation requires authentication but no authentication or insufficient authentication was given.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/unauthorized/v1.0.0`](https://static.api.apiture.com/errors/unauthorized/v1.0.0)<br>
          The request lacks valid authentication credentials for the target resource or operation.
          Remediation: Authenticate the user and pass the required authorization with the request.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/unauthorized'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/unauthorized/v1.0.0
              title: Unauthorized
              status: 401
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request lacks valid authentication credentials
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/unauthorized/v1.0.0
              title: Unauthorized
              status: 401
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request lacks valid authentication credentials
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/401
    '403':
      description: |
        Forbidden. The authenticated caller is not authorized to perform the requested operation.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/forbidden/v1.0.0`](https://static.api.apiture.com/errors/forbidden/v1.0.0)<br>
          The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access.
          Remediation: Check the user's permissions and entitlements before attempting the operation.

        * [`https://static.api.apiture.com/errors/customerDisabled/v1.0.0`](https://static.api.apiture.com/errors/customerDisabled/v1.0.0)<br>
          The customer is disabled.
          Remediation: Have the customer contact the financial institution for support.

        * [`https://static.api.apiture.com/errors/antiMalwareRequired/v1.0.0`](https://static.api.apiture.com/errors/antiMalwareRequired/v1.0.0)<br>
          The financial institution requires the customer to have anti-malware software installed.
          Remediation: Direct the user to the software requirements guide to install the correct anti-malware software.

        * [`https://static.api.apiture.com/errors/modificationForbidden/v1.0.0`](https://static.api.apiture.com/errors/modificationForbidden/v1.0.0)<br>
          The customer is properly authenticated but not authorized to create, modify, or delete resources.
          Remediation: Avoid modification operation for customers with read-only authorization.

        * [`https://static.api.apiture.com/errors/challengeRequired/v1.0.0`](https://static.api.apiture.com/errors/challengeRequired/v1.0.0)<br>
          The operation requires the customer to complete an identity challenge.
          Remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call.
        The `attributes` object in the error may have the properties defined by the [`requiredIdentityChallenge` schema](#schema-requiredIdentityChallenge).
        * [`https://static.api.apiture.com/errors/challengeBlocked/v1.0.0`](https://static.api.apiture.com/errors/challengeBlocked/v1.0.0)<br>
          The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication.
          Remediation: Have the user end their login session and login again.

        * [`https://static.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0`](https://static.api.apiture.com/errors/noIdentityChallengeFactors/v1.0.0)<br>
          This operation requires an identity challenge, but the user does not have the necessary registered authentication factors.
          Remediation: Have the user register one or more challenge security code delivery factors.

        * [`https://static.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0`](https://static.api.apiture.com/errors/invalidIdentityChallengeHeader/v1.0.0)<br>
          The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid.
          Remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/forbidden'
        - $ref: '#/components/x-apiture-errors/customerDisabled'
        - $ref: '#/components/x-apiture-errors/antiMalwareRequired'
        - $ref: '#/components/x-apiture-errors/modificationForbidden'
        - $ref: '#/components/x-apiture-errors/challengeRequired'
        - $ref: '#/components/x-apiture-errors/challengeBlocked'
        - $ref: '#/components/x-apiture-errors/noIdentityChallengeFactors'
        - $ref: '#/components/x-apiture-errors/invalidIdentityChallengeHeader'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/forbidden/v1.0.0
              title: Forbidden
              status: 403
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request has valid authentication, but the authenticated agent is forbidden from accessing this resource or operation
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/forbidden/v1.0.0
              title: Forbidden
              status: 403
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The request has valid authentication, but the authenticated agent is forbidden from accessing this resource or operation
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/403
    '404':
      description: |
        Not found. There is no such resource at the request URL.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/notFound/v1.0.0`](https://static.api.apiture.com/errors/notFound/v1.0.0)<br>
          The resource at the requested URL does not exist.
          Remediation: Use the URL of an existing resource.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/notFound'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/notFound/v1.0.0
              title: Not Found
              status: 404
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The resource at the request URL does not exist.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/notFound/v1.0.0
              title: Not Found
              status: 404
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The resource at the request URL does not exist.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/404
    '429':
      description: |
        Too Many Requests. The client has sent too many requests in a given amount of time.

        This problem response may have one of the following `type` values:
        * [`https://static.api.apiture.com/errors/tooManyRequests/v1.0.0`](https://static.api.apiture.com/errors/tooManyRequests/v1.0.0)<br>
          The client has sent too many requests in a given amount of time, exceeding rate limiting.
          Remediation: Slow down the rate of API calls.
      x-apiture-errors:
        - $ref: '#/components/x-apiture-errors/tooManyRequests'
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/tooManyRequests/v1.0.0
              title: Too Many Requests
              status: 429
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The user has sent too many requests in a given amount of time.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/tooManyRequests/v1.0.0
              title: Too Many Requests
              status: 429
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The user has sent too many requests in a given amount of time.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/429
    4XX:
      description: Client Request Problem. The client request had a problem not listed under another specific 400-level HTTP response code. View the `detail` in the problem response for additional details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/methodNotAllowed/v1.0.0
              title: Method Not Allowed
              status: 405
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: This HTTP method is not allowed for the given resource URL.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/methodNotAllowed/v1.0.0
              title: Method Not Allowed
              status: 405
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: This HTTP method is not allowed for the given resource URL.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/4XX
    5XX:
      description: Server Problem. The server encountered a problem not listed under another specific 500-level HTTP response code. View the `detail` in the problem response for additional details.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/gatewayTimeout/v1.0.0
              title: Insufficient Storage
              status: 507
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The server is unable to store the representation needed to successfully complete the request.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
        application/json:
          schema:
            $ref: '#/components/schemas/problemResponse'
            example:
              id: 3fbad566-be86-4b22-9ba6-3ca99fdc0799
              type: https://static.api.apiture.com/errors/gatewayTimeout/v1.0.0
              title: Insufficient Storage
              status: 507
              occurredAt: '2022-04-25T12:42:21.375Z'
              detail: The server is unable to store the representation needed to successfully complete the request.
              instance: https://static.api.apiture.com/banking/transfers/bb709151-575041fcd617
      x-resolved-from: ../../common/openapi.yaml#/components/responses/5XX
  x-apiture-errors:
    invalidJsonSchema:
      description: Unable to interpret schema input or convert the schema to TypeScript code.
      remediation: Correct the code or data according to the `detail` and / or `problems`
      attributes:
        properties:
          problems:
            description: Describes why the operation failed, providing an array of JSON schema and/or TypeScript errors.
            type: array
            maxItems: 1000
            items:
              $ref: '#/components/schemas/apiProblem'
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/x-apiture-errors/invalidJsonSchema
    invalidIntegrationCode:
      description: The integration code does not compile
      remediation: Correct the code according to the `detail` and / or `problems`
      attributes:
        properties:
          problems:
            description: Describes why the operation failed, providing an array of JSON schema and/or TypeScript errors.
            type: array
            maxItems: 1000
            items:
              $ref: '#/components/schemas/apiProblem'
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/x-apiture-errors/invalidIntegrationCode
    codeExecutionError:
      description: Errors occurred while executing TypeScript code.
      remediation: Correct the code or data according to the `detail` and / or `problems`
      attributes:
        properties:
          problems:
            description: Describes why the operation failed, providing an array of TypeScript runtime error messages. The list can include errors related to limits enforced by the execution engine such as timeouts.
            type: array
            maxItems: 1000
            items:
              $ref: '#/components/schemas/apiProblem'
          consoleOutput:
            description: Console output written by the code until execution was aborted.
            type: string
            format: text
            maxLength: 102400
      x-resolved-from: ../../systemIntegrationDefinitions/openapi.yaml#/components/x-apiture-errors/codeExecutionError
    badRequest:
      description: The request body and/or parameters was not well-formed.
      remediation: Correct any syntax or schema errors in the request body or parameters.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/badRequest
    unauthorized:
      description: The request lacks valid authentication credentials for the target resource or operation.
      remediation: Authenticate the user and pass the required authorization with the request.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/unauthorized
    forbidden:
      description: The user or agent is not allowed to perform this operation; authentication credentials were provided in the request, but the server considers them insufficient to grant access.
      remediation: Check the user's permissions and entitlements before attempting the operation.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/forbidden
    customerDisabled:
      description: The customer is disabled.
      remediation: Have the customer contact the financial institution for support.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/customerDisabled
    antiMalwareRequired:
      description: The financial institution requires the customer to have anti-malware software installed.
      remediation: Direct the user to the software requirements guide to install the correct anti-malware software.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/antiMalwareRequired
    modificationForbidden:
      description: The customer is properly authenticated but not authorized to create, modify, or delete resources.
      remediation: Avoid modification operation for customers with read-only authorization.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/modificationForbidden
    challengeRequired:
      description: The operation requires the customer to complete an identity challenge.
      remediation: Complete the challenge as per the problem response, and add an additional `Challenge` header to the call.
      attributes:
        $ref: '#/components/schemas/requiredIdentityChallenge'
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/challengeRequired
    challengeBlocked:
      description: The user has failed challenges too many times and is blocked from attempting more or performing operations which require additional authentication.
      remediation: Have the user end their login session and login again.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/challengeBlocked
    noIdentityChallengeFactors:
      description: This operation requires an identity challenge, but the user does not have the necessary registered authentication factors.
      remediation: Have the user register one or more challenge security code delivery factors.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/noIdentityChallengeFactors
    invalidIdentityChallengeHeader:
      description: The additional on-time `Challenge` header in this request is expired, already used, or otherwise invalid.
      remediation: Supply a valid, unexpired, unclaimed `Challenge` header in the request.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/invalidIdentityChallengeHeader
    notFound:
      description: The resource at the requested URL does not exist.
      remediation: Use the URL of an existing resource.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/notFound
    tooManyRequests:
      description: The client has sent too many requests in a given amount of time, exceeding rate limiting.
      remediation: Slow down the rate of API calls.
      x-resolved-from: ../../common/openapi.yaml#/components/x-apiture-errors/tooManyRequests
x-resolved-from: ../../systemSamlProvider/status-codes-openapi.yaml
x-resolved-at: '2024-12-09T22:13:23.169Z'
x-apiture-annotated-at: '2024-12-09T22:13:23.421Z'
