Required Input Parameters

type

id

The identity to look up. The value of this parameter depends on the value specified for the type parameter:

user: the login name of the user

organization: the name of the organization

role: the path name of the role

relativerole: the organization name and functional role name separated by a backslash (/) Example: Accounting/VicePresident.

Optional Input Parameters

directory

The UserDirectory to use when looking up identities. If omitted, the default UserDirectory specified by the userDirectory property is used.

Output Parameters

principal

Set to the DirectoryPrincipal object that corresponds to the given type and id.

persona

If the userDirectoryUserAuthority property is set, set to the Persona corresponding to the DirectoryPrincipal that the principal parameter is set to.

Open Parameters

output

Rendered if the DirectoryPrincipal is found.

empty

Rendered if the DirectoryPrincipal with the given type and id cannot be found.

Usage Notes

GetDirectoryPrincipal displays the atg.userdirectory.DirectoryPrincipal that corresponds to the specified input type and id parameters. GetDirectoryPrincipal can also display the atg.security.Persona corresponding to the directory principal it finds.

Example

The following example finds the DirectoryPrincipal for the Approver role: