openapi: 3.1.0
info:
  title: Hosted Pages API
  version: 2.1.0
  contact:
    name: cidaas support
    url: 'https://support.cidaas.com'
    email: support@cidaas.de
  description: |
    ### cidaas hosted pages API

    The APIs on this page help manage hosted page groups that implement various cidaas flows for registration, login, verification methods, consent approvals, etc.

    cidaas allows managing multiple hosted pages of different types in a group. As a customer, you can assign one hosted page group per client.

    _Management of hosted pages_

    * Create and update a hosted page group.
    * Delete a hosted page group.
    * Find hosted page groups based on hosted page IDs and owner types.
    * Manage hosted page themes.

    _Determining hosted pages_

    * Determine the hosted page when ID and current locale values are passed.
  termsOfService: 'https://www.cidaas.com/terms-of-use/'
  summary: cidaas hosted pages api
tags:
  - name: Hosted Page
  - name: Hosted Pages Group
  - name: hostedpages-srv
  - name: Hosted Pages Themes
servers:
  - url: 'https://domain/'
    description: Enter your domain name
components:
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: 'https://{baseurl}/authz-srv/authz'
          tokenUrl: 'https://{baseurl}/token-srv/token'
          scopes:
            'cidaas:hosted_pages_read': Provides read access for a hosted pages group.
            'cidaas:hosted_pages_write': Provides write access for a hosted pages group.
            'cidaas:hosted_pages_delete': Provides read access for a hosted pages group.
            'cidaas:theme_read': Provides read access to themes
            'cidaas:theme_write': Provides write access to themes
          refreshUrl: ''
        clientCredentials:
          tokenUrl: 'https://{baseurl}/token-srv/token'
          scopes:
            'cidaas:hosted_pages_read': Provides read access for a hosted pages group.
            'cidaas:hosted_pages_write': Provides write access for a hosted pages group.
            'cidaas:hosted_pages_delete': Provides read access for a hosted pages group.
            'cidaas:admin_write': Used for the seeding of the default hosted pages group.
            'cidaas:theme_read': Provides read access to themes
            'cidaas:theme_write': Provides write access to themes
        implicit:
          authorizationUrl: 'https://{baseurl}/authz-srv/authz'
          scopes:
            'cidaas:hosted_pages_read': read access for hosted pages group
            'cidaas:hosted_pages_write': write access for hosted pages group
            'cidaas:hosted_pages_delete': read access for hosted pages group
            'cidaas:theme_read': Provides read access to themes
            'cidaas:theme_write': Provides write access to themes
  parameters:
    id:
      name: id
      in: path
      required: true
      description: The unique id of a hosted pages group.
      schema:
        type: string
