Setting up JCE Policy Files for Oracle WebLogic Server

9 Oracle Identity Federation Command-Line Tools 9-1 9 Oracle Identity Federation Command-Line Tools This chapter describes the command-line tools available for Oracle Identity Federation. ■ Introduction to Command-Line Tools for Oracle Identity Federation ■ Oracle Identity Federation Commands

9.1 Introduction to Command-Line Tools for Oracle Identity Federation

WLST is the command-line utility for administering Oracle Fusion Middleware components and applications. It provides another option for administration in addition to Oracle Enterprise Manager Fusion Middleware Control. The WLST command-line utility provides a complete range of tools to manage Oracle Identity Federation, including commands for: ■ Property Management ■ Federation Management ■ Custom SP and Authentication Engine Management ■ Message Store Maintenance

9.1.1 Setting up the WLST Environment

Execute the following commands to set up the environment so you can run the WLST commands: On Linux The syntax to set up the environment on Linux systems is: bash export DOMAIN_HOME=PATH_TO_DOMAIN_HOME source ORACLE_HOMEfedscriptssetOIFEnv.sh replace ORACLE_HOME with the correct path for your environment. See Also: Oracle Fusion Middleware WebLogic Scripting Tool Command Reference for detailed background and explanation of the WLST utility. 9-2 Oracle Fusion Middleware Administrators Guide for Oracle Identity Federation On Windows The syntax to set up the environment on Windows systems is: set DOMAIN_HOME=PATH_TO_DOMAIN_HOME ORACLE_HOMEfedscriptssetOIFEnv.cmd

9.1.2 Executing the Commands

Execute the following command to enter the WLST script environment for Oracle Identity Federation: java weblogic.WLST To execute a command, use the format: command-nameparam1,param2,... For example: deleteUserFederations[user1,user2]

9.2 Oracle Identity Federation Commands

Use the WLST commands listed in Table 9–1 to view and manage the configuration for Oracle Identity Federation. Note: when prompted for the connect URL, enter the managed server port, not the administration server port. Table 9–1 WLST Commands for Oracle Identity Federation Use this command... To... Use with WLST... addConfigListEntryInMap Add a configuration list entry to a map. Online addConfigMapEntryInMap Add a configuration map entry to a map. Online addConfigPropertyListEntry Add a configuration property list entry. Online addConfigPropertyMapEntry Add a configuration property map entry. Online addCustomAuthnEngine Add a custom authentication engine. Online addCustomSPEngine Add a custom SP engine. Online addFederationListEntryInMap Add a list entry to a map for a specific remote providers configuration. Online addFederationMapEntryInMap Add a map entry to a map for a specific remote providers configuration. Online addFederationPropertyListEntry Add a property list entry for a specific remote providers configuration. Online addFederationPropertyMapEntry Add a map entry for a specific remote providers configuration. Online deleteCustomAuthnEngine Delete a custom authentication engine. Online deleteCustomSPEngine Delete a custom SP engine. Online deleteProviderFederation Delete the federated identities for a specific provider. Online Oracle Identity Federation Command-Line Tools 9-3 deleteUserFederations Delete the federated identities for a specific user. Online changeMessageStore Change the message store to memory or RDBMS. Online changePeerProviderDescription Change a peer provider’s description. Online changeSessionStore Change the session store to memory or RDBMS. Online createConfigPropertyList Create a configuration property list. Online createConfigPropertyListInMap Create a configuration property list in the map. Online createConfigPropertyMap Create a configuration property map. Online createConfigPropertyMapInMap Create a nested configuration property map in a map. Online createFederationPropertyList Create a property list for a specific remote providers configuration. Online createFederationPropertyListInMap Create a property list in a map for a specific remote providers configuration. Online createFederationPropertyMap Create a property map for a specific remote providers configuration. Online createFederationPropertyMapInMap Create a nested property map in a map for a specific remote providers configuration. Online createPeerProviderEntry Create a peer provider entry. Online getConfigListValueInMap Retrieve a configuration list value from a map. Online getConfigMapEntryInMap Retrieve a configuration map value from a map. Online getConfigProperty Retrieve a configuration property entry. Online getConfigPropertyList Retrieve a configuration property list. Online getConfigPropertyMapEntry Retrieve a configuration property map entry. Online getFederationListValueInMap Retrieve a property list value from a map for a specific remote providers configuration. Online getFederationMapEntryInMap Retrieve a property map value from a map for a specific remote providers configuration. Online getFederationProperty Retrieve a property value for a specific remote providers configuration. Online getFederationPropertyList Retrieve a property list for a specific remote providers configuration. Online extractproviderprops Export all provider configuration properties to a text file. Script setproviderprops Set a provider’s properties based on an input text file. Script Table 9–1 Cont. WLST Commands for Oracle Identity Federation Use this command... To... Use with WLST...