Natural Security provides several application programming interfaces (APIs). They are Natural subprograms and can be divided into four categories:
subprograms for access verification and user authentication;
subprograms to perform Natural Security Administrator Services functions from outside
the Natural Security library SYSSEC;
subprograms to perform Natural Security maintenance functions from outside the
Natural Security library SYSSEC;
subprograms to perform Natural Security retrieval functions from outside the Natural
Security library SYSSEC.
Each subprogram to be used has to be copied into the library in which it is to be executed, or into one of the steplibs concatenated to that library.
Note
The subprograms (with the exception of SECNOTE) cannot be invoked from
any of the logon-related user exits described in the section User Exits.
To list the APIs:
On the Main Menu, select Administrator Services.
If you are allowed access to Administrator Services, the Administrator Services Menu 1 will be displayed.
Press PF8.
On the Administrator Services Menu 2, select Application Programming Interfaces.
A list of the interface subprograms along with relevant examples will be displayed. You can filter the result using the following search fields:
Example: Search for a specific group of examples.
Interface: Search for a required API interface.
Description: Filter examples by descriptive keywords.
Several of the subprograms contain the field PRC. It contains the return
code. This will be 0 if the function was performed successfully. Any other
return code nnnn corresponds either to a Natural Security error
number or, if prefixed with a hyphen (-), to a Natural system error number. You can
display the corresponding message by entering the Natural system command:
HELP Unnnn for a Natural
Security message, in the library SYSSEC; or
HELP nnnn for a Natural system
message.