+

Search Tips   |   Advanced Search

IdMgrRealmConfig (AdminTask)

IdMgrRealmConfig commands manage the realm configuration.


addIdMgrRealmBaseEntry

The addIdMgrRealmBaseEntry command adds a base entry to a specific realm configuration and links the realm with the repository.

Target Object None.

Required parameters

-name

Name of the realm. (String, required)

-baseEntry

Name of the base entry. (String, optional)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


createIdMgrRealm

The createIdMgrRealm command creates a realm configuration.

Target Object None.

Required parameters

-name

Name of the realm. (String, required)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

-securityUse

Specifies a string that indicates if this virtual realm will be used in security now, later, or never. The default value is active. Additional values includes: inactive and nonSelectable. (String, optional)

-delimiter

Delimiter used for this realm. The default value is /. (String, optional)

-allowOperationIfReposDown

Whether the system allows a repository operation such as get or search to complete successfully, even if repositories in the realm are down. The default value is false. (Boolean, optional)

Avoid trouble: Even if this parameter is specified, all repositories must be available when you start the server, or the federated repositories will not function properly. gotcha

Examples

Batch mode example:

Interactive mode:


deleteIdMgrRealm

The deleteIdMgrRealm command deletes the realm configuration that specified.

Target Object None.

Required parameters

-name

The realm name. (String, required)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


deleteIdMgrRealmBaseEntry

The deleteIdMgrRealmBaseEntry command deletes a base entry from a realm configuration that specified.

The realm must always contain at least one base entry, thus we cannot remove every entry.

Target Object None.

Required parameters

-name

Name of the realm. (String, required)

-baseEntry

Name of a base entry. (String, required)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


deleteIdMgrRealmDefaultParent

Use the deleteIdMgrRealmDefaultParent command to delete the mapping of the default parent of an entity type for a realm.

Target Object None.

Required parameters

-entityTypeName

Name of a valid supported entity type for which to delete the default parent mapping. We can specify an asterisk (*) to delete the default parent mapping for all entity types in the realm. (String, required)

Optional parameters

-name

Specify a valid realm name for which to delete the mapping. If we do not specify the -name parameter, the command deletes the mapping for defaultWIMFileBasedRealm, which is the default realm in the federated repository configuration. (String, optional)

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


getIdMgrDefaultRealm

The getIdMgrDefaultRealm command returns the default realm name.

Target Object None.

Required parameters None.

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


getIdMgrRepositoriesForRealm

The getIdMgrRepositoriesForRealm command returns repository specific details for the repositories configured for a specified realm.

Target Object None.

Required parameters

-name

Name of the realm. (String, required)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


getIdMgrRealm

The getIdMgrRealm command returns the configuration parameters for the realm that specified.

Target Object None.

Required parameters

-name

Name of the realm. (String, required)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


listIdMgrRealms

The listIdMgrRealms command returns all of the names of the configured realms.

Target Object None.

Required parameters None.

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


listIdMgrRealmBaseEntries

The listIdMgrRealmBaseEntries command returns all of the names of the configured realms.

Target Object None.

Required parameters

-name

Name of the realm. (String, required)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


listIdMgrRealmDefaultParents

Use the listIdMgrRealmDefaultParents command to list the mapping of the default parent uniqueName for all entity types in a specified realm.

Target Object None.

Required parameters None.

Optional parameters

-name

Specify a valid realm name for which to list the mapping. If we do not specify the -name parameter, the command returns the mapping for defaultWIMFileBasedRealm, which is the default realm in the federated repository configuration. (String, optional)

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Return values The listIdMgrRealmDefaultParents command returns the mapping of each entity type to default parent uniqueName for the specified realm. The results are returned as a Map where the key is entityType and the value is parentUniqueName.

Examples

Batch mode example:

Interactive mode:


listIdMgrRealmURAttrMappings

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

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

-name

Specify a valid realm name for which to list the mapping.

If we 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

The listIdMgrRealmURAttrMappings command returns a HashMap containing the following structure:

The following example shows a sample output. The example is broken into multiple lines for illustration purposes only.

Examples

Batch mode example:

Interactive mode:


renameIdMgrRealm

The renameIdMgrRealm command renames the name of the realm that specified.

Renaming the federated repositories realm name does not update the realm name stored in security.xml.

Target Object None.

Required parameters

-name

Name of the realm. (String, required)

-newName

New name of the realm. (String, required)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


setIdMgrDefaultRealm

The setIdMgrDefaultRealm command sets the default realm name.

Required parameters

-name

Name of the realm used as a default realm when the caller does not specify any in context. (String, required)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


setIdMgrRealmDefaultParent

Use the setIdMgrRealmDefaultParent command to set or modify the default parent uniqueName for an entity type in a specified realm.

Target object: None.

Required parameters

-entityTypeName

Name of a valid supported entity type for which to set or modify the default parent. (String, required)

-parentUniqueName

Default parent of the entity type in the specified realm. The default parent specified should be a valid uniqueName in this realm. (String, required)

Optional parameters

-name

Specify a valid realm name for which to set or modify the mapping. If we do not specify the -name parameter, the command sets or modifies the mapping for defaultWIMFileBasedRealm, which is the default realm in the federated repository configuration. (String, optional)

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

Examples

Batch mode example:

Interactive mode:


setIdMgrRealmURAttrMapping

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 we run the setIdMgrRealmURAttrMapping command in connected mode, the realm attribute mapping changes take effect after you restart the server.

Target object: None.

Required parameters

-URAttrName

Name of the user or group attribute in a user registry to map. The following case-sensitive values are valid for the URAttrName parameter:

  • uniqueUserId

  • userSecurityName

  • userDisplayName

  • uniqueGroupId

  • groupSecurityName

  • groupDisplayName

Avoid trouble: If we run the setIdMgrRealmURAttrMapping command multiple times for the same user registry attribute name, it overwrites the previous value.gotcha

(String, required)

-propertyForInput

Name of the federated repository property that maps to the specified user registry attribute (URAttrName parameter) when it is an input parameter for the user registry interface. (String, required)

-propertyForOutput

Name of the federated repository property that maps to the specified user registry attribute (URAttrName parameter) when it is an output parameter (return value) for the user registry interface. (String, required)

In most cases, the propertyForInput and propertyForInput would be the same.

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

-name

Specify a valid realm name for which to set or modify the mapping. If we do not specify the name parameter, the setIdMgrRealmURAttrMapping command uses the default realm in the federated repository configuration. (String, optional)

Examples

Batch mode example:

Interactive mode:


updateIdMgrRealm

The updateIdMgrRealm command updates the configuration for a realm specified.

Target Object None.

Required parameters

-name

Name of the realm. (String, required)

Optional parameters

-securityDomainName

Name that uniquely identifies the security domain. If not specified, the command uses the global federated repository. (String, optional)

-securityUse

Specifies a string that indicates if this realm will be used in security now, later, or never. The default value is active. Additional values includes: inactive and nonSelectable. (String, optional)

-delimiter

specifies the delimiter used for this realm. The default value is /. (String, optional)

-allowOperationIfReposDown

Whether the system allows a repository operation such as get or search to complete successfully, even if repositories in the realm are down. (Boolean, optional)

Avoid trouble: Even if this parameter is specified, all repositories must be available when you start the server, or the virtual member manager might not function properly. gotcha

Examples

Batch mode example:

Interactive mode:


Related tasks

  • Use the wsadmin scripting AdminTask object for scripted administration

  • Commands (AdminTask)
  • IdMgrRepositoryConfig (AdminTask)
  • IdMgrConfig (AdminTask)