Skip Headers
Oracle® Fusion Middleware Administrator's Guide for Oracle Identity Federation
11g Release 1 (11.1.1)

Part Number E13400-06
Go to Documentation Home
Home
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

9 Oracle Identity Federation Command-Line Tools

This chapter describes the command-line tools available for Oracle Identity Federation.

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.

See Also:

Oracle Fusion Middleware WebLogic Scripting Tool Command Reference for detailed background and explanation of the WLST utility.

The WLST command-line utility provides a complete range of tools to manage Oracle Identity Federation, including commands for:

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_HOME/fed/scripts/setOIFEnv.sh 
(replace $ORACLE_HOME with the correct path for your environment.)

On Windows

The syntax to set up the environment on Windows systems is:

set DOMAIN_HOME=PATH_TO_DOMAIN_HOME
 
%ORACLE_HOME%/fed/scripts/setOIFEnv.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-name('param1','param2',...)

For example:

deleteUserFederations(['user1','user2'])

Note:

when prompted for the connect() URL, enter the managed server port, not the administration server port.

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.

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 provider's configuration.

Online

addFederationMapEntryInMap

Add a map entry to a map for a specific remote provider's configuration.

Online

addFederationPropertyListEntry

Add a property list entry for a specific remote provider's configuration.

Online

addFederationPropertyMapEntry

Add a map entry for a specific remote provider's 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

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 provider's configuration.

Online

createFederationPropertyListInMap

Create a property list in a map for a specific remote provider's configuration.

Online

createFederationPropertyMap

Create a property map for a specific remote provider's configuration.

Online

createFederationPropertyMapInMap

Create a nested property map in a map for a specific remote provider's 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 provider's configuration.

Online

getFederationMapEntryInMap

Retrieve a property map value from a map for a specific remote provider's configuration.

Online

getFederationProperty

Retrieve a property value for a specific remote provider's configuration.

Online

getFederationPropertyList

Retrieve a property list for a specific remote provider's 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

getFederationPropertyMapEntry

Retrieve a property map entry for a specific remote provider's configuration.

Online

listCustomAuthnEngines

Display the list of custom authentication engines.

Online

listCustomSPEngines

Display the list of custom SP engines.

Online

loadMetadata

Load metadata from a file.

Online

oifStatus

Display the status of an Oracle Identity Federation server.

Online

removeConfigListInMap

Delete a configuration list in a map.

Online

removeConfigMapEntryInMap

Delete a configuration map entry in a map.

Online

removeConfigMapInMap

Delete a nested configuration map.

Online

removeConfigProperty

Delete a configuration property.

Online

removeConfigPropertyList

Delete a property list.

Online

removeConfigPropertyMap

Delete a property map.

Online

removeConfigPropertyMapEntry

Delete an entry in the property map.

Online

removeFederationListInMap

Delete a list from a map for a specific remote provider's configuration.

Online

removeFederationMapInMap

Delete a nested map from a map for a specific remote provider's configuration.

Online

removeFederationMapEntryInMap

Delete a nested map property entry from a map for a specific remote provider's configuration.

Online

removeFederationProperty

Delete a property for a specific remote provider's configuration.

Online

removeFederationPropertyList

Delete a property list for a specific remote provider's configuration.

Online

removeFederationPropertyMap

Delete a property map.

Online

removeFederationPropertyMapEntry

Delete a property from a map for a specific remote provider's configuration.

Online

removePeerProviderEntry

Delete a peer provider entry.

Online

setConfigProperty

Set a configuration property.

Online

setCustomAuthnEngine

Define a custom authentication engine.

Online

setCustomSPEngine

Define a custom SP engine.

Online

setFederationProperty

Set a property for a specific remote provider's configuration.

Online


For more information, see the Oracle Fusion Middleware Administrator's Guide for Oracle Identity Federation.

9.2.1 addConfigListEntryInMap

Online command that adds a property value to a nested list inside a map.

9.2.1.1 Description

This command adds a property value to a nested list inside a map in config.xml.

9.2.1.2 Syntax

addConfigListEntryInMap('configName', 'mapname', 'listName', 'value', 'type')
Argument Definition

configname

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

mapname

Specifies the name of the property to map to be changed in config.xml.

listname

Specifies the name of the list.

value

Specifies the property value.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.1.3 Example

The following command adds valueA to a map list in server configuration:

wls:/mydomain/serverConfig> addConfigListEntryInMap('serverconfig','mymap','mylistA','valueA','string')

9.2.2 addConfigMapEntryInMap

Online command that adds a nested map property entry in a map.

9.2.2.1 Description

This command that adds a property name/value pair to a map nested inside a map in config.xml.

9.2.2.2 Syntax

addConfigMapEntryInMap('configName', 'mapname', 'nestedMapName', 'propName', 'value', 'type')
Argument Definition

configname

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

mapname

Specifies the name of the property map to be changed in config.xml.

nestedmapname

name of the nested property map to be changed.

propname

Specifies the name of the list.

value

Specifies the property value.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.2.3 Example

The following command adds a boolean name/value pair to nestedmapB inside the map mymap.

wls:/mydomain/serverConfig> addConfigMapEntryInMap('serverconfig','mymap','nestedmapB','myvarB','true',

'boolean')

9.2.3 addConfigPropertyListEntry

Online command that adds a list property entry to config.xml.

9.2.3.1 Description

This command adds a property value to a list in config.xml.

9.2.3.2 Syntax

addConfigPropertyListEntry('configName', 'listName', 'value', 'type')
Argument Definition

configname

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

listname

Specifies the name of the property list to be updated in config.xml.

value

Specifies the new property list value. The entered value is appended to the list.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.3.3 Example

The following command adds a string value to mylistA.

wls:/mydomain/serverConfig> addConfigPropertyListEntry('serverconfig','mylistA','valueA','string')

9.2.4 addConfigPropertyMapEntry

Online command that adds a property name/value entry in a map in config.xml.

9.2.4.1 Description

This command adds a property name/value entry in a map in config.xml.

9.2.4.2 Syntax

addConfigPropertyMapEntry('configName', 'mapName', 'propName','value', 'type')
Argument Definition

configname

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

mapname

Specifies the name of the property map in config.xml.

propname

Specifies the name of the property map.

value

Specifies the property map value to be added.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.4.3 Example

The following command adds valueA of string type to a map.

wls:/mydomain/serverConfig> addConfigPropertyMapEntry('serverconfig','mymapA','myvarA','valueA','string')

9.2.5 addCustomAuthnEngine

Online command that adds a custom authentication integration engine.

9.2.5.1 Description

This command adds a custom authentication integration engine to config.xml.

9.2.5.2 Syntax

addCustomAuthnEngine('name' 'enabled' 'webContext' 'authnRelativePath' 'logoutRelativePath' 'logoutEnabled')
Argument Definition

name

Specifies the name of the custom engine.

enabled

This flag specifies whether the engine is enabled (true) or not (false).

webContext

Specifies the web context for the engine.

authnRelativePath

Specifies the authentication relative path URL for the engine.

logoutRelativePath

Specifies the logout relative path URL for the engine.

logoutEnabled

This flag is set true to enable logout for the engine, else false.


9.2.5.3 Example

The following command defines an engine named test and enables it.

wls:/mydomain/serverConfig> addCustomAuthnEngine('test','true')

9.2.6 addCustomSPEngine

Online command that adds a custom service provider (SP) engine.

9.2.6.1 Description

This command adds a custom SP integration engine to config.xml.

9.2.6.2 Syntax

addCustomSPEngine('name' 'enabled' 'authnMech' 'webContext' 'authnRelativePath' 'logoutRelativePath' 'logoutEnabled')
Argument Definition

name

Specifies the name of the custom engine.

enabled

This flag specifies whether the engine is enabled (true) or not (false).

authnMech

Specifies the authentication mechanism for the engine.

webContext

Specifies the web context for the engine.

authnRelativePath

Specifies the authentication relative path URL for the engine.

logoutRelativePath

Specifies the logout relative path URL for the engine.

logoutEnabled

This flag is set true to enable logout for the engine, else false.


9.2.6.3 Example

The following command adds an engine and gives it a disabled status.

addCustomSPEngine('new engine','false','oracle:fed:authentication:unspecified','webcontext')

9.2.7 addFederationListEntryInMap

Online command that adds a list property entry in a map.

9.2.7.1 Description

This command adds a property value to a nested list inside a map in cot.xml.

9.2.7.2 Syntax

addFederationListEntryInMap('providerID', 'mapname', 'listName', 'value', 'type')
Argument Definition

providerID

Specifies the provider ID.

mapname

Specifies the name of the property map to be changed in cot.xml.

listname

Specifies the name of the property list to be added to the map.

value

Specifies the property list value to be added. The entered value is appended to the list.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.7.3 Example

The following command adds a boolean property list to mymap.

wls:/mydomain/serverConfig> addFederationListEntryInMap('providerB','mymap','mylistB','true','boolean')

9.2.8 addFederationMapEntryInMap

Online command that adds a nested map property entry in a map.

9.2.8.1 Description

This command adds a property name/value pair to a map nested inside a map in cot.xml.

9.2.8.2 Syntax

addFederationMapEntryInMap('providerID', 'mapname', 'nestedMapName', 'propName', 'value', 'type')
Argument Definition

providerID

Specifies the provider ID.

mapname

Specifies the name of the property map to be changed in cot.xml.

nestedMapName

Specifies the name of the nested property map to be changed.

propName

Specifies the name of the property to be updated in the map.

value

Specifies the property value to be added. The entered value is appended to the list.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.8.3 Example

The following command adds a value of type string to the myvarA property in a nested map.

wls:/mydomain/serverConfig> addFederationMapEntryInMap('providerA','mymap','nestedmapA','myvarA','valueA',

'string')

9.2.9 addFederationPropertyListEntry

Online command that adds a list property entry.

9.2.9.1 Description

This command adds a property value to a list in cot.xml.

