openapi: 3.2.0
info:
  title: Identity Authentication Providers API
  version: 1.0.0
servers:
- url: https://test.api.solvimon.com
  description: The TEST environment for our API
- url: https://api.solvimon.com
  description: The live environment for our API
tags:
- name: Authentication Providers
paths:
  /v{version}/authentication-providers/enabled:
    post:
      operationId: postAuthenticationProvidersEnabled
      summary: Retrieve a list of enabled authentication providers that can be used to…
      tags:
      - Authentication Providers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationProviderResponseWrapper'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationProviderRequestCreateRequest'
  /v{version}/authentication-providers:
    get:
      operationId: getAuthenticationProviders
      summary: Retrieve a list of configured authentication providers
      tags:
      - Authentication Providers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: limit
        in: query
        description: The amount of records shown in the list
        required: false
        schema:
          type: integer
      - name: page
        in: query
        description: The page which is going to be shown
        required: false
        schema:
          type: integer
      - name: order_by
        in: query
        description: The parameter by which the response is ordered.
        required: false
        schema:
          type: string
      - name: order_direction
        in: query
        description: The order direction by which the response is ordered.
        required: false
        schema:
          type: string
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationProviderResponseWrapper'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    post:
      operationId: postAuthenticationProviders
      summary: Create a authentication provider configuration
      tags:
      - Authentication Providers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationProvider'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationProviderCreateRequest'
  /v{version}/authentication-providers/{resourceId}:
    get:
      operationId: getAuthenticationProvidersByResourceId
      summary: Get authentication provider by ID
      tags:
      - Authentication Providers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationProvider'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
    patch:
      operationId: patchAuthenticationProvidersByResourceId
      summary: Get authentication provider by ID
      tags:
      - Authentication Providers
      parameters:
      - name: version
        in: path
        description: version
        required: true
        schema:
          type: string
          default: '1'
      - name: resourceId
        in: path
        description: The ID of the resource to be requested.
        required: true
        schema:
          type: string
          default: ''
      - name: X-API-KEY
        in: header
        required: true
        schema:
          type: string
      - name: x-platform-id
        in: header
        description: Platform ID.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationProvider'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthenticationProviderUpdateRequest'
components:
  schemas:
    AuthenticationProviderUpdateRequestType:
      type: string
      enum:
      - DEFAULT
      - SSO
      title: AuthenticationProviderUpdateRequestType
    SSOVariantUpdateRequest:
      type: object
      properties:
        variant:
          $ref: '#/components/schemas/SsoVariantUpdateRequestVariant'
        allowed_domains:
          type: array
          items:
            type: string
        okta:
          $ref: '#/components/schemas/SSOAuthenticationProviderVariantSettings'
        microsoft:
          $ref: '#/components/schemas/SSOAuthenticationProviderVariantSettings'
      title: SSOVariantUpdateRequest
    ApiErrorCode:
      type: string
      enum:
      - RESOURCE_NOT_FOUND
      - RESOURCES_NOT_FOUND
      - UNABLE_TO_PROCESS_INSTRUCTIONS
      - BAD_REQUEST
      - UNSUPPORTED_MEDIA_TYPE
      - RESOURCE_ALREADY_EXISTS
      - CUSTOM_FIELD_VALUE_ALREADY_EXISTS
      - COULD_NOT_CREATE_RESOURCE
      - COULD_NOT_UPDATE_RESOURCE
      - COULD_NOT_DELETE_RESOURCE
      - MISSING_VERSION
      - UNSUPPORTED_VERSION
      - UNAUTHORISED
      - CUSTOMER_NOT_FOUND
      - PLATFORM_NOT_FOUND
      - PRICING_PLAN_NOT_FOUND
      - PRODUCT_NOT_FOUND
      - PRODUCT_ITEM_NOT_FOUND
      - PRICING_NOT_FOUND
      - PRICING_ITEM_NOT_FOUND
      - USER_NOT_FOUND
      - METER_NOT_FOUND
      - METER_VALUE_NOT_FOUND
      - METER_PROPERTY_NOT_FOUND
      - PRICING_ITEM_SUMMARIES_NOT_FOUND
      - MISSING_ID
      - INVALID_ID
      - MISSING_REFERENCE
      - MISSING_FIELD
      - INVALID_FIELD
      - INVALID_OPERATION
      - INTERNAL_ERROR
      - USER_NOT_ALLOWED
      - IDEMPOTENCY_CHECK_FAILED
      - INVALID_REQUEST
      title: ApiErrorCode
    AuthenticationProviderCreateRequestStatus:
      type: string
      enum:
      - ENABLED
      - DISABLED
      title: AuthenticationProviderCreateRequestStatus
    SsoVariantCreateRequestVariant:
      type: string
      enum:
      - GOOGLE
      - OKTA
      - MICROSOFT
      title: SsoVariantCreateRequestVariant
    SsoVariantVariant:
      type: string
      enum:
      - GOOGLE
      - OKTA
      - MICROSOFT
      title: SsoVariantVariant
    ApiError:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/ApiErrorType'
        code:
          $ref: '#/components/schemas/ApiErrorCode'
        field:
          type:
          - string
          - 'null'
        message:
          type: string
        resource_id:
          type:
          - string
          - 'null'
        resource_type:
          oneOf:
          - $ref: '#/components/schemas/ApiErrorResourceType'
          - type: 'null'
      required:
      - type
      - code
      - message
      title: ApiError
    AuthenticationProviderRequestCreateRequest:
      type: object
      properties:
        token:
          type: string
        email:
          type: string
      title: AuthenticationProviderRequestCreateRequest
    SSOVariantCreateRequest:
      type: object
      properties:
        variant:
          $ref: '#/components/schemas/SsoVariantCreateRequestVariant'
        allowed_domains:
          type: array
          items:
            type: string
        okta:
          $ref: '#/components/schemas/SSOAuthenticationProviderVariantSettings'
        microsoft:
          $ref: '#/components/schemas/SSOAuthenticationProviderVariantSettings'
      title: SSOVariantCreateRequest
    AuthenticationProviderStatus:
      type: string
      enum:
      - ENABLED
      - DISABLED
      title: AuthenticationProviderStatus
    ApiErrorType:
      type: string
      enum:
      - API_ERROR
      - INVALID_REQUEST
      title: ApiErrorType
    SSOVariant:
      type: object
      properties:
        variant:
          $ref: '#/components/schemas/SsoVariantVariant'
        allowed_domains:
          type: array
          items:
            type: string
        okta:
          $ref: '#/components/schemas/SSOAuthenticationProviderVariantSettings'
        microsoft:
          $ref: '#/components/schemas/SSOAuthenticationProviderVariantSettings'
      title: SSOVariant
    AuthenticationProviderUpdateRequestStatus:
      type: string
      enum:
      - ENABLED
      - DISABLED
      title: AuthenticationProviderUpdateRequestStatus
    AuthenticationProvider:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        entity_id:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/AuthenticationProviderType'
        name:
          type: string
        status:
          $ref: '#/components/schemas/AuthenticationProviderStatus'
        sso:
          $ref: '#/components/schemas/SSOVariant'
      title: AuthenticationProvider
    SSOAuthenticationProviderVariantSettings:
      type: object
      properties:
        connection:
          type: string
      title: SSOAuthenticationProviderVariantSettings
    PaginationLinks:
      type: object
      properties:
        first:
          type:
          - string
          - 'null'
        previous:
          type:
          - string
          - 'null'
        current:
          type:
          - string
          - 'null'
        next:
          type:
          - string
          - 'null'
      title: PaginationLinks
    ApiErrorResourceType:
      type: string
      enum:
      - CUSTOMER
      - CUSTOM_FIELD
      - PLATFORM
      - PLATFORM_UPTODATE
      - METER
      - METER_VALUE
      - METER_PROPERTY
      - METER_VALUE_CALCULATION
      - INGEST_DATA
      - METER_DATA
      - CHARGE_DATA
      - PERSIST_DATA
      - ADJUSTMENT_DATA
      - PRODUCT_CATEGORY
      - PRODUCT
      - PRODUCT_ITEM
      - PRICING
      - PRICING_GROUP
      - PRICING_ITEM
      - PRICING_ITEM_CONFIG
      - PRICING_PLAN_SUBSCRIPTION
      - PRICING_PLAN_SUBSCRIPTION_GROUP
      - PRICING_PLAN_SCHEDULE
      - PRICING_PLAN
      - PRICING_PLAN_VERSION
      - QUOTE
      - QUOTE_VERSION
      - QUOTE_TEMPLATE
      - API_KEY
      - USER
      - ROLE
      - PROXY_USER
      - EXTERNAL_CREDENTIALS
      - TOKEN
      - INVOICE
      - E_INVOICE
      - PDF
      - BILLING_ENTITY
      - FEATURE
      - MEMBERSHIP
      - PAYMENT
      - PAYMENT_ACCEPTOR
      - PAYMENT_METHOD
      - PAYMENT_METHOD_OPTIONS
      - PAYMENT_SCHEDULE
      - PAYMENT_REQUEST
      - INTEGRATION
      - WEBHOOK
      - FILE
      - FILE_PROCESSING_SETTINGS
      - TEAM
      - DOWNLOAD_URL
      - CSV_REPORT
      - REPORT
      - REPORT_GENERATE_REQUEST
      - REPORT_CONFIGURATION
      - REPORT_SUBSCRIPTION
      - REPORT_DEFINITION
      - ACCOUNT_GROUP
      - ENTITY
      - EVENT_TRACE
      - EVENT_TRACE_LINK
      - PRICING_CATEGORY
      - CONTACT
      - ALERT_RULE
      - ALERT
      - AUDIT_RECORD
      - PORTAL_URL
      - AUTHENTICATION_PROVIDER
      - REPROCESS
      - APPROVAL_POLICY
      - APPROVAL_REQUEST
      - BULK_ACTION
      - COUPON
      - PROMOTION_CODE
      - WALLET
      - WALLET_TYPE
      - WALLET_GRANT
      - WORKFLOW
      - WORKFLOW_TRIGGER
      - WORKFLOW_ACTION
      - CREDIT_TYPE
      - SIGNATURE_REQUEST
      - ATTACHMENT
      - DOCUMENT
      title: ApiErrorResourceType
    AuthenticationProviderType:
      type: string
      enum:
      - DEFAULT
      - SSO
      title: AuthenticationProviderType
    AuthenticationProviderCreateRequest:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        entity_id:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/AuthenticationProviderCreateRequestType'
        name:
          type: string
        status:
          $ref: '#/components/schemas/AuthenticationProviderCreateRequestStatus'
        sso:
          $ref: '#/components/schemas/SSOVariantCreateRequest'
      required:
      - type
      title: AuthenticationProviderCreateRequest
    AuthenticationProviderCreateRequestType:
      type: string
      enum:
      - DEFAULT
      - SSO
      title: AuthenticationProviderCreateRequestType
    AuthenticationProviderResponseWrapper:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AuthenticationProvider'
        limit:
          type:
          - integer
          - 'null'
        page:
          type:
          - integer
          - 'null'
        total_number_of_pages:
          type:
          - integer
          - 'null'
        links:
          $ref: '#/components/schemas/PaginationLinks'
      required:
      - data
      - links
      title: AuthenticationProviderResponseWrapper
    AuthenticationProviderUpdateRequest:
      type: object
      properties:
        id:
          type:
          - string
          - 'null'
        entity_id:
          type:
          - string
          - 'null'
        type:
          $ref: '#/components/schemas/AuthenticationProviderUpdateRequestType'
        name:
          type: string
        status:
          $ref: '#/components/schemas/AuthenticationProviderUpdateRequestStatus'
        sso:
          $ref: '#/components/schemas/SSOVariantUpdateRequest'
      title: AuthenticationProviderUpdateRequest
    SsoVariantUpdateRequestVariant:
      type: string
      enum:
      - GOOGLE
      - OKTA
      - MICROSOFT
      title: SsoVariantUpdateRequestVariant
  securitySchemes:
    API-Key:
      type: apiKey
      in: header
      name: X-API-KEY
    JWT-Authentication:
      type: http
      scheme: bearer