Get a Snippet
Returns a single snippet for the portal. Each snippet has a name, title, and content. Public snippets will be returned for non-authenticated users, while both private and public snippets will be returned for authenticated users.
Path Parameters
Targeted snippet, url-encoded. Must not start with /.
Example:mysnippet
Response
application/json
Response
A single portal snippet
PortalSnippet
A single snippet for the portal
The unique identifier of the page
Example:582b9327-3eba-4bfe-9438-6066840dbbca
The title of the snippet
Example:My Snippet
The name of the snippet (no leading slash)
Example:my-snippet
The renderable markdown content of the snippet
Example:# Welcome to the Developer Portal
Whether the page or snippet is public or private. Private pages and snippets are only accessible to authenticated users.
Allowed values:publicprivate
Example:public
Example:A custom page about developer portals
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Get Portal Logo
Gets logo of the developer portal.
Response
200
Response
An image asset
Get Portal Favicon
Gets favicon of the developer portal.
Response
200
Response
An image asset
PortalContext
objectDescribes the portal execution context
ID of the portal
ID of the organization
Whether the portal can be accessed via email and password
Whether the portal can be accessed via authentication with Single Sign On (SSO) through OpenID Connect (OIDC) from a third-party Identity Provider
Whether the portal can be accessed via SAML authentication
Whether authentication is enabled for the portal
Whether Role-Based Access Control is enabled for the portal
Name of the developer portal
The canonical domain of the developer portal
PortalCustomization
objectThe custom settings of this portal