9.2.9.2 Syntax

addFederationPropertyListEntry('providerID', 'listName', 'value', 'type')
Argument Definition

providerID

Specifies the provider ID.

listname

Specifies the name of the property list to be updated.

value

Specifies the property list value to be added. The entered value is appended to the list.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.9.3 Example

The following command adds a value in string format to a specified property list.

wls:/mydomain/serverConfig> addFederationPropertyListEntry('providerA','mylistA','valueA','string')

9.2.10 addFederationPropertyMapEntry

Online command that a property name/value entry in a map.

9.2.10.1 Description

This command adds a property name/value pair to a map in cot.xml.

9.2.10.2 Syntax

addFederationPropertyMapEntry('providerID', 'mapName', 'propName','value', 'type')
Argument Definition

providerID

Specifies the provider ID.

mapname

Specifies the name of the property map to be changed in cot.xml.

propName

Specifies the name of the property to be added in the map.

value

Specifies the property value to be added.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.10.3 Example

The following command adds boolean property myvarB to a map.

wls:/mydomain/serverConfig> addFederationPropertyMapEntry('providerA','mymapB','myvarB','true','boolean')

9.2.11 deleteCustomAuthnEngine

Online command that deletes a custom authentication integration engine from the configuration.

9.2.11.1 Description

This command deletes a custom authentication integration engine in config.xml. You must provide the engine ID for an existing custom authentication engine in config.xml.

9.2.11.2 Syntax

deleteCustomAuthnEngine('engineID')
Argument Definition

engineID

Specifies the engine ID of an existing engine to be deleted.


9.2.11.3 Example

The following command deletes the authentication engine with ID id1234.

wls:/mydomain/serverConfig> deleteCustomAuthnEngine('id1234')

9.2.12 deleteCustomSPEngine

Online command that deletes a custom service provider (SP) integration engine from the configuration.

9.2.12.1 Description

This command deletes a custom SP integration engine in config.xml. The EngineID for an existing custom SP engine in config.xml must be provided.

9.2.12.2 Syntax

ddeleteCustomSPEngine('engineID')
Argument Definition

engineID

Specifies the engine ID of an existing engine to be deleted.


9.2.12.3 Example

The following command deletes the engine with ID id1234.

wls:/mydomain/serverConfig> deleteCustomSPEngine('id1234')

9.2.13 deleteProviderFederation

Online command that deletes federations for given provider.

9.2.13.1 Description

This command deletes federations for given provider ID.

9.2.13.2 Syntax

deleteProviderFederation('providerID')
Argument Definition

providerID

Specifies the ProviderID for the peer provider for which federation is to be deleted.


9.2.13.3 Example

The following command deletes providerA:

wls:/mydomain/serverConfig> deleteProviderFederation(providerA)

9.2.14 deleteUserFederations

Online command that deletes federations for given users.

9.2.14.1 Description

This command deletes federations for the given list of users.

9.2.14.2 Syntax

deleteUserFederations(['user1,..'])
Argument Definition

user1

Specifies a comma-separated list of users whose federations are to be deleted. At least one user must be specified.


9.2.14.3 Example

The following command deletes federations for three users:

wls:/mydomain/serverConfig> deleteUserFederations(['userA','userB','userC'])

9.2.15 changeMessageStore

Online command that changes the message store between memory and RDBMS.

9.2.15.1 Description

This command changes the message store to memory or RDBMS.

9.2.15.2 Syntax

changeMessageStore('type','jndiname')
Argument Definition

type

Specifies the type of store, RDBMS or Memory. Default is Memory.

jndiname

Specifies the jndi name to set for the store. Required if type is RDBMS.


9.2.15.3 Example

The following command changes the message store to RDBMS:

wls:/mydomain/serverConfig> changeMessageStore('RDBMS','jdbc/mydb')

9.2.16 changePeerProviderDescription

Online command that changes the peer provider description.

9.2.16.1 Description

This command updates a peer provider description in cot.xml.

9.2.16.2 Syntax

changePeerProviderDescription('providerID','description')
Argument Definition

providerID

Specifies the provider ID.

description

Specifies the provider description.


9.2.16.3 Example

The following command updates the description of a provider:

wls:/mydomain/serverConfig> changePeerProviderDescription('providerA','new description')

9.2.17 changeSessionStore

Online command that changes the session store between memory and RDBMS.

9.2.17.1 Description

This command changes the session store to memory or RDBMS.

9.2.17.2 Syntax

changeSessionStore('type','jndiname')
Argument Definition

type

Specifies the type of store, RDBMS or Memory. Default is Memory.

jndiname

Specifies the jndi name to set for the store. Required if type is RDBMS.


9.2.17.3 Example

The following command changes the session store to RDBMS.

wls:/mydomain/serverConfig> changeSessionStore('RDBMS','jdbc/mydb')

9.2.18 createConfigPropertyList

Online command that creates a property list.

9.2.18.1 Description

This command creates a property list in config.xml.

9.2.18.2 Syntax

