ILogonSession.Credentials

Syntax

Credentials(Realm: String; [ToAdmin: Boolean = False]): ICredentials;

Parameters

Realm. Credentials scope. The identifier of a repository object - Database - should be specified as a parameter value. The specified credentials are used while working with this database. If the "$SYSTEM" value is passed as a parameter value, the specified credentials are used while working with the security manager (working with users).

ToAdmin. The parameter that defines using of credentials as administrator's credentials. The property is set the False by default, and credentials are used as credentials of a regular user. If the True value is passed, credentials are used as administrator's ones.

Description

The Credentials property determines the credentials set within the current session, which will be used to work with objects.

Comments

Working with relational objects requires credentials that are used for authorization when connecting to the server. Such credentials can be specified in settings of the corresponding repository database. If credentials are not specified in database settings, addressing the object for the first time displays a dialog box to enter credentials. If the connection is successful, credentials are cached and will be used when working with other objects that use the same database. Credentials are cached within the same repository connection.

Using this property one can specify credentials that will be applied when working with relational objects (or when working with the security manager), that are configured to work with the database specified in the Realm parameter.

Certain operations (for example, table creation) require administrator's credentials. The ToAdmin parameter value should be considered in this case.

Example

The property use is given in the Working with Security Manager section.