2 Getting Started with Oracle Access Management Administration and Navigation

2.1 Prerequisites

All tasks in this book presume that you have Oracle Access Management 11.1.2 deployed as described in the Oracle Fusion Middleware Installation Guide for Oracle Identity and Access Management.

Before you begin tasks in this book, be sure to review information in this chapter:

• Learn about "Starting and Stopping Servers in Your Deployment".

• Learn about the Oracle Access Management Console as described in "Introduction to the Oracle Access Management Console and Controls".

• Verify the administrative LDAP group defined in the primary user identity store.

2.2 Starting and Stopping Servers in Your Deployment

Oracle Access Management Administrators can access the Oracle Access Management Console, which is deployed on the WebLogic Administration Server (AdminServer), only when the WebLogic Administration Server is running. If the Oracle Access Management Console is protected by a Webgate, the OAM Server must also be running. Node Manager must also be running.

For more information, see:

• Starting Node Manager

• Starting and Stopping AdminServer

• Starting and Stopping OAM Servers

startManagedWebLogic.sh oam_server1 http://examplewlsadminhost.example.com:7001

stopManagedWebLogic.sh oam_server1 http://examplewlsadminhost.example.com:7001

2.3 Introduction to Oracle Access Management Administrators

A single default LDAP group, the WebLogic Server Administrators group, is set in the Default User Identity Store (Embedded LDAP). During initial deployment, using the Oracle Fusion Middleware Configuration Wizard, the Administrator userID and password are set. These credentials grant access to:

• Oracle Access Management Console to register and manage system configurations, security elements, and policies.

• WebLogic Server Administration Console to view the Summary of Server Configuration (Cluster, Machine, State, Health, and Listening Port) of deployed OAM Servers within the WebLogic Server domain, and also to Start, Resume, Suspend, Shutdown, or Restart SSL on these servers.

  For details about the WebLogic Server Administration Console, see Oracle Fusion Middleware Administrator's Guide.

• Custom Administrative command-line tools (WebLogic Scripting Tool, also known as WLST) provide an alternative to the Oracle Access Management Console for a specific set of functions

• Remote registration tool for registering and updating agents, Application Domains, and policies

Table 2-1 describes the Administrator Role that is recognized by Oracle Access Management and WebLogic, and the default LDAP group to which the Role is mapped in the common Default System User Identity Store.

Initially, administrative users must log in to the Oracle Access Management Console using the WebLogic Administrator credentials set during initial configuration. However, your enterprise might require independent sets of Administrators: one set of users responsible for Oracle Access Management administration and a different set for WebLogic administration. For more information, see "Managing the Administrators Role".

2.4 Logging In to and Signing Out of Oracle Access Management Console

The Oracle Access Management Console provides administrative access to Oracle Access Management services and configuration. This section describes how to log in to and sign out of the Oracle Access Management Console.

This section provides the following topics:

• Logging In to the Oracle Access Management Console

• Signing Out of Oracle Access Management Console

2.4.1 Logging In to the Oracle Access Management Console

When accessing the Oracle Access Management Console, the WebLogic Server (AdminServer) host and port must be specified. In the sample URL https://examplewlsadminhost.example.com:7001/oamconsole:

• HTTPS represents the Hypertext Transfer Protocol (HTTP) with the Secure Socket Layer (SSL) enabled to encrypt and decrypt user page requests and the pages returned by the Web server

• examplewlsadminhost.example.com refers to fully-qualified domain name of the computer hosting the Oracle Access Management Console

• 7001 refers to the designated bind port for the Oracle Access Management Console, which is the same as the bind port used for AdminServer (the WebLogic Server Administration Console)

• /oamconsole/ refers to the Oracle Access Management Console Log In page

Note:

If you specify and OAM Server host and port (as you would to access the ODSM console), the AdminServer redirects to the managed server which produces a 404 Not Found error.

The Oracle Access Management Console log in page is shown in Figure 2-1.

Figure 2-1 Default Oracle Access Management Console Log In Page

Description of "Figure 2-1 Default Oracle Access Management Console Log In Page"

Note:

