Administration and Configuration Guide

B Appendix B – Additional Information in REST APIs for User Status and User Access Reports

In addition to the REST API Endpoints discussed in the Using REST APIs for User Management from Third-Party IDMs section, the User Status Report and User Access Report have more fields that are part of the Get Response populates additional fields in v8.1.2.0.0+ on applying the 33150367 One-off Patch from My Oracle Support.

Prerequisites

See the Using REST APIs for User Management from Third-Party IDMs section for information about REST APIs in OFSAA.
You must apply the 33150367 One-off Patch from My Oracle Support.

Reference Table

The following table provides details for the Additional REST API Specifications for User Status Report and User Access Report:

Table B-1 User Status and User Access Reports - Additional REST API Specifications

No	Requirement	URL	Method Type	Request	Sample Request JSON	Comments
1	User Status Report	/rest-api/v1/user/status?userId=<USERID>&userName=<USERNAME>&idledays=<Number of days idle>&gsUserID=<Logged-in user>&loggedIp=<IP Address>&enable=<Y/N>&delete=<Y/N>&loggedIn=<Y/N>	GET	-	For example: https://<HOST_NAME:PORT>/<CONTEXTNAME>/rest-api/v1/user/status?userId=exampleUserID&userName=exampleUserName &idledays=&gsUserID=SYSADMN&loggedIp=<192.0.2.1>&enable=Y&delete=N&loggedIn=Y	The JSON request displays the Report for the deleted, disabled, currently logged in, and idle Users. Note: If you do not enter the values for the gsUserID and loggedIp attributes in this API, the transaction is not recorded in audit. If you do not enter the values for the userId and userName attributes in this API, the records for all the users is displayed. userID is the OFSAA identifier of the User for whom the report is to be generated. userName is the OFSAA login name for the above User ID. idledays is the number of days (INTEGER) the user has not logged into the system. gsUserID is the User ID of the user logged in and accessing the system. loggedIP is the IPv4 address of the workstation from where the RESTful API IP is invoked. An alternative is to configure it to the loopback address 127.0.0.1. enable is the flag to detemine if the user is enabled or disabled in the system. The valid values are Y for yes and N for no. delete is the flag to detemine if the user is deleted in the system. The valid values are Y for yes and N for no. loggedIn is the flag to detemine if the user is currently logged into the system. The valid values are Y for yes and N for no. Oracle recommends that you copy and paste the URL and modify the placeholders. In addition, the fields shown in the next row are added to the User Status Report:
						Start Date - Displays the Start Date configured of the period for the User to be active in the system. End Date - Displays the End Date configured of the period for the User to be active in the system. Login Holidays - Displays whether the user is allowed to access the system on holidays or not. SMS Auth Only - Displays if the User can be authenticated through SMS. Created Date - Displays the date on which the User was created in the system. Last Modified Date - Displays the date on which the details of the User were last updated in the system. Last Password Change Date - Displays the date when the password was changed the last time around for the User. Last Enabled Date - Displays the date when the User was last enabled in the system. Last Disabled Date - Displays the date when the User was last disabled in the system. Deleted Date - Displays the date when the User was deleted from the system.
