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

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/strivacity-email-provider-configuration-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

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

Get an API key

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

GitHub Google LinkedIn

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

OpenAPI Specification

openapi: 3.2.0
info:
  description: API documentation of Admin Portal
  title: Admin Portal Email Provider Configuration API
  version: v0.0.1
servers:
- url: https://{tenant}
  variables:
    tenant:
      default: example.strivacity.com
      description: Your Strivacity tenant
tags:
- name: Email Provider Configuration
paths:
  /admin/api/v1/instance/email/activeProvider:
    get:
      description: 'You can get active email service provider by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_admin_email_service_provider |'
      operationId: getActiveProviderId
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OnlyIdResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
      security:
      - securityScheme:
        - read:config_admin_email_service_provider
      summary: Get active email service provider
      tags:
      - Email Provider Configuration
    post:
      description: 'You can set active email service provider by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | write:config_admin_email_service_provider |'
      operationId: setActiveProviderId
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailProvider_IdReference_InsertRequest'
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/OnlyIdResponse'
          description: OK
        '400':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
      security:
      - securityScheme:
        - write:config_admin_email_service_provider
      summary: Set active email service provider
      tags:
      - Email Provider Configuration
  /admin/api/v1/instance/email/providers:
    get:
      description: 'You can list existing email service providers by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_admin_email_service_provider |'
      operationId: readEmailProviders
      parameters:
      - description: Name used for filtering
        in: query
        name: name
        required: false
        schema:
          type: string
      - description: Zero-based page index (0..N)
        in: query
        name: page
        schema:
          type: integer
          format: int64
          default: 0
      - description: The size of the page to be returned
        in: query
        name: size
        schema:
          type: integer
          format: int64
          default: 20
      - description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
        in: query
        name: sort
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagedModelEmailProviderListResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
      security:
      - securityScheme:
        - read:config_admin_email_service_provider
      summary: List email service providers
      tags:
      - Email Provider Configuration
    post:
      description: 'You can create the existing email service provider by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | write:config_admin_email_service_provider |'
      operationId: createEmailProviders
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/EmailProviderInsertRequest'
              - $ref: '#/components/schemas/CustomEmailInsertRequest'
              - $ref: '#/components/schemas/SmtpEmailInsertRequest'
        required: true
      responses:
        '201':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmailProviderResponse'
          description: Created
        '400':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '409':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Conflict
      security:
      - securityScheme:
        - write:config_admin_email_service_provider
      summary: Create email service provider
      tags:
      - Email Provider Configuration
  /admin/api/v1/instance/email/providers/{providerId}:
    delete:
      description: 'You can delete existing email service provider by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | delete:config_admin_email_service_provider |'
      operationId: deleteEmailProvider
      parameters:
      - in: path
        name: providerId
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '400':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '409':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Conflict
      security:
      - securityScheme:
        - delete:config_admin_email_service_provider
      summary: Delete email service provider
      tags:
      - Email Provider Configuration
    get:
      description: 'You can get existing email service provider by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | read:config_admin_email_service_provider |'
      operationId: readEmailProvider
      parameters:
      - in: path
        name: providerId
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmailProviderResponse'
          description: OK
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
      security:
      - securityScheme:
        - read:config_admin_email_service_provider
      summary: Get email service provider
      tags:
      - Email Provider Configuration
    put:
      description: 'You can update existing email service provider by calling this endpoint.


        | REQUIRED API PERMISSION |

        |:------------------------|

        | write:config_admin_email_service_provider |'
      operationId: updateEmailProvider
      parameters:
      - in: path
        name: providerId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/EmailProviderUpdateRequest'
              - $ref: '#/components/schemas/CustomEmailUpdateRequest'
              - $ref: '#/components/schemas/SmtpEmailUpdateRequest'
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EmailProviderResponse'
          description: OK
        '400':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Bad Request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Forbidden
        '404':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Not Found
        '409':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProblemJson'
          description: Conflict
      security:
      - securityScheme:
        - write:config_admin_email_service_provider
      summary: Update email service provider
      tags:
      - Email Provider Configuration