Ensure that you use the correct administrative credential for log in. Initially, the LDAP group for the Oracle Access Management Console Administrator is the same as the LDAP group defined for the WebLogic Server Administration Console (Administrators) and the common Default System User Identity Store store is the WebLogic Embedded LDAP.

To log in to Oracle Access Management Console

1. In a browser window, enter the URL to the Oracle Access Management Console using the appropriate protocol (HTTP or HTTPS). For example:

        https://hostname:port/oamconsole/
   

   In the sample URL shown here:

   • HTTPS represents the Hypertext Transfer Protocol (HTTP) with the Secure Socket Layer (SSL) enabled to encrypt and decrypt user page requests and the pages returned by the Web server

   • hostname refers to fully-qualified domain name of the computer hosting the Oracle Access Management Console (AdminServer)

   • port refers to the designated bind port for the Oracle Access Management Console, which is the same as the bind port for the AdminServer

   • /oamconsole/refers to the Oracle Access Management Console Log In page

2. On the Log In page, enter the Oracle Access Management Console Administrator credentials. For example:

   Username: Admin_login_id

   Password: Admin_password

3. Click the Log In button or press the Enter key.

4. Proceed as follows:

   • Successful: Policy Configuration and System Configuration tabs appear on the left; Welcome page is on the right. Tour the console, as described in "Introduction to System Configuration and Policy Configuration Tabs" or start performing tasks on your own.

   • Not Successful: See "Administrator Lockout".

     See Also:

     "Introduction to Oracle Access Management Administrators"

2.4.2 Signing Out of Oracle Access Management Console

The Sign Out link appears in the upper-right corner of the Oracle Access Management Console, as shown in Figure 2-2. You select the Sign Out link to conclude your session. Oracle recommends that you also close the browser window after signing out.

Figure 2-2 Sign Out Link, Oracle Access Management Console

Description of "Figure 2-2 Sign Out Link, Oracle Access Management Console"

To sign out of Oracle Access Management Console

1. Click the Sign Out link in the upper-right corner of the console.

2. Close your browser window.

2.5 Introduction to the Oracle Access Management Console and Controls

The Oracle Access Management Console is a Web-based program that provides function-level tabs and controls, as well as page-level tabs and controls. This section introduces the Oracle Access Management Console.

The Oracle Access Management Console provides the system and policy configuration management functions required by Oracle Access Management Administrators. You can enter the URL to the Oracle Access Management Console in a browser window:

     https://example:port/oamconsole

In the sample URL, hostname refers to computer that hosts the Oracle Access Management Console; port refers to the HTTP port number on which the console host listens; /oamconsole refers to the Log In page.

This section provides a quick introduction to orient you to the Oracle Access Management Console.

• Console Layout and Controls

• Elements on a Page

• Selecting Controls in the Console

2.5.1 Console Layout and Controls

Figure 2-3 provides a look at the Oracle Access Management Console as it appears immediately after log in.

Figure 2-3 Oracle Access Management Console Welcome Page

Description of "Figure 2-3 Oracle Access Management Console Welcome Page"

The Oracle Access Management Console provides named function tabs on the left above the search controls and a menu and tool bar above the navigation tree. Open pages appear on the right. Currently the Welcome page is open.

Following topics provide more information:

• Welcome Page and Shortcuts

• Function-Level Tabs and Controls

• Content Pages and Page Controls

See Also:

"Selecting Controls in the Console"

2.5.1.1 Welcome Page and Shortcuts

Initially, the Welcome page is open and active on the right side of the console. Sections on the Welcome page include a brief description of a specific function and one or more shortcuts (links that you can select) to initiate certain tasks immediately as explained in Table 2-2.

Table 2-2 Welcome Page and Shortcuts

Welcome Page Shortcut Section	Description
	See the following topics for more information on each of the choices on the Configuration Shortcuts panel: "Enabling or Disabling Available Services" "Managing Common Settings" Part IV, "Managing Access Manager Settings and Agents" Part VIII, "Managing Oracle Access Management Security Token Service" Part VII, "Managing Oracle Access Management Identity Federation" Part IX, "Managing Oracle Access Management Mobile and Social"
	Click New ... to launch a fresh Create Agent page. See Also: "About the System Configuration Tab"
	Click New Application Domain to launch a fresh Application Domains page. See Also: "About the Policy Configuration Tab"
	Click New ... to launch a fresh page where you can enter appropriate details for a requester partner or relying party partner. See Part VIII, "Managing Oracle Access Management Security Token Service"for more information.

