Oracle API Gateway Administrator Guide
11g Release 2 (11.1.2.3.0)
Oracle API Gateway Administrator Guide, 11g Release 2 (11.1.2.3.0)
Copyright © 1999, 2014, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications which may create a risk of personal injury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of this software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software in dangerous applications.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
This software and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services. This documentation is in prerelease status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.
The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.
This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Software License and Service Agreement, which has been executed and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.
27 May 2014
Contents
- 1. API Gateway administration
- 2. Manage an API Gateway domain
-
- Configure an API Gateway domain
- Manage domain topology in API Gateway Manager
- Managedomain command reference
- Secure an API Gateway domain
-
- Overview
- How SSL certificates are signed in a domain
- Add the first Admin Node Manager to the domain
- Add a Node Manager to the domain
- Add an API Gateway instance to the domain
- Change the admin capabilities of a Node Manager
- Change the domain SSL certificate
- Admin Node Manager backup and disaster recovery
- SSL private key and certificate locations
- 3. Manage the API Gateway
-
- Start and stop the API Gateway
- Start the API Gateway tools
- Configure an API Gateway encryption passphrase
- Run API Gateway as non-root on UNIX/Linux
-
- Overview
- Linux capabilities
- Before you begin
- Modify API Gateway file ownership
- Set the CAP_NET_BIND capability on vshell
- API Gateway appliance version 7.1.0 or later
- Add API Gateway library locations
- Modify the init.d script to use sudo
- Modify the jvm.xml file
- Restart the API Gateway
- Run API Gateway as non-root on Solaris
- Configure API Gateway high availability
- Manage certificates and keys
- Manage API Gateway settings
- 4. Deploy API Gateway configuration
-
- Manage API Gateway deployments
- Deploy API Gateway configuration
-
- Overview
- Create a package in Policy Studio
- Configure package properties in Policy Studio
- Deploy packages in Policy Studio
- Deploy a factory configuration in Policy Studio
- Deploy currently loaded configuration in Policy Studio
- Push configuration to a group in Policy Studio
- View deployment results in Policy Studio
- Deploy on the command line
- Deploy packages in API Gateway Manager
- 5. Troubleshoot your API Gateway installation
- 6. Manage user access
-
- Manage API Gateway users
- Manage Admin users
- Configure Role-Based Access Control (RBAC)
- Active Directory for authentication and RBAC of management services
-
- Overview
- Step 1: create an Active Directory group
- Step 2: create an Active Directory user
- Step 3: create an LDAP connection
- Step 4: create an LDAP repository
- Step 5: create a test policy for LDAP authentication and RBAC
- Step 6: use the LDAP policy to protect management services
- Add an LDAP user with limited access to management services
- OpenLDAP for authentication and RBAC of management services
-
- Overview
- Step 1: create an OpenLDAP group for RBAC roles
- Step 2: add RBAC roles to the OpenLDAP RBAC group
- Step 3: add users to the OpenLDAP RBAC group
- Step 4: create an LDAP connection
- Step 5: create an OpenLDAP repository
- Step 6: create a test policy for LDAP authentication and RBAC
- Step 7: use the OpenLDAP policy to protect management services
- 7. Manage ActiveMQ messaging
- 8. Monitoring and reporting
- 9. Manage network-level settings
- 10. API Gateway settings reference