• webMethods Developer Portal Documentation
•  About this Documentation
  • Document Conventions
•  Getting Started with Developer Portal
  •  Let's get you started
    • Developer Portal Overview
    • Quick Start Milestones
    • Installing Developer Portal
    • Configuring Elasticsearch Database
    • Installing stand-alone Developer Portal using Docker
    • Launching and signing in to Developer Portal
    • Next steps...
•  Using Developer Portal
  •  Overview
    • Why do Organizations Expose APIs?
    • Why do APIs Need to be Managed?
    • About IBM webMethods Developer Portal
  •  Administration
    • Overview
    • Configuring SMTP Settings
    • Configuring Password Policy
    •  Security Settings
      • Configuring User Account Lockout Settings
      • Configuring Multi-factor Authentication Settings
      • Configuring Advanced Security Settings
    • Configuring User Session Settings
    •  Configuring Email Notification Templates
      • List of email notification templates available in Developer Portal
    •  Configuring Webhooks
      • List of Events
    • Configuring Webhooks to notify User Sign-up and Application Requests to an External Approval System
    • Specifying the Developer Portal URL for reference from External Systems
    • Specifying Cross-Origin Resource Sharing (CORS) URLs
    • Updating the Developer Portal License
    • Configuring API Control Plane Communication
    • Configuring the Default Group and Community for New Users
    • Viewing Audit Log Events
    • Configuring Default Language
    • Configuring Personal Profile Settings
    • Configuring Payment Gateway
    • Adding Payment Details (for consumers)
    • Externalizing configurations
    •  Data Backup and Restore
      •  Performing Data Backup
        • Setting Backup Limit
      • Restoring Data from a Backup File
    •  High Availability Configuration
      •  Configuring High Availability
        • Configuring Elasticsearch
        • Configuring Ignite
        • Configuring Developer Portal
        •  Configuring Load Balancer
          • Post-configuration
    •  Developer Portal Ports Configuration
      • Ports Configuration
      • Configuring Keystore
      • Disabling HTTPS Port
      • Directing requests to HTTPS Port
    • Configuring Developer Portal Communication with secured API Gateway
  •  Customization
    • Overview
    •  Managing Themes
      • Creating Theme for customizing the Developer Portal UI
    •  Customize Pages
      •  Customizing a Block on a Page
        • Customization Fields
      • Adding Blocks and Components
      • Moving Blocks
      • Removing Blocks
      •  Adding Pages
        • Assigning Access to a Custom Page
    •  Customize UI Components
      • Adding new item to the Top Navigation Bar
      • Customizing Top Navigation Bar
      • Customizing Sign up Page
      • Customizing API Grid
      • Customizing Package Grid
      • Customizing API details Pane
      • Customizing Plans Grid
      • Adding Language Switcher Icon
    •  Customize Labels
      • Adding new UI Labels
    •  Customize Color Schemes
      • Customizing Color Schemes
      • Customizing Browser Header Text and Icon
    •  Customization using Web Components
      • Registering Web Components
      • Sample Web Component files
    • Customization example
  •  Users
    • Overview
    •  Native Registration
      • Adding User
      • Adding User Group
      • Inviting users to sign up
      • Assigning user privileges
      • Disabling user registration from the Sign up page
      •  Onboarding strategy
        • Configuring user onboarding strategy
        • Configuring internal onboarding approval workflow
        • Approving User Onboarding Requests
    •  LDAP users and groups onboarding
      • Creating LDAP connection
      • Creating LDAP connection to a secured LDAP server
      • Specifying LDAP connection attributes
      • Importing users and user groups from LDAP server
    •  Single Sign-On Users Onboarding
      •  SAML SSO Onboarding
        • Onboarding SAML Users
        • Configuring SAML Users Onboarding Configurations
      •  User Onboarding using Social Media Account
        • Onboarding Users with Social Media Credentials
    •  User Preferences
      • Modifying user details
      • Changing your Password
      • Viewing communities
      • Configuring notification preference
      • Scheduling usage reports
    •  Data Anonymization
      • Enabling or disabling automatic anonymization from UI
      • Anonymizing deleted user data using REST API
    • Configuring consumer visibility
  •  Providers
    • Overview
    • Creating Provider
    • Mapping API or Callback URL to Provider
    •  Third-party API Gateway Configuration
      • Integrating Third-party Gateway with Developer Portal
      • Creating and Attaching Webhook
      • Publishing APIs from Third-party Gateway to Developer Portal
      • Requesting Application for Third-party Gateway APIs
      • Publishing API analytics to Developer Portal
    •  API Partner Isolation
      • API Partner Capabilities
      • Onboarding an API partner
      • Assigning Asset Ownership
  •  Communities
    • Overview
    • Creating Community
    • Mapping User, Group, or API to Community
    • Configuring visibility of users based on communities
  •  Assets
    •  APIs
      • Creating API
      • Edit basic attributes of API
      • Editing advanced attributes of API
      • Creating new version of API
      • Viewing Code Snippets of REST APIs
      • Downloading Client Software Development Kit (SDK) for REST API resources
      • Configuring rate limit for APIs
      •  Trying APIs
        • Trying REST API
        • Trying SOAP API
        •  Trying OData API
          • Authorization fields
        • Troubleshooting Tips: Testing APIs published from API Gateway
    •  Applications
      • Configuring application or subscription onboarding strategy
      •  Creating applications
        • Creating applications from Manage applications screen
        • Creating Application from API details screen
        • Creating Application from Try API screen
        • Approving Application or Package Subscription Requests
    •  Custom Asset Management
      • Configure asset types
      • Adding custom asset to publish to Developer Portal
      • Adding custom asset gallery to UI
    •  Lifecycle Management of APIs and Packages
      • Lifecycle feature considerations
      •  Customizing Lifecycle States
        • Sample scenario
      • Enabling lifecycle feature for APIs and Packages
      •  Modifying state of APIs
        • How do I change the state of an API to expose it to consumers?
        • Changing the state of a Live API
        • Changing an API's state to retire it from usage
      •  Modifying state of packages
        • Changing lifecycle state of packages
        • Changing lifecycle state of live packages
        • Change state of packages
  •  Analytics
    •  Analytics
      • Viewing user analytics dashboard
      • Viewing API economy insights dashboard
      • Viewing API economy trends dashboard
      • Viewing Programs dashboard
      • Viewing API usage analytics dashboard
      • Viewing applications usage dashboard
  •  REST APIs
    • Overview
    • Viewing analytics
    • Managing APIs
    • Managing applications
    • Managing approvals
    • Managing backup and restore
    • Managing comments
    • Managing communities
    • Managing configurations
    • Managing custom assets
    • Viewing Developer Portal events
    • Viewing Developer Portal health
    • Managing notifications
    • Getting OAuth token
    • Managing packages
    • Managing payment gateway configurations
    • Managing programs
    • Managing plans
    • Managing providers
    • Performing search
    • Managing teams
    • Managing topics
    • Managing application and subscription requests
    • Managing users
    • Managing webhooks
  •  Docker support
    • Docker support
    • Generating Docker Image from Installation
    • Running the Developer Portal Docker Image
  •  API Programs
    • About API Programs
    •  Hackathons
      • Creating a hackathon
      • Inviting participants for an API program
      • Assigning owners for an API program
      • Registering for a hackathon
      • Adding Team members for a Hackathon
      • Adding a hackathon project
    •  Beta programs
      • Creating a beta program
      • Registering for a beta program
      • Adding ticket for a beta program

webMethods Developer Portal Documentation

Adding ticket for a beta program