IVANS Market Credentials API

openapi: 3.2.0
info:
  title: Identification Network Market Credentials API
  version: 1.0.0
  description: IVANS Identification Network API
servers:
- url: https://distribution-staging.ivansinsurance.com
tags:
- name: market-credentials
paths:
  /api/v1/market-credentials/:
    post:
      operationId: market_credentials_create
      description: 'Creates market credential.

        - Non-admin user cannot set access structures on credential

        - User cannot create the credential for another user (forbidden)'
      tags:
      - market-credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarketCredentialCreateRequest'
            examples:
              CredentialForAllStructures:
                value:
                  marketConfiguration: b822ed9b-16cd-4738-beed-c0d9d7f74f24
                  accessStructures: []
                  nickname: Test Cred
                  username: Test User
                  credential:
                    password: test password
                summary: Credential for all structures
                description: If key "accessStructures" is empty list, that means the credential is available for all structures under the tenant. Only admin users can create credentials with all structures. A credentials object (and password) are optional.
              CredentialForAllStructures,NoPassword:
                value:
                  marketConfiguration: b822ed9b-16cd-4738-beed-c0d9d7f74f24
                  accessStructures: []
                  nickname: Test Cred
                  username: Test User
                summary: Credential for all structures, no password
                description: If key "accessStructures" is empty list, that means the credential is available for all structures under the tenant. Only admin users can create credentials with all structures. Optional password is not provided.
              CredentialForSpecificStructures:
                value:
                  marketConfiguration: b822ed9b-16cd-4738-beed-c0d9d7f74f24
                  accessStructures:
                  - agency: 15a11c06-7679-453e-b965-54b97ae9e741
                    branch: 502b2c78-4b59-4142-9232-3b05ea1cec76
                    department: 2b25151e-2bae-4bcf-8bc9-885d4bfd23b1
                    businessUnit: 75d67c23-bb71-462e-ab77-32b4057880fe
                  nickname: Test Cred
                  username: Test User
                  credential:
                    password: test password
                summary: Credential for specific structures
                description: Only admin users can create credentials with specific structures. A password is required.
              CredentialForSpecificUser:
                value:
                  marketConfiguration: b822ed9b-16cd-4738-beed-c0d9d7f74f24
                  user: 00448c2f-0c06-4358-850c-85267d9be435
                  nickname: Test Cred
                  username: Test User
                  credential:
                    password: test password
                summary: Credential for specific user
                description: Admin users can create credentials for any user. Non-admin users can only create credentials for themselves. A password is required.
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/MarketCredentialCreateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/MarketCredentialCreateRequest'
        required: true
      security:
      - oauth2:
        - write
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketCredential'
          description: Successfully created.
        '400':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                InvalidBody:
                  value:
                    marketConfiguration:
                    - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" - object does not exist.
                    user:
                    - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" - object does not exist.
                    accessStructures:
                    - agency:
                      - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" -object does not exist.
                      branch:
                      - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" -object does not exist.
                      department:
                      - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" -object does not exist.
                      businessUnit:
                      - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" -object does not exist.
                    credential:
                    - You must provide at least a "password" in the credential dict
                  summary: Invalid body
                InvalidCreation:
                  value:
                    nonFieldErrors:
                    - Cannot assign a User and Access Structures to a Credential
                  summary: Invalid creation
          description: Invalid creation attempt or invalid body, some of the possible error reasons below;
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Invalid:
                  value:
                    details: Authentication credentials were not provided.
                Expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                    - tokenClass: AccessToken
                      tokenType: access
                      message: Token is invalid or expired
          description: Invalid or Expired token.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/market_credentials_create_responses'
          description: Forbidden to set access structure for non-admin user and to create a credential for another user.
      summary: Market credentials create
      x-summary-source: derived
    get:
      operationId: market_credentials_list
      description: 'Returns all of the market credentials that user has access to.

        - If a user is an admin, all credentials with the market configuration will be available to view.

        - If the user is not an admin, the access structure will be filtered based on the user''s permission.'
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      tags:
      - market-credentials
      security:
      - oauth2:
        - read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMarketCredentialList'
          description: Successfully received the credential.
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Invalid:
                  value:
                    details: Authentication credentials were not provided.
                Expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                    - tokenClass: AccessToken
                      tokenType: access
                      message: Token is invalid or expired
          description: Invalid or Expired token.
      summary: Market credentials list
      x-summary-source: derived
  /api/v1/market-credentials/{uuid}/:
    delete:
      operationId: market_credentials_destroy
      description: 'Deletes the credential based on given uuid.

        - Credential must be accessible by the user, otherwise it will return not found.'
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - market-credentials
      security:
      - oauth2:
        - write
      responses:
        '204':
          description: "No Response Body,\n        successfully deleted"
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Invalid:
                  value:
                    details: Authentication credentials were not provided.
                Expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                    - tokenClass: AccessToken
                      tokenType: access
                      message: Token is invalid or expired
          description: Invalid or Expired token.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/market_credential_delete_responses'
          description: UUID is not valid or user does not have access to it
      summary: Market credentials destroy
      x-summary-source: derived
    patch:
      operationId: market_credentials_partial_update
      description: Updates existing credentials.
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - market-credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedMarketCredentialCreateRequest'
            examples:
              CredentialForAllStructures:
                value:
                  marketConfiguration: b822ed9b-16cd-4738-beed-c0d9d7f74f24
                  accessStructures: []
                  nickname: Test Cred
                  username: Test User
                  credential:
                    password: test password
                summary: Credential for all structures
                description: If key "accessStructures" is empty list, that means the credential is available for all structures under the tenant. Only admin users can create credentials with all structures. A credentials object (and password) are optional.
              CredentialForAllStructures,NoPassword:
                value:
                  marketConfiguration: b822ed9b-16cd-4738-beed-c0d9d7f74f24
                  accessStructures: []
                  nickname: Test Cred
                  username: Test User
                summary: Credential for all structures, no password
                description: If key "accessStructures" is empty list, that means the credential is available for all structures under the tenant. Only admin users can create credentials with all structures. Optional password is not provided.
              CredentialForSpecificStructures:
                value:
                  marketConfiguration: b822ed9b-16cd-4738-beed-c0d9d7f74f24
                  accessStructures:
                  - agency: 15a11c06-7679-453e-b965-54b97ae9e741
                    branch: 502b2c78-4b59-4142-9232-3b05ea1cec76
                    department: 2b25151e-2bae-4bcf-8bc9-885d4bfd23b1
                    businessUnit: 75d67c23-bb71-462e-ab77-32b4057880fe
                  nickname: Test Cred
                  username: Test User
                  credential:
                    password: test password
                summary: Credential for specific structures
                description: Only admin users can create credentials with specific structures. A password is required.
              CredentialForSpecificUser:
                value:
                  marketConfiguration: b822ed9b-16cd-4738-beed-c0d9d7f74f24
                  user: 00448c2f-0c06-4358-850c-85267d9be435
                  nickname: Test Cred
                  username: Test User
                  credential:
                    password: test password
                summary: Credential for specific user
                description: Admin users can create credentials for any user. Non-admin users can only create credentials for themselves. A password is required.
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedMarketCredentialCreateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedMarketCredentialCreateRequest'
      security:
      - oauth2:
        - write
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketCredential'
          description: Successfully updated.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/market_credential_update_responses_body'
          description: Invalid request body (possible bad requests below).
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Invalid:
                  value:
                    details: Authentication credentials were not provided.
                Expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                    - tokenClass: AccessToken
                      tokenType: access
                      message: Token is invalid or expired
          description: Invalid or Expired token.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/market_credential_detail_update_responses'
          description: UUID is not valid or user does not have access to it
      summary: Market credentials partial update
      x-summary-source: derived
    get:
      operationId: market_credentials_retrieve
      description: Returns an individual credential.
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - market-credentials
      security:
      - oauth2:
        - read
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketCredential'
          description: Successfully received credential
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Invalid:
                  value:
                    details: Authentication credentials were not provided.
                Expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                    - tokenClass: AccessToken
                      tokenType: access
                      message: Token is invalid or expired
          description: Invalid or Expired token.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/market_credential_detail_responses'
          description: UUID is not a valid or does not have corresponding credential for current user
      summary: Market credentials retrieve
      x-summary-source: derived
  /api/v1/market-credentials/{uuid}/secret/:
    get:
      operationId: market_credentials_secret_retrieve
      description: Retrieves the username/password and nickname.
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
        required: true
      tags:
      - market-credentials
      security:
      - basicAuth: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarketCredentialSecret'
          description: Successfully received the credential
        '401':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
              examples:
                Invalid:
                  value:
                    details: Authentication credentials were not provided.
                Expired:
                  value:
                    detail: Given token not valid for any token type
                    code: token_not_valid
                    messages:
                    - tokenClass: AccessToken
                      tokenType: access
                      message: Token is invalid or expired
          description: Invalid or Expired token.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/market_credential_secret_detail_response'
          description: UUID is not valid or does not have a corresponding credential
      summary: Market credentials secret retrieve
      x-summary-source: derived
components:
  schemas:
    PatchedMarketCredentialCreateRequest:
      type: object
      properties:
        marketConfiguration:
          type: string
          format: uuid
        user:
          type:
          - string
          - 'null'
          format: uuid
        accessStructures:
          type: array
          items:
            $ref: '#/components/schemas/MarketStructureRequest'
        nickname:
          type: string
          minLength: 1
          maxLength: 128
        username:
          type: string
          minLength: 1
          maxLength: 128
        credential:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
          default: {}
    market_credential_detail_update_responses:
      type: object
      properties:
        details:
          type: string
          default: Not found.
    PaginatedMarketCredentialList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: https://distribution.ivansinsurance.com/api/v1/market-credentials/?page=3
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: https://distribution.ivansinsurance.com/api/v1/market-credentials/?page=1
        results:
          type: array
          items:
            $ref: '#/components/schemas/MarketCredential'
    MarketStructureRequest:
      type: object
      properties:
        agency:
          type: string
          format: uuid
        branch:
          type: string
          format: uuid
        department:
          type: string
          format: uuid
        businessUnit:
          type: string
          format: uuid
      required:
      - agency
    market_credential_detail_responses:
      type: object
      properties:
        details:
          type: string
          default: Not found.
    MarketCredentialSecret:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
        nickname:
          type: string
          maxLength: 128
        username:
          type: string
          maxLength: 128
        password:
          type: string
          readOnly: true
        extraFields:
          type: object
          additionalProperties: {}
          readOnly: true
      required:
      - extraFields
      - nickname
      - password
      - username
      - uuid
    market_credential_secret_detail_response:
      type: object
      properties:
        details:
          type: string
          default: Not found.
    MarketCredential:
      type: object
      properties:
        uuid:
          type: string
          format: uuid
          readOnly: true
        nickname:
          type: string
          maxLength: 128
        username:
          type: string
          maxLength: 128
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        lastModifiedBy:
          $ref: '#/components/schemas/SimpleUser'
        marketConfiguration:
          type: string
        user:
          $ref: '#/components/schemas/SimpleUser'
        accessStructures:
          type: array
          items:
            $ref: '#/components/schemas/StructureAccess'
        lastUsedOn:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - accessStructures
      - lastModifiedBy
      - marketConfiguration
      - nickname
      - updatedAt
      - user
      - username
      - uuid
    market_credential_update_responses_body:
      type: object
      properties:
        marketConfiguration:
          type: array
          items: {}
          default:
          - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" - object does not exist.
        user:
          type: array
          items: {}
          default:
          - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" - object does not exist.
        accessStructures:
          type: array
          items: {}
          default:
          - agency:
            - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" -object does not exist.
            branch:
            - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" -object does not exist.
            department:
            - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" -object does not exist.
            businessUnit:
            - Invalid pk "3fa85f64-5717-4562-b3fc-2c963f66afa6" -object does not exist.
        credential:
          type: array
          items: {}
          default:
          - You must provide at least a "password" in the credential dict
    StructureChild:
      type: object
      properties:
        id:
          type: string
        code:
          type: string
        name:
          type: string
      required:
      - code
      - id
      - name
    MarketCredentialCreateRequest:
      type: object
      properties:
        marketConfiguration:
          type: string
          format: uuid
        user:
          type:
          - string
          - 'null'
          format: uuid
        accessStructures:
          type: array
          items:
            $ref: '#/components/schemas/MarketStructureRequest'
        nickname:
          type: string
          minLength: 1
          maxLength: 128
        username:
          type: string
          minLength: 1
          maxLength: 128
        credential:
          type: object
          additionalProperties:
            type:
            - string
            - 'null'
          default: {}
      required:
      - accessStructures
      - marketConfiguration
      - nickname
      - user
      - username
    market_credential_delete_responses:
      type: object
      properties:
        details:
          type: string
          default: Not found.
    market_credentials_create_responses:
      type: object
      properties:
        detail:
          type: string
          default: You do not have permission to perform this action.
    SimpleUser:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        integratorUserId:
          type: string
        name:
          type: string
          readOnly: true
        externalId:
          type: string
          description: Unique identifier from external system. Used to identify agents.
          maxLength: 64
      required:
      - id
      - integratorUserId
      - name
    StructureAccess:
      type: object
      properties:
        agency:
          $ref: '#/components/schemas/StructureChild'
        branch:
          $ref: '#/components/schemas/StructureChild'
        department:
          $ref: '#/components/schemas/StructureChild'
        businessUnit:
          $ref: '#/components/schemas/StructureChild'
      required:
      - agency
      - branch
      - businessUnit
      - department
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    oauth2:
      type: oauth2
      flows:
        password:
          tokenUrl: /api/v1/token/
          refreshUrl: /api/v1/token/
          scopes:
            read: Read scope
            write: Write scope
            epic: Epic User
            third-party: Third Party User
    basicAuth:
      type: http
      scheme: basic
x-readme:
  explorer-enabled: true
  proxy-enabled: true
x-provenance:
  method: searched
  source: https://api.ivans.com/reference/agencies_list
  generated: '2026-10-13'
  note: Assembled verbatim from the OpenAPI definition fragments IVANS embeds in each operation page of its ReadMe developer portal (api.ivans.com/reference); paths and components merged per API, nothing authored.