Express (Distributed operating systems), v8.0 > Secure applications and their environment > Authenticate users > Select a registry or repository > Manage realms in a federated repository > Virtual member manager > Reference > Program model > Entity DataObject
IdentifierType DataObject
IdentifierType represents the identifier of a virtual member manager entity.
The structure of an IdentifierType data object consists of:
uniqueName
is human-friendly. It is used to uniquely identify an entity in virtual member manager. It is in the form of an LDAP distinguished name. Distinguished name is a string that includes the location of the entity in the virtual member manager hierarchy and is formed by concatenating the relative distinguished name of the entity and each of its ancestors all the way to the root. For example, the distinguished name of the person in the container "cn=users,dc=yourco,dc=com" would be "uid=userA,cn=users,dc=yourco,dc=com".
uniqueId
is machine-friendly. It is used to uniquely identify an entity in virtual member manager. It is a globally unique identifier generated either by virtual member manager or by underlying repositories. The virtual member manager client application does not interpret the content of uniqueId. uniqueId is never change and is not reused, so if an entity is renamed or moved, its uniqueId remains the same.
externalId
is a repository-supplied unique identifier for an object. For example, the externalId for an object in an LDAP repository is the UUID of the object. The virtual member manager SPI uses the externalId to interact with a repository adapter.
externalName
is a repository-supplied unique name for an object. For example, the externalName for an object in an LDAP repository is the Distinguished Name (DN) of the object. The externalName is available to application through the API.
repositoryId
is the identifier assigned to a repository as part of the virtual member manager configuration for the repository. The repositoryId is available to application through the API. The repositoryId together with the externalId is used by the virtual member manager to associate data stored in the property extension repository to the data for the same object in the main repository.
changeType
is an optional property that is set only in response to a search for changed entities. It describes the type of change that occurred, which could be adding a new entity, modifying an existing entity, deleting an entity, or renaming an entity. The valid values and string constants of the changeType property are add (for CHANGETYPE_ADD), delete (for CHANGETYPE_DELETE), modify (for CHANGETYPE_MODIFY), and rename (for CHANGETYPE_RENAME). A virtual member manager caller only needs to use the uniqueName and uniqueId properties.
XML schema definition
The following is the XML schema definition for IdentifierType DataObject:
<xsd:complexType name="IdentifierType"> <xsd:attribute name="uniqueId" type="xsd:token"/> <xsd:attribute name="uniqueName" type="xsd:token"/> <xsd:attribute name="externalId" type="xsd:token"/> <xsd:attribute name="externalName" type="xsd:token"/> <xsd:attribute name="repositoryId" type="xsd:token"/> </xsd:complexType>
Sample data object
Following is a sample IdentifierType data object that contains a uniqueID and a uniqueName:
<wim:identifier uniqueId="afdbaa77-2160-4c26-b899-11fa366595ac" uniqueName="uid=persona,cn=users,dc=yourco,dc=com"/>
Parent topic: Entity DataObject