Oracle® Fusion Middleware Administrator's Guide for Oracle Identity Federation 11g Release 1 (11.1.1) Part Number E13400-01 |
|
|
View PDF |
This chapter describes the command-line tools available for Oracle Identity Federation.
WLST
is the command-line utility for administration of 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:
Property Management
Federation Management
Custom SP and Authentication Engine Management
Message Store Maintenance
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
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.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... |
---|---|---|
Add a configuration list entry to a map. |
Online |
|
Add a configuration map entry to a map. |
Online |
|
Add a configuration property list entry. |
Online |
|
Add a configuration property map entry. |
Online |
|
Add a custom authentication engine. |
Online |
|
Add a custom SP engine. |
Online |
|
Add a list entry to a map for a specific remote provider's configuration. |
Online |
|
Add a map entry to a map for a specific remote provider's configuration. |
Online |
|
Add a property list entry for a specific remote provider's configuration. |
Online |
|
Add a map entry for a specific remote provider's configuration. |
Online |
|
Delete a custom authentication engine. |
Online |
|
Delete a custom SP engine. |
Online |
|
Delete the federated identities for a specific provider. |
Online |
|
Delete the federated identities for a specific user. |
Online |
|
Change the message store to memory or RDBMS. |
Online |
|
Change a peer provider's description. |
Online |
|
Change the session store to memory or RDBMS. |
Online |
|
Create a configuration property list. |
Online |
|
Create a configuration property list in the map. |
Online |
|
Create a configuration property map. |
Online |
|
Create a nested configuration property map in a map. |
Online |
|
Create a property list for a specific remote provider's configuration. |
Online |
|
Create a property list in a map for a specific remote provider's configuration. |
Online |
|
Create a property map for a specific remote provider's configuration. |
Online |
|
Create a nested property map in a map for a specific remote provider's configuration. |
Online |
|
Create a peer provider entry. |
Online |
|
Retrieve a configuration list value from a map. |
Online |
|
Retrieve a configuration map value from a map. |
Online |
|
Retrieve a configuration property entry. |
Online |
|
Retrieve a configuration property list. |
Online |
|
Retrieve a configuration property map entry. |
Online |
|
Retrieve a property list value from a map for a specific remote provider's configuration. |
Online |
|
Retrieve a property map value from a map for a specific remote provider's configuration. |
Online |
|
Retrieve a property value for a specific remote provider's configuration. |
Online |
|
Retrieve a property list for a specific remote provider's configuration. |
Online |
|
Retrieve a property map entry for a specific remote provider's configuration. |
Online |
|
Display the list of custom authentication engines. |
Online |
|
Display the list of custom SP engines. |
Online |
|
Load metadata from a file. |
Online |
|
Delete a configuration list in a map. |
Online |
|
Delete a configuration map entry in a map. |
Online |
|
Delete a nested configuration map. |
Online |
|
Delete a configuration property. |
Online |
|
Delete a property list. |
Online |
|
Delete a property map. |
Online |
|
Delete an entry in the property map. |
Online |
|
Delete a list from a map for a specific remote provider's configuration. |
Online |
|
Delete a nested map from a map for a specific remote provider's configuration. |
Online |
|
Delete a nested map property entry from a map for a specific remote provider's configuration. |
Online |
|
Delete a property for a specific remote provider's configuration. |
Online |
|
Delete a property list for a specific remote provider's configuration. |
Online |
|
Delete a property map. |
Online |
|
Delete a property from a map for a specific remote provider's configuration. |
Online |
|
Delete a peer provider entry. |
Online |
|
Set a configuration property. |
Online |
|
Define a custom authentication engine. |
Online |
|
Define a custom SP engine. |
Online |
|
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.
Online command that adds a property value to a nested list inside a map.
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. |
Online command that adds a nested map property entry in a map.
This command that adds a property name/value pair to a map nested inside a map in config.xml.
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. |
Online command that adds a list property entry to config.xml.
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. |
Online command that adds a property name/value entry in a map in config.xml.
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. |
Online command that adds a custom authentication integration engine.
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. |
Online command that adds a custom service provider (SP) engine.
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. |
Online command that adds a list property entry in a map.
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. |
Online command that adds a nested map property entry in a map.
This command adds a property name/value pair to a map nested inside a map in cot.xml.
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. |
Online command that adds a list property entry.
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. |
Online command that a property name/value entry in a map.
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. |
Online command that deletes a custom authentication integration engine from the configuration.
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
.
deleteCustomAuthnEngine('engineID')
Argument | Definition |
---|---|
engineID | Specifies the engine ID of an existing engine to be deleted. |
Online command that deletes a custom service provider (SP) integration engine from the configuration.
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.
ddeleteCustomSPEngine('engineID')
Argument | Definition |
---|---|
engineID | Specifies the engine ID of an existing engine to be deleted. |
Online command that deletes federations for given provider.
deleteProviderFederation('providerID')
Argument | Definition |
---|---|
providerID | Specifies the ProviderID for the peer provider for which federation is to be deleted. |
Online command that deletes federations for given users.
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. |
Online command that changes the message store between memory and RDBMS.
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. |
Online command that changes the peer provider description.
changePeerProviderDescription('providerID','description')
Argument | Definition |
---|---|
providerID | Specifies the provider ID. |
description | Specifies the provider description. |
Online command that changes the session store between memory and RDBMS.
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. |
Online command that creates a property list.
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. |
Online command that creates a property list nested in the property map.
This command creates a property list, nested in the property map, in config.xml.
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. |
Online command that creates a property map.
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. |
Online command that creates a property map.
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. |
Online command that creates a property list.
Argument | Definition |
---|---|
providerID | Specifies the provider ID. |
listName | Specifies the name of the property list. |
Online command that creates a property list nested in a property map.
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. |
Online command that creates a property map.
createFederationPropertyMap('providerID', 'mapName')
Argument | Definition |
---|---|
providerID | Specifies the provider ID. |
mapName | Specifies the name of the property map to be added to cot.xml. |
Online command that creates a nested property map.
This command creates a property map, nested in another property map, in cot.xml.
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. |
Online command that creates a peer provider property map entry.
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. |
Online command that returns a list nested in a map.
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. |
Online command that returns a map property entry nested in a map.
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. |
Online command that returns a property value.
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. |
Online command that returns a property list.
getConfigPropertyList('configName', 'listName')
Argument | Definition |
---|---|
configName | Specifies the configuration name. |
listName | Specifies the name of the property list to be fetched from config.xml. |
Online command that returns a property value from a map.
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. |
Online command that returns a list value nested in a map.
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. |
Online command that returns a map property entry nested in a map.
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. |
Online command that returns a property value.
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. |
Online command that returns a property list.
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. |
Online command that returns a property value from a map.
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. |
Online command that returns a list of custom authentication integration engines.
This command returns a list of custom authentication integration engines from config.xml.
Online command that returns a list of custom SP integration engines.
This command returns a list of custom service provider (SP) integration engines from config.xml.
Online command that loads metadata from an input file.
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. |
Online command that removes a list property nested in a map.
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. |
Online command that removes a map property nested in a map.
removeConfigMapEntryInMap('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 removed from the nested map. |
Online command that removes a map property nested in a map.
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. |
Online command that removes a configuration property.
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. |
Online command that removes a configuration property list.
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. |
Online command that removes a property map.
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. |
Online command that removes a property value from a map.
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. |
Online command that removes a property list in a map.
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. |
Online command that removes a nested map in a map.
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. |
Online command that removes a nested map property entry in a map.
This command removes a property name/value pair to a map nested inside a map in cot.xml.
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. |
Online command that removes a property value.
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. |
Online command that removes a property list entry.
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. |
Online command that removes a property map.
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. |
Online command that removes a property value from a map.
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. |
Online command that removes a peer provider entry.
removePeerProviderEntry('providerID')
Argument | Definition |
---|---|
providerID | Specifies the name of the peer provider to be removed. |
Online command that sets a property value in config.xml.
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. |
Online command that updates a custom authentication integration engine.
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. |
Online command that updates a custom SP integration engine.
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. |
Online command that adds or updates a property value.
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. |