2.5.1.2 Function-Level Tabs and Controls

Table 2-3 introduces the function-level tabs in the Oracle Access Management Console.

Table 2-3 Function Tabs and Descriptions

Function Tab Name	Description
Policy Configuration	Provides access to definitions for Shared Components and Application Domains. This tab is active and the related navigation tree is visible for browsing on the left side of the screen when you enter the console. See "About the Policy Configuration Tab" for more information.
System Configuration Note: This is not the active tab when you enter the console.	Provides access to system-level definitions as shown here. See "About the System Configuration Tab" for more information.

The following topics provide more information about specific controls:

• Navigation Tree

• Menu and Tool Bar

• View Menu

• Actions Menu

See Also:

"Selecting Controls in the Console"

2.5.1.2.1 Navigation Tree

A navigation tree for the active configuration tab is provided on the left side of the console. Named nodes identify groups under which you can choose individual instances on which to take action.

The nodes in the navigation tree for the Policy Configuration and System Configuration tabs are shown in Figure 2-4. Notice the menu and tool bars above each navigation tree.

Figure 2-4 Navigation Trees with Menu and Tool Bars

Description of "Figure 2-4 Navigation Trees with Menu and Tool Bars"

See Also:

• About the System Configuration Tab

• About the Policy Configuration Tab

2.5.1.2.2 Menu and Tool Bar

Menus provide commands that you can use to take action on the selected item in the navigation tree. Many menu commands are also provided as command buttons in a tool bar for quick access. A menu and tool bar appear above each navigation tree in the console.

A different collection of menus and command buttons is available, depending upon the tab or subtab you are viewing. Additionally, certain configuration pages within the console include tables that provide a menu and tool bar. Figure 2-5.

Figure 2-5 Menu and Tool Bar Above Common Configuration Navigation Tree

Description of "Figure 2-5 Menu and Tool Bar Above Common Configuration Navigation Tree"

Command buttons appear in full color when the related function is available for use. When a function cannot be used, the command button (or menu item) appears grey. For instance, you can open a node and edit or delete a selected registration or definition. Table 2-4 provides a description of each command button in the tool bar. Some buttons are only available

Table 2-4 Command Buttons in the Tool Bar

Button	Definition	Description
	Create	Opens a fresh page under the selected node in the navigation tree, which you can fill in to add a new configuration of the selected type. The new page opens as the active page on the right side of the navigation tree. This is available when you can add a new configuration, for instance, under Server Instances, or a specific Agent type, or a user identity store, or a non-HTTP Resource Type or Host Identifier or Application Domain. Alternatively, use the Create command on the Actions menu as described in Table 2-6.
	Open	Opens the selected instance in the navigation tree.
	Edit	Opens the selected instance in the navigation tree to view or modify. The configuration page opens as the active page on the right side of the navigation tree. Alternatively, double click the instance name to display a page for editing.
	Delete	Removes the selected configuration. A deleted configuration is removed from the navigation tree and is no longer accessible to the system. For instance, if you delete an Agent configuration, the Agent is no longer registered and cannot be used. Alternatively, use the Delete command on the Actions menu as described in Table 2-6.
	Refresh	Revives the navigation tree, in the same way a Web browser refreshes a Web page.
	Detach	Separates the selected item (a results table on a configuration page, for instance) and displays it alone as a full page. Note: If you are viewing a detached table, you can click this button to re-attach it to the corresponding page and restore the standard page view.

Most commands available as buttons in the tool bar are also available on a menu.

See Also:

• View Menu

• Actions Menu

2.5.1.2.3 View Menu

Figure 2-6 illustrates the View menu, which is available for use with both the Policy Configuration and System Configuration tabs.

Figure 2-6 View Menu

Description of "Figure 2-6 View Menu"

Unavailable items (those that cannot be used on the selection in the navigation tree) appear in grey. View menu command descriptions are provided in Table 2-5.

Table 2-5 View Menu Command Descriptions

