Skip to main content
Version: cidaas 3.102.2
Version: 1.0

templates api

Template APIs manage email, SMS, IVR, and other communication templates provided by Cidaas. Custom templates can be created as needed.

Templates send password reset emails/SMS, one-time passwords, or verification messages. Common use cases include "accessed by new device" notifications and account activation/deactivation.

Template management differs significantly between:

  • Cidaas Templates
    • Default Cidaas template group provided for de and en locales
    • Additional groups created only by copying existing Cidaas template groups
    • New locales added using template group API copy functionality
    • Note: Individual templates cannot be added/deleted in Cidaas template groups
    • Template removal only possible for specific locale or groupId
    • System Template Types cannot be added/removed but can be customized via custom Attributes
  • Developer Templates
    • One developer group provided for individual (non-Cidaas) templates
    • Developer Templates can be created, modified, and deleted as needed
    • Note: Requires setting up a Template Type to reference in your Developer Template

Authentication

Security Scheme Type:

oauth2

OAuth Flow (authorizationCode):

Scopes:

  • cidaas:admin_write: Used for the seeding of the templates.

  • cidaas:cidaas_templates_read: Used to enable read access for the templates.

  • cidaas:cidaas_templates_write: Used to enable write access for the templates.

  • cidaas:cidaas_templates_delete: Used to enable delete access which allows to delete templates.

OAuth Flow (clientCredentials):

Scopes:

  • cidaas:admin_write: Used for the seeding of the templates.

  • cidaas:cidaas_templates_read: Used to enable read access for the templates.

  • cidaas:cidaas_templates_write: Used to enable write access for the templates.

  • cidaas:cidaas_templates_delete: Used to enable delete access which allows to delete templates.

OAuth Flow (implicit):

Scopes:

  • cidaas:admin_write: Used for the seeding of the templates.

  • cidaas:cidaas_templates_read: Used to enable read access for the templates.

  • cidaas:cidaas_templates_write: Used to enable write access for the templates.

  • cidaas:cidaas_templates_delete: Used to enable delete access which allows to delete templates.