9 Oracle Identity Federation Command-Line Tools

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')

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.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')

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.1 Description

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

9.2.3.2 Syntax

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

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.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')

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.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')

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.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')

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.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')

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.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')

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.1 Description

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

9.2.9.2 Syntax

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

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.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')

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.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')

9.2.11.3 Example

The following command deletes the authentication engine with ID id1234.

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

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')

9.2.12.3 Example

The following command deletes the engine with ID id1234.

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

9.2.13.1 Description

This command deletes federations for given provider ID.

9.2.13.2 Syntax

deleteProviderFederation('providerID')

9.2.13.3 Example

The following command deletes providerA:

wls:/mydomain/serverConfig> deleteProviderFederation(providerA)

9.2.14.1 Description

This command deletes federations for the given list of users.

9.2.14.2 Syntax

deleteUserFederations(['user1,..'])

9.2.14.3 Example

The following command deletes federations for three users:

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

9.2.15.1 Description

This command changes the message store to memory or RDBMS.

9.2.15.2 Syntax

changeMessageStore('type','jndiname')

9.2.15.3 Example

The following command changes the message store to RDBMS:

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

9.2.16.1 Description

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

9.2.16.2 Syntax

changePeerProviderDescription('providerID','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.1 Description

This command changes the session store to memory or RDBMS.

9.2.17.2 Syntax

changeSessionStore('type','jndiname')

9.2.17.3 Example

The following command changes the session store to RDBMS.

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

9.2.18.1 Description

This command creates a property list in config.xml.

9.2.18.2 Syntax

createConfigPropertyList('configName', 'listName')

9.2.18.3 Example

The following command creates property list mylistA.

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

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')

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.1 Description

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

9.2.20.2 Syntax

createConfigPropertyMap('configName', 'mapName')

9.2.20.3 Example

The following command creates property map mymapA:

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

9.2.21.1 Description

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

9.2.21.2 Syntax

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

9.2.21.3 Example

The following command creates nested property map nestedmymapA:

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

9.2.22.1 Description

This command creates a property list in cot.xml.

9.2.22.2 Syntax

9.2.22.3 Example

The following command creates property list mylistA:

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

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')

9.2.23.3 Example

The following command creates nested property list mylistA:

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

9.2.24.1 Description

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

9.2.24.2 Syntax

createFederationPropertyMap('providerID', 'mapName')

9.2.24.3 Example

The following command creates property map mymapA:

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

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')

9.2.25.3 Example

The following command creates nested property map nestedmapA:

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

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')

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.1 Description

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

9.2.27.2 Syntax

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

9.2.27.3 Example

The following command returns mylistA:

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

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')

9.2.28.3 Example

The following command returns property entry myvarA:

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

9.2.29.1 Description

This command returns a property value from config.xml.

9.2.29.2 Syntax

getConfigProperty('configName', 'propName')

9.2.29.3 Example

The following command returns property myvarA:

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

9.2.30.1 Description

This command returns a property list from config.xml.

9.2.30.2 Syntax

getConfigPropertyList('configName', 'listName')

9.2.30.3 Example

The following command returns mylistA:

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

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')

9.2.31.3 Example

The following command returns property propA:

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

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')

9.2.32.3 Example

The following command returns nested list mylistA:

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

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')

9.2.33.3 Example

The following command returns property entry myvarA:

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

9.2.34.1 Description

This command returns a property value from cot.xml.

9.2.34.2 Syntax

getFederationProperty('providerID', 'propName')

9.2.34.3 Example

The following command returns property myvarA:

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

9.2.35.1 Description

This command returns a property list from cot.xml.

9.2.35.2 Syntax

getFederationPropertyList('providerID', 'listName')

9.2.35.3 Example

The following command returns list mylistA:

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

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 

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.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 

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.1 Description

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

9.2.38.2 Syntax

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

9.2.38.3 Example

The following command returns property propA from a map:

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

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.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.1 Description

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

9.2.41.2 Syntax

loadMetadata('metadatafile','description')

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.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')

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.1 Description

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

9.2.43.2 Syntax

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

9.2.43.3 Example

The following command removes the list property mylistA:

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

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')

9.2.44.3 Example

The following command removes the nested property myvarA:

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

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')

9.2.45.3 Example

The following command removes the nested property myvarA:

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

9.2.46.1 Description

This command removes a property from config.xml.

9.2.46.2 Syntax

removeConfigProperty('configName', 'propName')

9.2.46.3 Example

The following command removes the property myvarA:

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

9.2.47.1 Description

This command removes a property list from config.xml.

9.2.47.2 Syntax

removeConfigPropertyList('configName', 'listName')

9.2.47.3 Example

The following command removes the property list mylistA:

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

9.2.48.1 Description

This command removes a property map in config.xml.

9.2.48.2 Syntax

removeConfigPropertyMap('configName', 'mapName')

9.2.48.3 Example

The following command removes mapA:

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

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')

9.2.49.3 Example

The following command removes property propA:

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

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')

9.2.50.3 Example

The following command removes mylistA in mymapA:

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

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')

9.2.51.3 Example

The following command removes nestedmapA in mymap:

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

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')

9.2.52.3 Example

The following command removes map property entry myvarA:

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

9.2.53.1 Description

This command removes a property entry in cot.xml.

9.2.53.2 Syntax

removeFederationProperty('providerID', 'propName')

9.2.53.3 Example

The following command removes the provider property myvarA:

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

9.2.54.1 Description

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

9.2.54.2 Syntax

removeFederationPropertyList('providerID', 'listName')

9.2.54.3 Example

The following command removes mylistA:

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

9.2.55.1 Description

This command removes a property map in cot.xml.

9.2.55.2 Syntax

removeFederationPropertyMap('providerID', 'mapName')

9.2.55.3 Example

The following command removes a map:

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

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')

9.2.56.3 Example

The following command removes property propA from a map:

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

9.2.57.1 Description

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

9.2.57.2 Syntax

removePeerProviderEntry('providerID')

9.2.57.3 Example

The following command removes providerA:

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

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')

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.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')

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.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')

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.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')

9.2.61.3 Example

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

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