Command	Description
Expand	Immediately reveal items within the selected node in the navigation tree. This does not open or activate a configuration page. Alternatively, click the icon beside the node in the navigation tree.
Expand All Below	Immediately reveal everything within the selected node. For example, click Application Domains and then click Expand All Below to see all Application Domains.
Collapse All Below	Immediately close the selected node and conceal its content. This does not close an open page.
Expand All	Immediately reveal all nodes and instances in the navigation tree. This has no impact on open pages.
Collapse All	Immediately conceal all nodes and instances in the navigation tree. This has no impact on open pages.
Scroll to First Ctrl+Home	Locates and displays the first item in the navigation tree or results table.
Scroll to Last Ctrl+End	Locates and displays the last item in the navigation tree or results table.

2.5.1.2.4 Actions Menu

This menu is available only when the System Configuration tab is active. Figure 2-6 illustrates the Actions menu, which provides appropriate commands for the selected instance in the navigation tree. For example, if you have an identity store instance selected in the navigation tree one of the commands on the Actions menu enables you to monitor the instance.

Figure 2-7 Actions Menu

Description of "Figure 2-7 Actions Menu"

Certain commands on this menu mirror functions that are available by using command buttons in the tool bar. Unavailable items (those that cannot be used on the selection in the navigation tree) appear in grey. Actions menu command descriptions are provided in Table 2-6.

Table 2-6 System Configuration, Actions Menu, Command Descriptions

Command	Description
Open	Opens the configuration page for the selected instance in the navigation tree. This is not available when you have a node selected in the navigation tree. Alternatively, double-click the instance name in the navigation tree to open a page.
Create	Activates a fresh page that you can fill in to define a new configuration. Alternatively, click the Create (+) button in the tool bar as described in Table 2-4.
Monitor Menu	Available when you have an instance that can be monitored. For instance, if you have selected a Server instance in the navigation tree you can choose Monitor Menu to display associated information for the instance. For more information, see Chapter 9. Note: This item is disabled when you do not have an instance selected that can be monitored.
Open Common Properties	Disabled in this release. Replaced by Common Settings in the Common Configuration section of the System Configuration tab.
Delete	Removes the selected instance registration. The deleted registration is removed from the navigation tree and is no longer accessible to the system. For instance, if you delete an agent registration, the Agent is no longer registered and cannot be used. Alternatively, click the Delete (x) button in the tool bar as described in Table 2-4.

2.5.1.3 Content Pages and Page Controls

Like the Welcome page, any open content pages appear on the right side of the console.

The active content page is visible and generally provides a work space where you can add, view, or modify related settings. A named tab identifies each open page, like the tabs on manila folders. The tab of the active page is white.

Up to ten pages can be open simultaneously per configuration tab: Policy Configuration tab or System Configuration tab. Only the named tabs of opened pages for the currently active configuration tab are shown.

Only the active page is visible, with as many named tabs of other open pages that can fit on one line. You can click a named tab to activate the corresponding page. When named tabs of open pages do not fit on one line, a pointer is provided that enables you to open and choose from a list of concealed pages. Figure 2-8 illustrates multiple pages open at the same time. You can see named tabs for each page and controls to access pages that are concealed (or to close the active page or close multiple pages).

Figure 2-8 Tabs of Open Pages, and Page Controls

Description of "Figure 2-8 Tabs of Open Pages, and Page Controls"

Each page appears only once. No warning is issued if you attempt to open the same page multiple times. However, the page is only one time.

Note:

There is no warning if you open the page for the same item more than once.

The controls that you can use with open pages are described in Table 2-7.

See Also:

"Selecting Controls in the Console"

Table 2-7 Controls for Open Pages

Page Control	Definition	Description
	View a list of concealed pages	Click the pointer to display the list of concealed pages when you cannot view all open pages simultaneously.
	Close Active Page	Click this button to close the active page. Note: Closing a page before clicking Apply discards any changes or additions without warning. The changes are lost. You can use this to cancel changes you do not want to retain.
	Close Multiple Pages	Click this button to initiate closing multiple open pages. In the dialog box that appears, click the box beside the name of each page you want to close. Click OK to complete the action. Note: Closing a page before clicking Apply discards any changes or additions without warning. The changes are lost. You can use this to cancel changes you do not want to retain.

