Authentication

It displays the ZSPEC description provided for the <authentication> in the center pane of the document.

Possible Locations

Child Elements

Attributes


Name Type Description
name
required
String Name of the authentication schema as declared in the ZSPEC.
title String The name, which has to be displayed in the help document.
home-page Boolean Decides whether this element has to be displayed as home page.
  • true: It will be displayed as the home page.
  • false (default): It will not be displayed as the home page.

Example

By default, the authentication details that you provide in the ZSPEC will be picked along with its operation names and will be built as follows,

    
copy
<custom title="Authentications"> <authentication name="commons.OAuth2Flow"> <operation name="commons.Authorization Request" /> <operation name="commons.Refresh Token" /> <operation name="commons.Generate Token" /> </authentication> </custom>

Based on your requirement you can edit and customize this element.

Last Updated 2025-05-30 16:54:59 +0530 +0530