Try OpenEdge Now
skip to main content
Programming Interfaces
Database Administration Entity Interface Reference : IDomain interface : IDomain properties
 

IDomain properties

Inherits properties from IDataAdminElement and defines the properties listed in the following table.
Table 90. Multi-tenant Maintenance IDomain interface properties
Property name
Data type
Access
Description
AccessCode
CHARACTER
Readable, Writeable
Set to an access code that OpenEdge automatically encrypts and uses to seal any client-principal whose user credentials are authenticated to this domain. The encrypted value is also used to validate the identity and integrity of any client-principal object that is sealed when a user authenticates to the domain.
Any value you set can be a case-sensitive string consisting of printable characters (including embedded spaces and tabs) with a null terminator. The OpenEdge encryption generates a [MD5] MAC value for sealing and validating client-principal objects.
AuditingContext
CHARACTER
Readable, Writeable
Set to the audit context value when a _Client-session record is recorded in the database. It is free text that typically describes the domain's authentication system, location, and any other identifying characteristics.
While this value is optional for auditing, it is recommended that a value be filled in.
AuthenticationSystem
IAuthenticationSystem
Readable, Writeable
Set to an entity object that defines the authentication system configured for the domain.
Comments
CHARACTER
Readable, Writeable
Set to free-text comments about the domain, such as customized authentication details.
Description
CHARACTER
Readable, Writeable
Set to a free-text description of the domain primarily for reporting purposes.
IsBuiltin
LOGICAL
Read-only
Returns TRUE if the domain is an OpenEdge built-in domain pre-configured in OpenEdge database.
IsEnabled
LOGICAL
Readable, Writeable
Set to TRUE to enable the domain, and set to FALSE to disable the domain without removing it from the database.
Name
CHARACTER
Readable, Writeable
Set to the unique name and identifier (within a database) of a security domain that can be used to authenticate or validate a user's identity. A security domain identifies the authentication system used to authenticate users in that domain.
ABL or SQL refers to this name when it performs a user authentication operation or validates the client-principal object (security token) that is sealed by an authentication operation performed in this domain.
In a multi-tenant database environment, the domain name must be used to fully qualify a user's identity by appending the domain name to the user name using an '@' delimiter, for example, "fred@ldap". The user must provide this fully qualified user ID for all user authentication operations in a multi-tenant environment.
RuntimeOptions
CHARACTER
Readable, Writeable
Set to a comma-delimited list of run-time options that depend on the authentication system.
SystemOptions
CHARACTER
Readable, Writeable
Set to any PAM options that you need to provide to the authentication system during user authentication.
Tenant
ITenant
Readable, Writeable
Set to an entity object that identifies the tenant a user can access through the domain.
Users
IUserSet
Read-only
Returns a collection of the OpenEdge users defined in the _User table with this domain. If the domain is not configured for the _oeusertable authentication system, this property returns an empty collection.