2.5.2 Elements on a Page

Pages in the console contain one or more graphical user interface elements as described in Table 2-8. For an example of each element n the console, see Figure 2-8 or log into the console and have a look.

Table 2-8 Page Elements and Descriptions

Page Element	Description
Named tab	Identifies each open page on the right side of the console. Also, displays a page of related, lower-level settings. See Figure 2-2 for an example.
Page controls	Enables you to close one or more pages. See Table 2-7.
Apply button	Submits changes or additions made to the page.
Named text box	Enables you to enter relevant details in the named field using the keyboard.
Option button	Enables you to choose one of several options. For example, you can click an option button to define a state (Enabled vs. Disabled) or a security mode (Open vs. Simple vs. Cert).
Tables	Displays current specifications or space for new specifications. Tables have independent command buttons independent from page-level and option buttons.
Command buttons for tables	Enables you to: Add a fresh row or definition to the table. Remove the selected row or definition from the table.
Drop down lists (list)	Found on certain pages to provide a menu of choices from which to choose when supplying information.

2.5.3 Selecting Controls in the Console

This section describes how to select the desired node or instance in the navigation tree, and selecting commands and page controls in the console. The usual selection guidelines apply.

Table 2-9 describes selections and controls.

Table 2-9 Selection Tasks and Controls

Task	Control	Description
Expand (open) a node		Click the Expand button (>) beside the desired node in the navigation tree to reveal nodes or instances within it.
Collapse (close) a node		Click the Collapse button (V) beside the desired node in the navigation tree to conceal nodes or instances beneath it.
Display View menu	Right-click mouse button	Right-click the desired node in the navigation tree to display a pop-up View menu.
Activate	Click mouse button	Click to activate the desired: Function tab: System Configuration, Policy Configuration, Browse, Search Named tab on a page to reveal related lower-level settings to view or modify: Resources and Responses, for instance. Named Page tab to reveal (activate) the page Text field to enter information on a page Page Control (close or close all buttons as described in Table 2-7)
Open	Click Item, Select Open command button	Click the item, click the Open command button: Resource Type name Host Identifier definition name Authentication scheme name Resource name in an Application Domain Authentication policy name in an Application Domain Authorization policy name in an Application Domain Agent instance name Server instance name User identity store instance name Database instance name Authentication module name System utility name
Highlight	Drag cursor	Drag the cursor across text in a box to highlight its content.
Select	Click mouse button	Click the desired item on which to operate. For example, click the desired: Icon, node, or instance name in the navigation tree (Shared Components is one example) Search Button: Initiates a search based on specified criteria Menu name and command to take action on the selected item in the navigation tree Command button to take immediate action: Menu and tool bar buttons (Table 2-4) Close page buttons (Table 2-7) Command Button on a Page or Table: Apply: Submits additions and changes on the active page. Table or section buttons (Table 2-8) Add a new row. Remove the selected row. Links: Help, and Sign Out are examples

2.6 Introduction to System Configuration and Policy Configuration Tabs

The active tab appears white. A View menu is always available. An Actions menu is available with only the System Configuration tab.

This section provides a quick tour to orient you to major Oracle Access Management functions available on the following tabs:

• About the System Configuration Tab

• About the Policy Configuration Tab

2.7 Viewing Configuration Details in the Console

Oracle Access Management Administrators can view configuration details of individual agents, servers instances, data sources, shared components, and Application Domains from the Oracle Access Management Console.

In this example, you will view configuration details for an OAM Agent (Webgate). However, you can use similar steps to view configuration details for server instances, data sources, Application Domains, or shared components.

Alternatively, you can use custom WLST commands to view agent and server details.

To view configuration details using the console

1. Go to the Oracle Access Management Console and log in as usual. For example:

        https://hostname:port/oamconsole
   

   In the sample URL, hostname refers to computer that hosts the Oracle Access Management Console; port refers to the HTTP port number on which the console host listens; /oamconsole identifies the Oracle Access Management Console.

