SimpleUser
| Attribute Name | Description | Required in XML Definition? | DataType | Length | Readonly? | Required by Repository? |
|---|---|---|---|---|---|---|
| SimpleUser | Used to create a user. Note that in this case alone, the tags are case-sensitive, and must match those listed exactly. | The only required tags are Name and Password - the rest are optional. | ||||
| UserName | The name of the user. | Required | String | Required | ||
| Password | The user's password. | Required | String | Required | ||
| ShouldCreateCredentialManagerUser | An indicator of whether a CredentialManagerUser should be created if the user already exists. | Optional. Default: TRUE | BOOLEAN | 1/0 | READONLY | REQUIRED |
| ReplaceCredentialManagerPassword | An indicator of whether to override the current password if creating a credential manager user for a user who already exists. | Optional. Default: FALSE | BOOLEAN | 1/0 | REQUIRED | |
| CredentialManager | An indicator of which Credential Manager to use for access to the 'Authentication Engine.' | Optional. Default: Default | STRING | 700/0 | REQUIRED | |
| AdminEnabled | An indicator of whether the user will have admin privileges. | Optional. Default: False | BOOLEAN | 1/0 | REQUIRED | |
| CanChangePassword | An indicator of whether the user is allowed to change the password. If creating a guest user, this can be set to false. | Optional. Default: True | INTEGER | 1/0 | ||
| HasPrimaryUserProfile | An indicator of whether to create a primary user profile for this user. | Optional. Default: True | DIRECTORYOBJECT | 1/0 | REQUIRED | |
| HasHomeFolder | An indicator of whether to create a home folder. | Optional. Default: True | DIRECTORYOBJECT | 1/0 | REQUIRED | |
| HomeFolderRoot | Root folder of the user's home folder. | Optional. Default: "/Home" | PUBLICOBJECT | 1/0 | REQUIRED | |
| HomeFolderHasPolicyBundle | An indicator of whether admin privileges are required to free the user's home folder. | Optional. Default: True | PUBLICOBJECT | 1/0 | REQUIRED | |
| HasContentQuota | An indicator of whether to implement a content quota for this user. | Optional. Default: True | DIRECTORYOBJECT | 1/0 | REQUIRED | |
| ContentQuotaAllocatedStorage | Storage space allocated to user in bytes. | Optional. Default: 25000000 | PUBLICOBJECT | 1/0 | ||
| ContentQuotaEnabled | An indicator of whether to enable/disable the implemented content quota. | Optional. Default: False | PUBLICOBJECT | 1/0 | ||
| HasEmail | An indicator of whether to create a email profile for this user. | Optional. Default: True | DIRECTORYOBJECT | 1/0 | REQUIRED | |
| DistinguishedName | The user's distinguished name. If none specified, name is constructed from prefix + username + suffix | Optional. | STRING | 700/0 | REQUIRED | |
| PrimaryUserProfileName | The user's PrimaryUserProfileName. If none specified, name is constructed from prefix + username + suffix | Optional. | PUBLICOBJECT | 1/0 | ||
| EmailUserProfileName | The name for the user's EmailUserProfile. If none specified, name is constructed from prefix + username + suffix | Optional. | STRING | 256/0 | REQUIRED | |
| ContentQuotaName | The name for the user's ContentQuota setting. If none specified, name is constructed from prefix + username + suffix | Optional. | PUBLICOBJECT | 1/0 | ||
| HomeFolderName | The name of the user's home folder. If none specified, name is constructed from prefix + username + suffix | Optional. | PUBLICOBJECT | 1/0 | REQUIRED | |
| HomeFolderDescription | A description for the user's home folder If none specified, name is constructed from prefix + username + suffix | Optional. | PUBLICOBJECT | 1/0 | REQUIRED | |
| DefaultAclsBundleName | The default Access Control List bundle for the user. If none specified, name is constructed from prefix + username + suffix | Optional. | PUBLICOBJECT | 1/0 | ||
| HomeFolderPolicyBundleName | A name for the user's home folder policy bundle. If none specified, name is constructed from prefix + username + suffix | Optional. | PUBLICOBJECT | 1/0 | REQUIRED | |
| EmailAddress | The user's email address. If none specified, name is constructed from prefix + username + suffix | Optional. | STRING | 256/0 | REQUIRED | |
| DistinguishedNameSuffix | Suffix of distinguished name. | Optional. Default: distinguished suffix entered on installation of iFS. | STRING | 700/0 | REQUIRED | |
| PrimaryUserProfileNameSuffix | Suffix of primary user profile name. | Optional. Default: " primary profile" | PUBLICOBJECT | 1/0 | ||
| EmailUserProfileNameSuffix | Suffix of email profile name. | Optional. Default: " email profile" | STRING | 256/0 | REQUIRED | |
| EmailAddressSuffix | Suffix of email address. | Optional. Default: @ + distinguished suffix entered on installation of iFS. | STRING | 256/0 | REQUIRED | |
| ContentQuotaNameSuffix | Suffix of content quota name. | Optional. Default: "content quota" | PUBLICOBJECT | 1/0 | ||
| HomeFolderNameSuffix | Suffix of home folder name. | Optional. Default: "" | PUBLICOBJECT | 1/0 | REQUIRED | |
| HomeFolderDescriptionSuffix | Suffix of home folder description. | Optional. Default: "'s home folder" | PUBLICOBJECT | 1/0 | REQUIRED | |
| DefaultAclsBundleNameSuffix | Suffix of default acls name. | Optional. Default: "defaultacls" | PUBLICOBJECT | 1/0 | ||
| HomeFolderPolicyBundleNameSuffix | Suffix of home folder policy bundle name. | Optional. Default: "policy bundle for homefolder and inbox" | PUBLICOBJECT | 1/0 | REQUIRED | |
| EmailSubfolderName | Name of email subfolder. | Optional. Default: "mail" | STRING | 256/0 | REQUIRED | |
| InboxName | Name of email inbox. | Optional. Default: "inbox" | STRING | 700/0 | ||
| DirectoryUserAcl | Acl of directory user. | Optional. Default: published | DIRECTORYOBJECT | 1/0 | READONLY | REQUIRED |
| HomeFolderPolicyBundleAcl | Acl of home folder policy bundle. | Optional. Default: published | PUBLICOBJECT | 1/0 | REQUIRED | |
| HomeFolderAcl | Acl of home folder. | Optional. Default: private | PUBLICOBJECT | 1/0 | REQUIRED | |
| DefaultAclsBundleAcl | Acl of default acls bundle. | Optional. Default: published | PUBLICOBJECT | 1/0 | ||
| ContentQuotaAcl | Acl of content quota. | Optional. Default: private | PUBLICOBJECT | 1/0 | ||
| PrimaryUserProfileAcl | Acl of primary user profile. | Optional. Default: private | PUBLICOBJECT | 1/0 | ||
| EmailUserProfileAcl | Acl of email profile. | Optional. Default: private | STRING | 256/0 | REQUIRED | |
| EmailSubfolderAcl | Acl of email subfolder. | Optional. Default: private | STRING | 256/0 | REQUIRED | |
| InboxAcl | Acl of email inbox. | Optional. Default: private | STRING | 700/0 | ||
| AclBundleAllPublished | An out-of-the-box property bundle for the default acls of a non-admin user. | Optional. Default: aclbundleallpublished | PUBLICOBJECT | 1/0 | ||
| AclBundleForAdmin | An out-of-the-box property bundle for the default acls of an admin user. | Optional. Default: aclbundleforadmin | PUBLICOBJECT | 1/0 | ||
| DefaultAcls | The property bundle to use for the defaults. | Optional. Default: aclbundleallpublished | PUBLICOBJECT | 1/0 | ||
| DefaultAclsTable | Customized property bundle for the default acls. | Optional. | PUBLICOBJECT | 1/0 | ||
| Options for Delete User | ||||||
| ChangeOwner | Should the existing objects owned by this to-be-deleted user be changed to new owner default: | Optional. | STRING_ARRAY | 1/0 | READONLY | |
| NewOwnerUserName | Set the deleted users' objects to this new owner default: | Optional. | STRING | 700/0 | ||
| FreeCredentialManagerUser | Free or not free the credential manager user when deleting this user default: | Optional. | SYSTEMOBJECT | 1/0 | ||
| FreeHomeFolder | Free or not free the home folder when deleting this user default: | Optional. | SYSTEMOBJECT | 1/0 |
Send us a comment or correction for this page.