Frontegg Email Configuration API

openapi: 3.2.0
info:
  title: Entitlements Agent (PDP) Email Configuration API
  description: 'The endpoints in this section pertain to the usage of an Entitlements Agent. When your application or service needs to verify entitlements, it can query the Entitlements Agent directly via HTTP.


    These endpoints can be integrated into any backend framework, enabling you to leverage entitlements for advanced authorization needs.'
  version: '1.0'
tags:
- name: Email Configuration
  x-displayName: Email configuration
paths:
  /resources/mail/v1/configurations:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: MailConfigController_createOrUpdateMailConfig
      summary: Create or Update Configuration
      description: 'Configure your SendGrid account to send emails from your environment.


        Provide your SendGrid secret key in the request body.


        A valid environment token is required to call this endpoint. You can obtain it from the environment authentication route.'
      deprecated: true
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOrUpdateMailConfigRequestDto'
      responses:
        '200':
          description: ''
        '201':
          description: ''
      tags:
      - Email Configuration
      security:
      - bearer: []
    get:
      operationId: MailConfigController_getMailConfig
      summary: Get Configuration
      description: 'Retrieve the mail configuration for your SendGrid account.


        A valid environment token is required to call this endpoint. You can obtain it from the environment authentication route.'
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetMailConfigResponseDto'
      tags:
      - Email Configuration
      security:
      - bearer: []
    delete:
      operationId: MailConfigController_deleteMailConfig
      summary: Delete Configuration
      description: 'Delete the mail configuration for your SendGrid account.


        A valid environment token is required to call this endpoint. You can obtain it from the environment authentication route.'
      parameters: []
      responses:
        '200':
          description: ''
      tags:
      - Email Configuration
      security:
      - bearer: []
  /resources/mail/v2/configurations:
    servers:
    - url: https://api.frontegg.com/identity
      description: EU Region
    - url: https://api.us.frontegg.com/identity
      description: US Region
    - url: https://api.ca.frontegg.com/identity
      description: CA Region
    - url: https://api.au.frontegg.com/identity
      description: AU Region
    - url: https://{domain}.frontegg.com/identity
      description: Frontegg sub-domain for use with user tokens
      variables:
        domain:
          default: app-xxx
    post:
      operationId: MailConfigController_createOrUpdateMailConfigV2
      summary: Create or Update Configuration V2
      description: 'Configure email settings for your environment, supporting SES, Mailgun, and SendGrid.


        Provide the email provider, sender details, and any additional parameters in the request body.


        A valid environment token is required to call this endpoint. You can obtain it from the environment authentication route.'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                payload:
                  oneOf:
                  - $ref: '#/components/schemas/SendGridDto'
                  - $ref: '#/components/schemas/SesDto'
                  - $ref: '#/components/schemas/MailgunDto'
                  - $ref: '#/components/schemas/SesRoleDto'
      responses:
        '201':
          description: ''
      tags:
      - Email Configuration
      security:
      - bearer: []
components:
  schemas:
    SesDto:
      type: object
      properties:
        provider:
          type: string
          enum:
          - ses
        secret:
          type: string
        id:
          type: string
        region:
          type: string
      required:
      - provider
      - secret
      - id
      - region
    GetMailConfigResponseDto:
      type: object
      properties:
        secret:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        extension:
          type: array
          items:
            type: object
        provider:
          type: string
          enum:
          - sendgrid
          - mailgun
          - ses
          - ses-role
      required:
      - secret
      - createdAt
      - updatedAt
      - extension
      - provider
    CreateOrUpdateMailConfigRequestDto:
      type: object
      properties:
        secret:
          type: string
      required:
      - secret
    SesRoleDto:
      type: object
      properties:
        provider:
          type: string
          enum:
          - ses-role
        secret:
          type: string
        region:
          type: string
      required:
      - provider
      - secret
      - region
    MailgunDto:
      type: object
      properties:
        provider:
          type: string
          enum:
          - mailgun
        secret:
          type: string
        domain:
          type: string
        region:
          default: us
          enum:
          - US: us
            EU: eu
          type: number
      required:
      - provider
      - secret
      - domain
      - region
    SendGridDto:
      type: object
      properties:
        provider:
          type: string
          enum:
          - sendgrid
        secret:
          type: string
      required:
      - provider
      - secret
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
x-tagGroups:
- name: Entitlements Agent (PDP)
  tags:
  - Entitlements Check
- name: Audits Overview
  tags:
  - Main
  - Metrics
- name: Entitlements Overview
  tags:
  - Plans
  - API Access Control
  - API Access Control Configurations
  - Features
  - Entitlements
  - Feature Flags
  - ReBAC
- name: Authentication and Identity Management
  tags:
  - API token
  - API tokens
  - Account invitations
  - Account invitations settings
  - Account roles
  - Approval Flows
  - Core settings
  - Custom social OAuth provider
  - Data migration
  - Delegation
  - Domain restrictions
  - Email configuration
  - Email templates
  - General
  - IP restrictions
  - Lockout policy
  - M2M tokens
  - MFA
  - MFA configuration
  - MFA settings
  - Password settings
  - Passwordless
  - Permissions
  - Permissions categories
  - Personal tokens
  - Roles
  - SMS
  - SMS configuration
  - SMS templates
  - Sessions configuration
  - Sessions management
  - User emails policy
  - User groups
  - User management
  - Users
  - User pools
  - User sessions
  - Users-applications management
- name: SCIM Provisioning Overview
  tags:
  - SCIM settings
  - SCIM configurations
- name: Single Sign-On Overview
  tags:
  - SAML configurations
  - SSO settings
  - SSO configurations
  - OIDC configurations
- name: Account Management Overview
  tags:
  - Accounts
  - tenants_other
  - Sub-accounts
  - Account settings
  - Account migration
  - Sub-accounts and hierarchy