2. System Configuration.

   1. Click the System Configuration (or Policy Configuration) tab.

   2. In the navigation tree, click the desired section name to display its content. For example:

      Access Manager

   3. Expand Node: Click the expansion icon beside the desired node (or from the View menu, click Expand All).

   4. Open Node: Double-click the name (or click to highlight the name, then click the folder icon in the tool bar.)

   5. Open a Unique Instance: Double-click the desired instance name to view its configuration or click the instance and click the Edit button (pencil) in the tool bar.

   6. View the page and note any specific details of interest.

   7. Close the page by clicking the X control in the upper-right corner.

3. Policy Configuration: Click to activate the Policy Configuration tab. Expand, open, view, and close nodes and instances and pages as you would in the System configuration tab.

2.8 Conducting Searches Using the Console

The Oracle Access Management Console provides search controls for specific elements (Agents, Application Domains, and Resources are some examples). A sample Search page is shown here. This page is used for OAM Agent searches.

Figure 2-9 Sample OAM Agent Search Page

Search pages differ depending on the entity you are trying to find. In all searches, you can leave a field blank to display everything or use a wildcard (*) character when you do not know the exact name you seek. However, capitalization in your search criteria must match capitalization of the item you seek.

Some search controls include the ability to save your search criteria. From the search results table, you can choose an item to open for viewing or editing.

2.9 Using Online Help

At any time while using the Oracle Access Management Console, you can click the Help link at the top of the page to get more information. Online Help topics link to information in an online version of this book.

Generally speaking, topics that are displayed by selecting Help in the Oracle Access Management Console appear in only English and Japanese languages. Online Help is not translated into the nine ADMIN languages.

You can click the Welcome tab to display a list of topics that describe actions you can take. For specific help topics, use the following procedure.

To locate a specific help topic

1. From the Oracle Access Management Console, click a tab or named node in the navigation tree.

2. Click Help in the upper-right corner of the console.

3. Review the page that appears in a new window and select one of the following links to:

   • More—Click this link to view more information.

   • How?—Click this link to see steps to perform a task related to your help search.

   • Contents—In the left Help pane, expand Contents to see all help topics as well as all topics in the online manual.

   • Search—Displays a search window where you can enter your help search criteria.

4. Click the following buttons, as needed:

   • View—Displays a set of viewing options.

   • Arrows—Return to the previous page or go forward to the next page.

   • Printer Icon—Prints the page.

   • Envelope Icon—Emails the page.

2.10 Command-Line Tools

Several command-line tools are available to perform various tasks using the keyboard rather than the console. After using these commands, configurations will be available in the console:

• Remote registration tool, oamreg, enables remote registration of Agents, and creation of default Application Domains.

  See Also:

  Chapter 13, "Registering and Managing OAM 11g Agents"

• Upgrade Assistant (UA) enables you to transfer OSSO 10g configuration to Oracle Access Management

  See Also:

  • Oracle Fusion Middleware Update, Upgrade, and Migration Guide for Oracle Identity and Access Management

• Oracle WebLogic Scripting Tool (WLST) provides a number of custom OAM command-line alternatives for tasks you can perform in the Oracle Access Management Console.

  See Also:

  Oracle Fusion Middleware WebLogic Scripting Tool Command Reference

2.11 Logging, Auditing, Monitoring Performance

Logging is the mechanism by which components write messages to a file. These messages can be logged at different levels of granularity. Oracle Access Management components use the same logging infrastructure and guidelines as any other component in Oracle Fusion Middleware 11g.

In Oracle Fusion Middleware, auditing provides a measure of accountability and answers to the "who has done what and when" types of questions. Oracle Access Management uses the Oracle Fusion Middleware Common Audit Framework to support auditing for a large number of user authentication and authorization run-time events, and administrative events (changes to the system). The Oracle Fusion Middleware Common Audit Framework provides uniform logging and exception handling and diagnostics for all audit events.

Administrators can monitor performance and log messages for Access Manager and Security Token Service using Oracle Fusion Middleware Control.

For more information, see Part III, "Common Logging, Auditing, Performance Monitoring and Tuning".

• Chapter 6, "Logging Component Event Messages"

• Chapter 7, "Logging Webgate Event Messages"

• Chapter 8, "Auditing Administrative and Run-time Events"

• Chapter 9, "Monitoring Performance by Using Oracle Access Management Console"

• Chapter 10, "Monitoring Performance and Logs with Fusion Middleware Control"