components:
  schemas:
    ProblemJson:
      type: object
      properties:
        detail:
          type: string
        entityName:
          type: string
          description: The name of the entity within the error has occurred
        errorKey:
          type: string
          description: A unique identifier of the error
        fieldErrors:
          type: array
          description: Field constraint violation errors
          items:
            $ref: '#/components/schemas/FieldError'
        message:
          type: string
          description: A unique identifier in format of 'error.{errorKey}'
        params:
          type: array
          description: Further information related to the actual error
          items:
            type: object
            additionalProperties:
              type: object
        path:
          type: string
          description: Request URI
        status:
          type: integer
          description: Status code
          format: int32
        title:
          type: string
      description: Based on [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807)
    SmtpEmailUpdateRequest:
      required:
      - configuration
      - id
      - name
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/EmailProviderUpdateRequest'
      - type: object
        properties:
          configuration:
            $ref: '#/components/schemas/SmtpEmailUpdateRequestConfiguration'
    PageMetadata:
      type: object
      properties:
        number:
          type: integer
          format: int64
        size:
          type: integer
          format: int64
        totalElements:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int64
    EmailProviderListResponse:
      type: object
      properties:
        customSenderDomain:
          type: string
        description:
          type: string
        id:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - smtp
          - custom
          - strivacity
    EmailProviderUpdateRequest:
      required:
      - id
      - name
      - type
      type: object
      properties:
        customSenderDomain:
          maxLength: 512
          minLength: 3
          type: string
          description: Override sender email domain with a custom value
        description:
          maxLength: 1024
          minLength: 0
          type: string
        id:
          type: string
        name:
          maxLength: 64
          minLength: 3
          pattern: ^$|^[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°]([\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*° ]*[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°])?$
          type: string
        type:
          type: string
          description: This field cannot be altered
          enum:
          - smtp
          - custom
      discriminator:
        propertyName: type
    EmailProvider_IdReference_InsertRequest:
      type: object
      properties: {}
    SmtpEmailInsertRequest:
      required:
      - configuration
      - name
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/EmailProviderInsertRequest'
      - type: object
        properties:
          configuration:
            $ref: '#/components/schemas/SmtpEmailInsertRequestConfiguration'
    FieldError:
      type: object
      properties:
        field:
          type: string
        message:
          type: string
        objectName:
          type: string
    OnlyIdResponse:
      type: object
      properties:
        id:
          type: string
    SmtpEmailUpdateRequestConfiguration:
      required:
      - username
      type: object
      properties:
        connectionType:
          pattern: ^SMTPS|StartTLS$
          type:
          - string
          - 'null'
          description: Should not be null when enabled.
          enum:
          - SMTPS
          - StartTLS
          - 'null'
        password:
          maxLength: 255
          minLength: 1
          type: string
          description: If `password` field was previously set then it will not be overridden unless provided.
        port:
          maximum: 65535
          minimum: 1
          type: integer
          format: int32
          default: 0
        server:
          maxLength: 255
          minLength: 1
          type: string
          description: Should not be null when enabled.
        username:
          maxLength: 255
          minLength: 1
          type: string
    PagedModelEmailProviderListResponse:
      type: object
      properties:
        content:
          type: array
          items:
            $ref: '#/components/schemas/EmailProviderListResponse'
        page:
          $ref: '#/components/schemas/PageMetadata'
    CustomEmailUpdateRequest:
      required:
      - configuration
      - id
      - name
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/EmailProviderUpdateRequest'
      - type: object
        properties:
          configuration:
            $ref: '#/components/schemas/CustomEmailUpdateRequestConfiguration'
    SmtpEmailInsertRequestConfiguration:
      required:
      - password
      - username
      type: object
      properties:
        connectionType:
          pattern: ^SMTPS|StartTLS$
          type:
          - string
          - 'null'
          enum:
          - SMTPS
          - StartTLS
        password:
          maxLength: 255
          minLength: 1
          type: string
        port:
          maximum: 65535
          minimum: 1
          type: integer
          format: int32
        server:
          maxLength: 255
          minLength: 1
          type: string
          description: Should not be null when enabled.
        username:
          maxLength: 255
          minLength: 1
          type: string
    EmailProviderInsertRequest:
      required:
      - name
      - type
      type: object
      properties:
        customSenderDomain:
          maxLength: 512
          minLength: 3
          type: string
          description: Override sender email domain with a custom value
        description:
          maxLength: 1024
          minLength: 0
          type: string
        name:
          maxLength: 64
          minLength: 3
          pattern: ^$|^[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°]([\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*° ]*[\p{L}\p{N}\-.:\/_(){}\[\]|&'"?!@+*°])?$
          type: string
        type:
          type: string
          enum:
          - smtp
          - custom
      discriminator:
        propertyName: type
    CustomEmailInsertRequest:
      required:
      - configuration
      - name
      - type
      type: object
      allOf:
      - $ref: '#/components/schemas/EmailProviderInsertRequest'
      - type: object
        properties:
          configuration:
            $ref: '#/components/schemas/CustomEmailInsertRequestConfiguration'
    EmailProviderResponse:
      type: object
      properties:
        configuration:
          type: object
        customSenderDomain:
          type: string
        description:
          type: string
        id:
          type: string
        name:
          type: string
        type:
          type: string
          enum:
          - smtp
          - custom
          - strivacity
    CustomEmailInsertRequestConfiguration:
      required:
      - packageDependencies
      type: object
      properties:
        code:
          maxLength: 256000
          minLength: 0
          type: string
          description: Code of the custom email provider, if not specified it's generated automatically for each type
          default: '*example code*'
        packageDependencies:
          type: object
          additionalProperties:
            type: string
            description: Dependencies used for the event hook function
          description: Dependencies used for the event hook function
    CustomEmailUpdateRequestConfiguration:
      required:
      - packageDependencies
      type: object
      properties:
        code:
          maxLength: 256000
          minLength: 0
          type: string
          description: Code of the custom email provider, if not specified it's generated automatically for each type
          default: '*example code*'
        packageDependencies:
          type: object
          additionalProperties:
            type: string
            description: Dependencies used for the event hook function
          description: Dependencies used for the event hook function
  securitySchemes:
    securityScheme:
      scheme: bearer
      type: http