You can use the Jython or Jacl scripting languages to configure federated repositories realms. The commands and parameters in the IdMgrRealmConfig group can be used to create and manage your realm configuration.
The addIdMgrRealmBaseEntry command adds a base entry to a specific realm configuration and links the realm with the repository.
Target Object
None.Required parameters
Optional parameters
NoneExamples
Batch mode example usage:
$AdminTask addIdMgrRealmBaseEntry {-name defaultWIMFileBasedRealm -baseEntry o=sampleFileRepository}
AdminTask.addIdMgrRealmBaseEntry ('[-name defaultWIMFileBasedRealm -baseEntry o=sampleFileRepository]')
AdminTask.addIdMgrRealmBaseEntry (['-name', 'defaultWIMFileBasedRealm', '-baseEntry', 'o=sampleFileRepository'])
Interactive mode example usage:
$AdminTask addIdMgrRealmBaseEntry {-interactive}
AdminTask.addIdMgrRealmBaseEntry ('[-interactive]')
AdminTask.addIdMgrRealmBaseEntry (['-interactive'])
The createIdMgrRealm command creates a realm configuration.
Target Object
None.Required parameters
Optional parameters
Examples
Batch mode example usage:
$AdminTask createIdMgrRealm {-name realm1 -allowOperationIfReposDown true}
AdminTask.createIdMgrRealm ('[-name realm1 -allowOperationIfReposDown true]')
AdminTask.createIdMgrRealm (['-name', 'realm1', '-allowOperationIfReposDown', 'true'])
Interactive mode example usage:
$AdminTask createIdMgrRealm {-interactive}
AdminTask.createIdMgrRealm ('[-interactive]')
AdminTask.createIdMgrRealm (['-interactive'])
The deleteIdMgrRealm command deletes the realm configuration that you specified.
Target Object
None.Required parameters
Optional parameters
None.Examples
Batch mode example usage:
$AdminTask deleteIdMgrRealm {-name realm1}
AdminTask.deleteIdMgrRealm ('[-name realm1]')
AdminTask.deleteIdMgrRealm (['-name', 'realm1'])
Interactive mode example usage:
$AdminTask deleteIdMgrRealm {-interactive}
AdminTask.deleteIdMgrRealm ('[-interactive]')
AdminTask.deleteIdMgrRealm (['-interactive'])
The deleteIdMgrRealmBaseEntry command deletes a base entry from a realm configuration that you specified.
The realm must always contain at least one base entry, thus you cannot remove every entry.
Target Object
None.Required parameters
Optional parameters
None.Examples
Batch mode example usage:
$AdminTask deleteIdMgrRealmBaseEntry {-name realm1 -baseEntry entry1}
AdminTask.deleteIdMgrRealmBaseEntry ('[-name realm1 -baseEntry entry1]')
AdminTask.deleteIdMgrRealmBaseEntry (['-name', 'realm1', '-baseEntry', 'entry1'])
Interactive mode example usage:
$AdminTask deleteIdMgrRealmBaseEntry {-interactive}
AdminTask.deleteIdMgrRealmBaseEntry ('[-interactive]')
AdminTask.deleteIdMgrRealmBaseEntry (['-interactive'])
The getIdMgrDefaultRealm command returns the default realm name.
Target Object
None.Required parameters
None.Optional parameters
None.Examples
Batch mode example usage:
$AdminTask getIdMgrDefaultRealm
AdminTask.getIdMgrDefaultRealm()
AdminTask.getIdMgrDefaultRealm()
Interactive mode example usage:
$AdminTask getIdMgrDefaultRealm {-interactive}
AdminTask.getIdMgrDefaultRealm ('[-interactive]')
AdminTask.getIdMgrDefaultRealm (['-interactive'])
The getIdMgrRepositoriesForRealm command returns repository specific details for the repositories configured for a specified realm.
Target Object
None.Required parameters
Optional parameters
None.Examples
Batch mode example usage:
$AdminTask getIdMgrRepositoriesForRealm {-name realm1}
AdminTask.getIdMgrRepositoriesForRealm ('[-name realm1]')
AdminTask.getIdMgrRepositoriesForRealm (['-name', 'realm1'])
Interactive mode example usage:
$AdminTask getIdMgrRepositoriesForRealm {-interactive}
AdminTask.getIdMgrRepositoriesForRealm ('[-interactive]')
AdminTask.getIdMgrRepositoriesForRealm (['-interactive'])
The getIdMgrRealm command returns the configuration parameters for the realm that you specified.
Target Object
None.Required parameters
Optional parameters
None.Examples
Batch mode example usage:
$AdminTask getIdMgrRealm {-name realm1}
AdminTask.getIdMgrRealm ('[-name realm1]')
AdminTask.getIdMgrRealm (['-name', 'realm1'])
Interactive mode example usage:
$AdminTask getIdMgrRealm {-interactive}
AdminTask.getIdMgrRealm ('[-interactive]')
AdminTask.getIdMgrRealm (['-interactive'])
The listIdMgrRealms command returns all of the names of the configured realms.
Target Object
None.Required parameters
None.Optional parameters
None.Examples
Batch mode example usage:
$AdminTask listIdMgrRealms
AdminTask.listIdMgrRealms()
AdminTask.listIdMgrRealms()
Interactive mode example usage:
$AdminTask listIdMgrRealms {-interactive}
AdminTask.listIdMgrRealms ('[-interactive]')
AdminTask.listIdMgrRealms (['-interactive'])
The listIdMgrRealmBaseEntries command returns all of the names of the configured realms.
Target Object
None.Required parameters
Examples
Batch mode example usage:
$AdminTask listIdMgrRealmBaseEntries {-name realm1}
AdminTask.listIdMgrRealmBaseEntries ('[-name realm1]')
AdminTask.listIdMgrRealmBaseEntries (['-name', 'realm1'])
Interactive mode example usage:
$AdminTask listIdMgrRealmBaseEntries {-interactive}
AdminTask.listIdMgrRealmBaseEntries ('[-interactive]')
AdminTask.listIdMgrRealmBaseEntries (['-interactive'])
Use the listIdMgrRealmURAttrMappings command to list the mappings between the user or group attributes for a user registry and the federated repository properties of a specified realm.
Target object
None.
Optional parameters
If you do not specify the -name parameter, the listIdMgrRealmURAttrMappings command returns the mapping of the default realm in the federated repository configuration.
(String, optional)
Return values
{userDisplayName={propertyForInput=principalName, propertyForOutput=principalName}, userSecurityName={propertyForInput=principalName, propertyForOutput=principalName}, uniqueUserId={propertyForInput=uniqueName, propertyForOutput=uniqueName}, uniqueGroupId={propertyForInput=uniqueName, propertyForOutput=uniqueName}, groupSecurityName={propertyForInput=cn, propertyForOutput=cn}, groupDisplayName={propertyForInput=cn, propertyForOutput=cn}}
Examples
Batch mode example usage:
$AdminTask listIdMgrRealmURAttrMappings
AdminTask.listIdMgrRealmURAttrMappings()
AdminTask.listIdMgrRealmURAttrMappings()
Interactive mode example usage:
$AdminTask listIdMgrRealmURAttrMappings {-interactive}
AdminTask.listIdMgrRealmURAttrMappings ('[-interactive]')
AdminTask.listIdMgrRealmURAttrMappings (['-interactive'])
The renameIdMgrRealm command renames the name of the realm that you specified.
Target Object
None.Required parameters
Optional parameters
None.Examples
Batch mode example usage:
$AdminTask renameIdMgrRealm {-name realm1}
AdminTask.renameIdMgrRealm ('[-name realm1]')
AdminTask.renameIdMgrRealm (['-name', 'realm1'])
Interactive mode example usage:
$AdminTask renameIdMgrRealm {-interactive}
AdminTask.renameIdMgrRealm ('[-interactive]')
AdminTask.renameIdMgrRealm (['-interactive'])
The setIdMgrDefaultRealm command sets up the default realm configuration.
Required parameters
Examples
Batch mode example usage:
$AdminTask setIdMgrDefaultRealm {-name realm1}
AdminTask.setIdMgrDefaultRealm ('[-name realm1]')
AdminTask.setIdMgrDefaultRealm (['-name', 'realm1'])
Interactive mode example usage:
$AdminTask setIdMgrDefaultRealm {-interactive}
AdminTask.setIdMgrDefaultRealm ('[-interactive]')
AdminTask.setIdMgrDefaultRealm (['-interactive'])
Use the setIdMgrRealmURAttrMapping command to set or modify the mapping of the user or group attribute for a user registry to a federated repository property of a specified realm.
The setIdMgrRealmURAttrMapping command is available in both connected and local modes. If you run the setIdMgrRealmURAttrMapping command in connected mode, the realm attribute mapping changes take effect after you restart the server.
Target object
None.
Required parameters
(String, required)
Optional parameters
Examples
Batch mode example usage:
$AdminTask setIdMgrRealmURAttrMapping {-URAttrName unique_user_ID -propertyForInput unique_name -propertyForOutput unique_name}
AdminTask.setIdMgrRealmURAttrMapping ('[-URAttrName unique_user_ID -propertyForInput unique_name -propertyForOutput unique_name]')
AdminTask.setIdMgrRealmURAttrMapping (['-URAttrName', 'unique_user_ID', '-propertyForInput', 'unique_name', '-propertyForOutput', 'unique_name'])
Interactive mode example usage:
$AdminTask setIdMgrRealmURAttrMapping {-interactive}
AdminTask.setIdMgrRealmURAttrMapping ('[-interactive]')
AdminTask.setIdMgrRealmURAttrMapping (['-interactive'])
The updateIdMgrRealm command updates the configuration for a realm that you specify.
Target Object
None.Required parameters
Optional parameters
Examples
Batch mode example usage:
$AdminTask updateIdMgrRealm {-name realm1}
AdminTask.updateIdMgrRealm ('[-name realm1]')
AdminTask.updateIdMgrRealm (['-name', 'realm1'])
Interactive mode example usage:
$AdminTask updateIdMgrRealm {-interactive}
AdminTask.updateIdMgrRealm ('[-interactive]')
AdminTask.updateIdMgrRealm (['-interactive'])