createConfigPropertyList('configName', 'listName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

listName

Specifies the property list name.


9.2.18.3 Example

The following command creates property list mylistA.

wls:/mydomain/serverConfig> createConfigPropertyList('serverconfig','mylistA')

9.2.19 createConfigPropertyListInMap

Online command that creates a property list nested in the property map.

9.2.19.1 Description

This command creates a property list, nested in the property map, in config.xml.

9.2.19.2 Syntax

createConfigPropertyListInMap('configName', 'mapName', 'listName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

mapName

Specifies an existing property map to contain the nested list.

listName

Specifies the property list name.


9.2.19.3 Example

The following command creates property list mylistA nested in a property map.

wls:/mydomain/serverConfig> createConfigPropertyListInMap('serverconfig','mymapA','mylistA')

9.2.20 createConfigPropertyMap

Online command that creates a property map.

9.2.20.1 Description

This command that creates a property map in config.xml.

9.2.20.2 Syntax

createConfigPropertyMap('configName', 'mapName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

mapName

Specifies the property map to create.


9.2.20.3 Example

The following command creates property map mymapA:

wls:/mydomain/serverConfig> createConfigPropertyMap('serverconfig','mymapA')

9.2.21 createConfigPropertyMapInMap

Online command that creates a property map.

9.2.21.1 Description

This command that creates a property map in config.xml.

9.2.21.2 Syntax

ccreateConfigPropertyMapInMap('serverconfig','mymapA','nestedmapA')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

mapName

Specifies the name of an existing property map.

nestedMapName

Specifies the name of the property map to create nested inside mapName.


9.2.21.3 Example

The following command creates nested property map nestedmymapA:

wls:/mydomain/serverConfig> createConfigPropertyMapInMap('serverconfig','mymapA','nestedmapA')

9.2.22 createFederationPropertyList

Online command that creates a property list.

9.2.22.1 Description

This command creates a property list in cot.xml.

9.2.22.2 Syntax


Argument Definition

providerID

Specifies the provider ID.

listName

Specifies the name of the property list.


9.2.22.3 Example

The following command creates property list mylistA:

wls:/mydomain/serverConfig> createFederationPropertyList('providerA','mylistA')

9.2.23 createFederationPropertyListInMap

Online command that creates a property list nested in a property map.

9.2.23.1 Description

This command creates a property list, nested in a property map, in cot.xml.

9.2.23.2 Syntax

createFederationPropertyListInMap('providerID', 'mapName', 'listName')
Argument Definition

providerID

Specifies the provider ID.

mapName

Specifies an existing property map to contain the nested list.

listName

Specifies the name of the property list.


9.2.23.3 Example

The following command creates nested property list mylistA:

wls:/mydomain/serverConfig> createFederationPropertyListInMap('providerA','mymapA','mylistA')

9.2.24 createFederationPropertyMap

Online command that creates a property map.

9.2.24.1 Description

This command that creates a property map in cot.xml.

9.2.24.2 Syntax

createFederationPropertyMap('providerID', 'mapName')
Argument Definition

providerID

Specifies the provider ID.

mapName

Specifies the name of the property map to be added to cot.xml.


9.2.24.3 Example

The following command creates property map mymapA:

wls:/mydomain/serverConfig> createFederationPropertyMap('providerA','mymapA')

9.2.25 createFederationPropertyMapInMap

Online command that creates a nested property map.

9.2.25.1 Description

This command creates a property map, nested in another property map, in cot.xml.

9.2.25.2 Syntax

createFederationPropertyMapInMap('providerID', 'mapName', 'nestedMapName')
Argument Definition

providerID

Specifies the provider ID.

mapName

Specifies the name of an existing property map.

nestedMapName

Specifies the name of the property map to be nested inside mapName in cot.xml.


9.2.25.3 Example

The following command creates nested property map nestedmapA:

wls:/mydomain/serverConfig> createFederationPropertyMapInMap('providerA','mymapA','nestedmapA')

9.2.26 createPeerProviderEntry

Online command that creates a peer provider property map entry.

9.2.26.1 Description

This command creates a peer provider as a Map property entry to cot.xml.

9.2.26.2 Syntax

createPeerProviderEntry('providerID', 'description', 'providerType','version')
Argument Definition

providerID

Specifies the provider ID to be created.

description

This is the description of the provider ID.

providerType

Specifies the provider type of the peer provider to be created.

version

Specifies the version of the peer provider to be created.


9.2.26.3 Example

The following command creates a SAML 2.0 service provider:

wls:/mydomain/serverConfig> createPeerProviderEntry('providerA','idp test','SP','SAML2.0')

9.2.27 getConfigListValueInMap

Online command that returns a list nested in a map.

9.2.27.1 Description

This command returns a list, nested in a map, from config.xml.

9.2.27.2 Syntax

getConfigListValueInMap('configName', 'mapName', 'listName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be accessed.

mapName

Specifies the name of the property map.

listName

Specifies the name of the list to be fetched from the map.


9.2.27.3 Example

The following command returns mylistA:

wls:/mydomain/serverConfig> getConfigListValueInMap('serverConfig','mymapA','mylistA'

9.2.28 getConfigMapEntryInMap

Online command that returns a map property entry nested in a map.

9.2.28.1 Description

This command returns a map property entry, nested in a map, from config.xml.

9.2.28.2 Syntax

getConfigMapEntryInMap('configName', 'mapname', 'nestedMapName', 'propName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be accessed.

mapName

Specifies the name of the property map.

nestedmapName

Specifies the name of the nested property map.

propName

Specifies the name of the property to be fetched from the nested map.


9.2.28.3 Example

The following command returns property entry myvarA:

wls:/mydomain/serverConfig> getConfigMapEntryInMap('serverconfig','mymap','nestedmapA','myvarA')

9.2.29 getConfigProperty

Online command that returns a property value.

9.2.29.1 Description

This command returns a property value from config.xml.

9.2.29.2 Syntax

getConfigProperty('configName', 'propName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be accessed.

propName

Specifies the name of the property to be fetched from the nested map.


9.2.29.3 Example

The following command returns property myvarA:

wls:/mydomain/serverConfig> getConfigProperty('serverconfig','myvarA')

9.2.30 getConfigPropertyList

Online command that returns a property list.

9.2.30.1 Description

This command returns a property list from config.xml.

9.2.30.2 Syntax

getConfigPropertyList('configName', 'listName')
Argument Definition

configName

Specifies the configuration name.

listName

Specifies the name of the property list to be fetched from config.xml.


9.2.30.3 Example

The following command returns mylistA:

wls:/mydomain/serverConfig> getConfigPropertyList('serverconfig','mylistA')

9.2.31 getConfigPropertyMapEntry

Online command that returns a property value from a map.

9.2.31.1 Description

This command returns a property value from a map in config.xml.

9.2.31.2 Syntax

getConfigPropertyMapEntry('configName', 'mapName', 'propName')
Argument Definition

configName

Specifies the configuration name (for example, idpsaml20, serverconfig, spsaml20,..).

mapName

Specifies the name of the property map.

propName

Specifies the name of the property to be fetched from the map in config.xml.


9.2.31.3 Example

The following command returns property propA:

wls:/mydomain/serverConfig> getConfigPropertyMapEntry('serverconfig','mapA', 'propA')

9.2.32 getFederationListValueInMap

Online command that returns a list value nested in a map.

9.2.32.1 Description

This command returns a list value nested in a map from cot.xml.

9.2.32.2 Syntax

getFederationListValueInMap('providerID', 'mapName', 'listName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

mapName

Specifies the name of the property map.

listName

Specifies the name of the list to be fetched from the map.


9.2.32.3 Example

The following command returns nested list mylistA:

wls:/mydomain/serverConfig> getFederationListValueInMap('providerA','mymapA','mylistA')

9.2.33 getFederationMapEntryInMap

Online command that returns a map property entry nested in a map.

9.2.33.1 Description

This command returns a map property entry, nested in a map, from cot.xml.

9.2.33.2 Syntax

getFederationMapEntryInMap('providerID', 'mapname', 'nestedMapName', 'propName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

mapName

Specifies the name of the property map.

nestedmapName

Specifies the name of the nested property map.

propName

Specifies the name of the property to be fetched from the nested map.


9.2.33.3 Example

The following command returns property entry myvarA:

wls:/mydomain/serverConfig> getFederationMapEntryInMap('providerA','mymap','nestedmapA','myvarA')

9.2.34 getFederationProperty

Online command that returns a property value.

9.2.34.1 Description

This command returns a property value from cot.xml.

9.2.34.2 Syntax

getFederationProperty('providerID', 'propName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

propName

Specifies the name of the property to be fetched from cot.xml.


9.2.34.3 Example

The following command returns property myvarA:

wls:/mydomain/serverConfig> getFederationProperty('providerA','myvarA')

9.2.35 getFederationPropertyList

Online command that returns a property list.

9.2.35.1 Description

This command returns a property list from cot.xml.

9.2.35.2 Syntax

getFederationPropertyList('providerID', 'listName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

listName

Specifies the name of the list to be fetched from the map.


9.2.35.3 Example

The following command returns list mylistA:

wls:/mydomain/serverConfig> getFederationPropertyList('providerA','mylistA')

9.2.36 extractproviderprops

Script command to export properties of a provider.

Note:

This is a script command and cannot be executed directly from the online WLST prompt. Oracle Identity Federation scripts are located in $ORACLE_HOME/fed/scripts.

9.2.36.1 Description

Script command that extracts all the configuration properties of the specified provider and exports them to a text file. You can later use this file to set the same properties on another provider.

9.2.36.2 Syntax

java weblogic.WLST extractproviderprops.py providerID filename 
Argument Definition

providerID

Specifies the name of the provider whose properties are to be extracted.

filename

Specifies the name of the text file to which the provider properties are extracted.


When you execute the script, you are prompted for the WebLogic administrator credentials and the connection URL; for the latter, specify the managed server port, not the admin server port.

File Format

The format of the extract file is:

TYPE:NAME:PROPNAME:PROPVALUE:PROPTYPE

For example:

X:X:sendattribute:false:boolean
MAP:attributelist/mailemail:datastore-attr:mail:string
LIST:sendattributefornameid:unspecified::string

9.2.37 setproviderprops

Script command to set properties of a provider using values from a text file.

Note:

This is a script command and cannot be executed directly from the online WLST prompt. Oracle Identity Federation scripts are located in $ORACLE_HOME/fed/scripts.

9.2.37.1 Description

Script command to set properties of a provider using values from a text file.

The text file is generated by the "extractproviderprops" command.

9.2.37.2 Syntax

java weblogic.WLST setproviderprops.py providerID filename 
Argument Definition

providerID

Specifies the name of the provider whose properties are to be updated.

filename

Specifies the name of the input file from which to read the properties.


When you execute the script, you are prompted for the WebLogic administrator credentials and the connection URL; for the latter, specify the managed server port, not the admin server port.

9.2.38 getFederationPropertyMapEntry

Online command that returns a property value from a map.

9.2.38.1 Description

This command returns a property value from a map in cot.xml.

9.2.38.2 Syntax

getFederationPropertyMapEntry('providerID', 'mapName', 'propName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

mapName

Specifies the name of the property map.

propName

Specifies the name of the property to be fetched from the nested map.


9.2.38.3 Example

The following command returns property propA from a map:

wls:/mydomain/serverConfig> getFederationPropertyMapEntry('providerA','mapA', 'propA')

9.2.39 listCustomAuthnEngines

Online command that returns a list of custom authentication integration engines.

9.2.39.1 Description

This command returns a list of custom authentication integration engines from config.xml.

9.2.39.2 Syntax

listCustomAuthnEngines()

9.2.39.3 Example

The following command returns the list of all SP engines:

wls:/mydomain/serverConfig> listCustomAuthnEngines()

9.2.40 listCustomSPEngines

Online command that returns a list of custom SP integration engines.

9.2.40.1 Description

This command returns a list of custom service provider (SP) integration engines from config.xml.

9.2.40.2 Syntax

listCustomSPEngines()

9.2.40.3 Example

The following command returns the list of all SP integration engines:

wls:/mydomain/serverConfig> listCustomSPEngines()

9.2.41 loadMetadata

Online command that loads metadata from an input file.

9.2.41.1 Description

This command loads metadata from an input file into cot.xml.

9.2.41.2 Syntax

loadMetadata('metadatafile','description')
Argument Definition

metadatafile

Specifies the metadata file of the peer provider to be added or updated.

description

This is a brief description of the peer provider to be loaded.


9.2.41.3 Example

The following command loads metadata from the file metadatafile.xml:

wls:/mydomain/serverConfig> loadMetadata('/home/metadatafile.xml','some description')

9.2.42 oifStatus

Online command that reports the current status of the Oracle Identity Federation application in the managed server to which WLST is connected.

9.2.42.1 Description

This command displays the current status of Oracle Identity Federation on the managed server.

9.2.42.2 Syntax

oifStatus('serverurl', 'configfile', 'keyfile')
Argument Definition

serverurl

Specifies the URL of the managed server.

configfile

This is a pre-defined user configuration file created with the WLST storeUserConfig command.

keyfile

This is a pre-defined key file created with the WLST storeUserConfig command


9.2.42.3 Example

The following command provides no arguments; WLST prompts you for the Oracle WebLogic Server username, password, and the managed server URL, then displays the federation server status:

wls:/mydomain/serverConfig> oifStatus()

The following command provides only the managed server URL; WLST prompts you for the Oracle WebLogic Server username and password:

wls:/mydomain/serverConfig> oifStatus('', '', 't3://localhost:7499')

The following command provides all arguments needed for WLST to display the federation server status:

wls:/mydomain/serverConfig> oifStatus('configfileA', 'keyfileB', 't3://localhost:7499')

9.2.43 removeConfigListInMap

Online command that removes a list property nested in a map.

9.2.43.1 Description

This command removes a list property nested in a map from config.xml.

9.2.43.2 Syntax

removeConfigListInMap('configName', 'mapName', 'listName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be accessed.

mapName

Specifies the name of the property map.

listName

Specifies the name of the list to be removed from the map.


9.2.43.3 Example

The following command removes the list property mylistA:

wls:/mydomain/serverConfig> removeConfigListInMap('serverConfig','mymapA','mylistA')

9.2.44 removeConfigMapEntryInMap

Online command that removes a map property nested in a map.

9.2.44.1 Description

This command removes a map property entry nested in a map from config.xml.

9.2.44.2 Syntax

oifStatus('serverurl', 'configfile', 'keyfile')
Argument Definition

serverurl

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be accessed.

configfile

Specifies the name of the property map.

keyfile

Specifies the name of the nested property map.


9.2.44.3 Example

The following command removes the nested property myvarA:

wls:/mydomain/serverConfig> removeConfigMapEntryInMap('serverconfig','mymap','nestedmapA','myvarA')

9.2.45 removeConfigMapInMap

Online command that removes a map property nested in a map.

9.2.45.1 Description

This command removes a map property entry nested in a map from config.xml.

9.2.45.2 Syntax

removeConfigMapEntryInMap('configName', 'mapname', 'nestedMapName', 'propName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

mapName

Specifies the name of the property map.

nestedmapName

Specifies the name of the nested property map.

propName

Specifies the name of the property to be removed from the nested map.


9.2.45.3 Example

The following command removes the nested property myvarA:

wls:/mydomain/serverConfig> removeConfigMapEntryInMap('serverconfig','mymap','nestedmapA','myvarA')

9.2.46 removeConfigProperty

Online command that removes a configuration property.

9.2.46.1 Description

This command removes a property from config.xml.

9.2.46.2 Syntax

removeConfigProperty('configName', 'propName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

propName

Specifies the name of the property to be removed.


9.2.46.3 Example

The following command removes the property myvarA:

wls:/mydomain/serverConfig> removeConfigProperty('serverconfig','myvarA')

9.2.47 removeConfigPropertyList

Online command that removes a configuration property list.

9.2.47.1 Description

This command removes a property list from config.xml.

9.2.47.2 Syntax

removeConfigPropertyList('configName', 'listName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

listName

Specifies the name of the property list to be removed.


9.2.47.3 Example

The following command removes the property list mylistA:

wls:/mydomain/serverConfig> removeConfigPropertyList('serverconfig','mylistA')

9.2.48 removeConfigPropertyMap

Online command that removes a property map.

9.2.48.1 Description

This command removes a property map in config.xml.

9.2.48.2 Syntax

removeConfigPropertyMap('configName', 'mapName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

mapName

Specifies the name of the property map to be removed.


9.2.48.3 Example

The following command removes mapA:

wls:/mydomain/serverConfig> removeConfigPropertyMap('serverconfig','mapA')

9.2.49 removeConfigPropertyMapEntry

Online command that removes a property value from a map.

9.2.49.1 Description

This command removes a property value from a map in config.xml.

9.2.49.2 Syntax

removeConfigPropertyMapEntry('configName', 'mapName', 'propName')
Argument Definition

configName

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

mapName

Specifies the name of the property map to be updated.

propName

Specifies the name of the property to be removed from the map.


9.2.49.3 Example

The following command removes property propA:

wls:/mydomain/serverConfig> removeConfigPropertyMapEntry('serverconfig','mapA', 'propA')

9.2.50 removeFederationListInMap

Online command that removes a property list in a map.

9.2.50.1 Description

This command removes a property list in a map, in cot.xml.

9.2.50.2 Syntax

removeFederationListInMap('providerID', 'mapName', 'listName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

mapName

Specifies the name of the property map.

listName

Specifies the name of the property list to be removed.


9.2.50.3 Example

The following command removes mylistA in mymapA:

wls:/mydomain/serverConfig> removeFederationListInMap('providerA','mymapA','mylistA')

9.2.51 removeFederationMapInMap

Online command that removes a nested map in a map.

9.2.51.1 Description

This command removes a property map nested inside a map in cot.xml.

9.2.51.2 Syntax

removeFederationMapInMap('providerID', 'mapname', 'nestedMapName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

mapName

Specifies the name of the property map containing the nested map.

nestedmapName

Specifies the name of the nested property map to be removed.


9.2.51.3 Example

The following command removes nestedmapA in mymap:

wls:/mydomain/serverConfig> removeFederationMapInMap('providerA','mymap','nestedmapA')

9.2.52 removeFederationMapEntryInMap

Online command that removes a nested map property entry in a map.

9.2.52.1 Description

This command removes a property name/value pair to a map nested inside a map in cot.xml.

9.2.52.2 Syntax

removeFederationMapEntryInMap('providerID', 'mapname', 'nestedMapName', 'propName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

mapName

Specifies the name of the property map containing the nested map.

nestedmapName

Specifies the name of the nested property map.

propName

Specifies the name of the property to be removed from the nested map.


9.2.52.3 Example

The following command removes map property entry myvarA:

wls:/mydomain/serverConfig> removeFederationMapEntryInMap('providerA','mymap','nestedmapA','myvarA')

9.2.53 removeFederationProperty

Online command that removes a property value.

9.2.53.1 Description

This command removes a property entry in cot.xml.

9.2.53.2 Syntax

removeFederationProperty('providerID', 'propName')
Argument Definition

providerID

Specifies the name of the peer provider to be updated.

propName

Specifies the name of the property to be removed.


9.2.53.3 Example

The following command removes the provider property myvarA:

wls:/mydomain/serverConfig> removeFederationProperty('providerA','myvarA')

9.2.54 removeFederationPropertyList

Online command that removes a property list entry.

9.2.54.1 Description

This command removes a property list entry in cot.xml.

9.2.54.2 Syntax

removeFederationPropertyList('providerID', 'listName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

listName

Specifies the name of the property list to be removed.


9.2.54.3 Example

The following command removes mylistA:

wls:/mydomain/serverConfig> removeFederationPropertyList('providerA','mylistA')

9.2.55 removeFederationPropertyMap

Online command that removes a property map.

9.2.55.1 Description

This command removes a property map in cot.xml.

9.2.55.2 Syntax

removeFederationPropertyMap('providerID', 'mapName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

mapName

Specifies the name of the property map to be removed.


9.2.55.3 Example

The following command removes a map:

wls:/mydomain/serverConfig> removeFederationPropertyMap('providerA','mapA')

9.2.56 removeFederationPropertyMapEntry

Online command that removes a property value from a map.

9.2.56.1 Description

This command removes a property value from a map in cot.xml.

9.2.56.2 Syntax

removeFederationPropertyMapEntry('providerID', 'mapName', 'propName')
Argument Definition

providerID

Specifies the name of the peer provider to be accessed.

mapName

Specifies the name of the property map to be updated.

propName

Specifies the name of the property to be removed from the map.


9.2.56.3 Example

The following command removes property propA from a map:

wls:/mydomain/serverConfig> removeFederationPropertyMapEntry('providerA','mapA', 'propA')

9.2.57 removePeerProviderEntry

Online command that removes a peer provider entry.

9.2.57.1 Description

This command removes a peer provider entry from cot.xml.

9.2.57.2 Syntax

removePeerProviderEntry('providerID')
Argument Definition

providerID

Specifies the name of the peer provider to be removed.


9.2.57.3 Example

The following command removes providerA:

wls:/mydomain/serverConfig> removePeerProviderEntry('providerA')

9.2.58 setConfigProperty

Online command that sets a property value in config.xml.

9.2.58.1 Description

This command adds or updates a property value in config.xml.

9.2.58.2 Syntax

setConfigProperty('configname', 'propName', 'value', 'type')
Argument Definition

configname

Specifies the name of the configuration (for example, idpsaml20, serverconfig, spsaml20,..) to be updated.

propname

Specifies the name of the property to be added/updated in config.xml.

value

Specifies the property value.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.58.3 Example

The following command sets the property myvarA and its value in the server configuration:

wls:/mydomain/serverConfig> setConfigProperty('serverconfig','myvarA','myvalA','string')

9.2.59 setCustomAuthnEngine

Online command that updates a custom authentication integration engine.

9.2.59.1 Description

This command updates a custom authentication integration engine in config.xml.

9.2.59.2 Syntax

setCustomAuthnEngine('engineID', 'name', 'enabled', 'webContext', 'authnRelativePath', 'logoutRelativePath', 'logoutEnabled')
Argument Definition

engineID

Specifies the engine ID of an existing engine.

name

Specifies the name of the custom engine.

enabled

This flag specifies whether the engine is enabled (true) or not (false).

webContext

Specifies the web context for the engine.

authnRelativePath

Specifies the authentication relative path URL for the engine.

logoutRelativePath

Specifies the logout relative path URL for the engine.

logoutEnabled

This flag is set true to enable logout for the engine, else false.


9.2.59.3 Example

The following command updates the configuration of custom authentication engine abcdef:

wls:/mydomain/serverConfig> setCustomAuthnEngine('abcdef',
'custom one','false','oracle:fed:authentication:unspecified','webcontext')

9.2.60 setCustomSPEngine

Online command that updates a custom SP integration engine.

9.2.60.1 Description

This command updates an existing custom SP integration engine in config.xml.

9.2.60.2 Syntax

setCustomSPEngine('engineID' ,'name', 'enabled', 'authnMech', 'webContext', 'authnRelativePath', 'logoutRelativePath', 'logoutEnabled')
Argument Definition

engineID

Specifies the engine ID of an existing custom engine.

name

Specifies the name of the custom engine.

enabled

This flag specifies whether the engine is enabled (true) or not (false).

authnMech

Specifies the authentication mechanism for the engine.

webContext

Specifies the web context for the engine.

authnRelativePath

Specifies the authentication relative path URL for the engine.

logoutRelativePath

Specifies the logout relative path URL for the engine.

logoutEnabled

This flag is set true to enable logout for the engine, else false.


9.2.60.3 Example

The following command sets the name and the enabled flag for the engine with ID engineID2:

wls:/mydomain/serverConfig> setCustomSPEngine('engineid2','test','true')

9.2.61 setFederationProperty

Online command that adds or updates a property value.

9.2.61.1 Description

This command adds a property entry or updates an existing entry in cot.xml.

9.2.61.2 Syntax

setFederationProperty('providerID', 'propName', 'value', 'type')
Argument Definition

providerID

Specifies the name of the peer provider to be updated.

propname

Specifies the name of the property to be added/updated in cot.xml.

value

Specifies the property value.

type

Specifies the type of property, BOOLEAN or STRING or LONG.


9.2.61.3 Example

The following command creates the property myvarA and sets its value:

wls:/mydomain/serverConfig> setFederationProperty('providerA','myvarA','myvalA','string')