Okta Template API

openapi: 3.0.1
info:
  title: Okta Application Template API
  description: Allows customers to easily access the Okta API
  termsOfService: https://developer.okta.com/terms/
  contact:
    name: Okta Developer Team
    url: https://developer.okta.com/
    email: devex-public@okta.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 2.16.0
servers:
- url: https://your-subdomain.okta.com/
tags:
- name: Template
paths:
  /api/v1/templates/sms:
    get:
      tags:
      - Template
      summary: Okta List SMS Templates
      description: Enumerates custom SMS templates in your organization. A subset of templates can be returned that match a template type.
      operationId: listSmsTemplates
      parameters:
      - name: templateType
        in: query
        schema:
          type: string
          x-openapi-v3-schema-ref: '#/definitions/SmsTemplateType'
        x-openapi-v3-schema-ref: '#/definitions/SmsTemplateType'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SmsTemplate'
      security:
      - api_token: []
    post:
      tags:
      - Template
      summary: Okta Add SMS Template
      description: Adds a new custom SMS template to your organization.
      operationId: createSmsTemplate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmsTemplate'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsTemplate'
      security:
      - api_token: []
      x-codegen-request-body-name: smsTemplate
  /api/v1/templates/sms/{templateId}:
    get:
      tags:
      - Template
      summary: Okta Get SMS Template
      description: Fetches a specific template by `id`
      operationId: getSmsTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsTemplate'
      security:
      - api_token: []
    put:
      tags:
      - Template
      summary: Okta Update SMS Template
      description: Updates the SMS template.
      operationId: updateSmsTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmsTemplate'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsTemplate'
      security:
      - api_token: []
      x-codegen-request-body-name: smsTemplate
    post:
      tags:
      - Template
      summary: Okta Partial SMS Template Update
      description: 'Updates only some of the SMS template properties:'
      operationId: partialUpdateSmsTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmsTemplate'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SmsTemplate'
      security:
      - api_token: []
      x-codegen-request-body-name: smsTemplate
    delete:
      tags:
      - Template
      summary: Okta Remove SMS Template
      description: Removes an SMS template.
      operationId: deleteSmsTemplate
      parameters:
      - name: templateId
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content: {}
      security:
      - api_token: []
components:
  schemas:
    SmsTemplate:
      type: object
      properties:
        created:
          type: string
          format: date-time
          readOnly: true
        id:
          type: string
          readOnly: true
        lastUpdated:
          type: string
          format: date-time
          readOnly: true
        name:
          type: string
        template:
          type: string
        translations:
          $ref: '#/components/schemas/SmsTemplateTranslations'
        type:
          $ref: '#/components/schemas/SmsTemplateType'
      x-okta-crud:
      - alias: create
        arguments:
        - dest: smsTemplate
          self: true
        operationId: createSmsTemplate
      - alias: read
        arguments: []
        operationId: getSmsTemplate
      - alias: update
        arguments:
        - dest: templateId
          src: id
        - dest: smsTemplate
          self: true
        operationId: updateSmsTemplate
      - alias: delete
        arguments:
        - dest: templateId
          src: id
        operationId: deleteSmsTemplate
      x-okta-operations:
      - alias: partialUpdate
        arguments:
        - dest: templateId
          src: id
        - dest: smsTemplate
          self: true
        operationId: partialUpdateSmsTemplate
      x-okta-tags:
      - Template
    SmsTemplateTranslations:
      type: object
      x-okta-extensible: true
      x-okta-tags:
      - Template
    SmsTemplateType:
      type: string
      enum:
      - SMS_VERIFY_CODE
      x-okta-tags:
      - Template
  securitySchemes:
    api_token:
      type: apiKey
      description: SSWS {API Token}
      name: Authorization
      in: header
externalDocs:
  description: Find more info here
  url: https://developer.okta.com/docs/api/getting_started/design_principles.html