2	User Access Report	/rest-api/v1/user/useraccess?userId=<USERID>&userName=<USERNAME>&gsUserID=<Logged-in User>&loggedIp=<IP Address>	GET	-	For example: https://<HOST_NAME:PORT>/<CONTEXTNAME>/rest-api/v1/user/useraccess?userId=exampleUserID&userName=exampleUserName&gsUserID=SYSADMN&loggedIp=<192.0.2.1>	The JSON request displays the Report for User Access Rights. Note: If you do not enter the values for the gsUserID and loggedIp attributes in this API, the transaction is not recorded in audit. If you do not enter the values for the userId and userName attributes in this API, the records for all the users is displayed. userID is the OFSAA identifier of the User for whom the report is to be generated. userName is the OFSAA login name for the above User ID. gsUserID is the User ID of the user logged in and accessing the system. loggedIP is the IPv4 address of the workstation from where the RESTful API IP is invoked. An alternative is to configure it to the loopback address 127.0.0.1. Oracle recommends that you copy the URL and modify the placeholders. In addition to the textbox Search Filters such as User ID and User Name, you can also search with the check box Search Filters: Group, Role, and Functions. See the folloing rows for details.
3	User Access Report – group=Y	/rest-api/v1/user/useraccess?userId=<USERID>&userName=<USERNAME>&gsUserID=<Logged-in User>&loggedIp=<IP Address>&group=Y	GET		For example: https://<HOST_NAME:PORT>/<CONTEXTNAME>/rest-api/v1/user/useraccess?userId=exampleUserID&userName=exampleUserName&gsUserID=SYSADMN&loggedIp=<192.0.2.1>&group=Y	The JSON request displays the Report for User Access Rights. Note: If you do not enter the values for the gsUserID and loggedIp attributes in this API, the transaction is not recorded in audit. If you do not enter the values for the userId and userName attributes in this API, the records for all the users is displayed. userID is the OFSAA identifier of the User for whom the report is to be generated. userName is the OFSAA login name for the above User ID. gsUserID is the User ID of the user logged in and accessing the system. loggedIP is the IPv4 address of the workstation from where the RESTful API IP is invoked. An alternative is to configure it to the loopback address 127.0.0.1. Groups mapped to the selected user are displayed. The valid value is Y. Oracle recommends that you copy the URL and modify the placeholders.
4	User Access Report – role=Y	/rest-api/v1/user/useraccess?userId=<USERID>&userName=<USERNAME>&gsUserID=<Logged-in User>&loggedIp=<IP Address>&role=Y	GET		For example: https://<HOST_NAME:PORT>/<CONTEXTNAME>/rest-api/v1/user/useraccess?userId=exampleUserID&userName=exampleUserName&gsUserID=SYSADMN&loggedIp=<192.0.2.1>&role=Y	The JSON request displays the Report for User Access Rights. Note: If you do not enter the values for the gsUserID and loggedIp attributes in this API, the transaction is not recorded in audit. If you do not enter the values for the userId and userName attributes in this API, the records for all the users is displayed. userID is the OFSAA identifier of the User for whom the report is to be generated. userName is the OFSAA login name for the above User ID. gsUserID is the User ID of the user logged in and accessing the system. loggedIP is the IPv4 address of the workstation from where the RESTful API IP is invoked. An alternative is to configure it to the loopback address 127.0.0.1. Groups and Roles mapped to the selected user are displayed The valid value is Y. Oracle recommends that you copy the URL and modify the placeholders.
5	User Access Report – function=Y	/rest-api/v1/user/useraccess?userId=<USERID>&userName=<USERNAME>&gsUserID=<Logged-in User>&loggedIp=<IP Address>&function=Y	GET		For example: https://<HOST_NAME:PORT>/<CONTEXTNAME>/rest-api/v1/user/useraccess?userId=exampleUserID&userName=exampleUserName&gsUserID=SYSADMN&loggedIp=<192.0.2.1>&function=Y	The JSON request displays the Report for User Access Rights. Note: If you do not enter the values for the gsUserID and loggedIp attributes in this API, the transaction is not recorded in audit. If you do not enter the values for the userId and userName attributes in this API, the records for all the users is displayed. userID is the OFSAA identifier of the User for whom the report is to be generated. userName is the OFSAA login name for the above User ID. gsUserID is the User ID of the user logged in and accessing the system. loggedIP is the IPv4 address of the workstation from where the RESTful API IP is invoked. An alternative is to configure it to the loopback address 127.0.0.1. Groups, Roles, and Functions mapped to the selected user are displayed. The valid value is Y. Oracle recommends that you copy the URL and modify the placeholders.