Version: 2.1.0

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.

Learn more: Hosted Pages Overview

Management of hosted pages

• Create and update a hosted page group - Use POST /hostedpages-srv/hpgroup to create or update a hosted pages group
• Delete a hosted page group - Use DELETE /hostedpages-srv/hpgroup/{id} to remove an entire group
• Find hosted pages groups based on hosted page IDs and owner types - Use GET /hostedpages-srv/hpgroup with query parameters
• Manage individual hosted pages - Add, update, or remove specific pages within a group using POST /hostedpages-srv/hpgroup/{id} and DELETE /hostedpages-srv/hpgroup/{id}/{hpid}
• Manage hosted page themes - Customize the visual appearance using theme APIs (see Theming Guide)
• Manage translations - Add custom translations for different locales (see Translation Guide)

Determining hosted pages

• Determine the hosted page when ID and current locale values are passed using GET /hostedpages-srv/hpgroup/{id}/{hpid} with optional locale parameter.

CRUD Operations Overview

Hosted Pages Groups:

• Create: POST /hostedpages-srv/hpgroup - Creates a new hosted pages group or updates existing one
• Read: GET /hostedpages-srv/hpgroup (list all) or GET /hostedpages-srv/hpgroup/{id} (get by ID)
• Update: POST /hostedpages-srv/hpgroup (same as create, updates if ID exists)
• Delete: DELETE /hostedpages-srv/hpgroup/{id} - Removes the entire hosted pages group

Individual Hosted Pages:

• Create: POST /hostedpages-srv/hpgroup/{id} - Adds a new hosted page to an existing group
• Read: GET /hostedpages-srv/hpgroup/{id}/{hpid} - Retrieves a specific hosted page with locale support
• Update: POST /hostedpages-srv/hpgroup/{id} - Updates an existing hosted page in the group
• Delete: DELETE /hostedpages-srv/hpgroup/{id}/{hpid} - Removes a specific hosted page from the group

Themes:

• Create: POST /hostedpages-srv/themes - Uploads a new theme CSS file
• Read: GET /hostedpages-srv/themes (list all) or GET /hostedpages-srv/themes/{filename} (get specific theme)
• Update: Upload a new version with the same filename using POST /hostedpages-srv/themes
• Delete: DELETE /hostedpages-srv/themes/{filename} - Removes a theme file
• Learn more: Theming Guide

Translations:

• Create: POST /hostedpages-srv/translations - Creates a new translation for a locale
• Read: GET /hostedpages-srv/translations (list all) or GET /hostedpages-srv/translations/{localeId} (get specific)
• Update: PUT /hostedpages-srv/translations/{localeId} - Updates an existing translation
• Delete: DELETE /hostedpages-srv/translations/{localeId} - Removes a translation
• Learn more: Translation Guide

Authentication

OAuth 2.0: OAuth2

Security Scheme Type:	oauth2
OAuth Flow (authorizationCode):	Token URL: https://domain/token-srv/token Authorization URL: https://domain/authz-srv/authz 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 delete access for a hosted pages group. cidaas:theme_read: Provides read access to themes cidaas:theme_write: Provides write access to themes cidaas:theme_delete: Provides delete access to themes
OAuth Flow (clientCredentials):	Token URL: https://domain/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 delete access for a hosted pages group. cidaas:theme_read: Provides read access to themes cidaas:theme_write: Provides write access to themes cidaas:theme_delete: Provides delete access to themes
OAuth Flow (implicit):	Authorization URL: https://domain/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: delete access for hosted pages group cidaas:theme_read: Provides read access to themes cidaas:theme_write: Provides write access to themes cidaas:theme_delete: Provides delete access to themes

Contact

cidaas support: [email protected]

URL: https://support.cidaas.com

Terms of Service

https://www.cidaas.com/terms-of-use/