Session attributes

List of attributes related to session.

auth

auth

Syntax

[auth = string]

May occur in

<request>, any Command element

Description

An authentication token that contains encrypted credentials (username and password). If specified, the user and pwd attributes are ignored. This token can be generated using the update.mmUtilities.Cryptography class in conjunction with configured users managed by the mmUserConfig.exe utility.

If Force login encryption is enabled, a login can only be authenticated through this token. A login through the user and pwd attributes fails.

domain

domain

Syntax

[domain = string]

May occur in

<request>, any Command element

Description

The domain name for single sign-on (SSO) authentication.

Note: In an non-interactive scenario the domain/user combination as specified in the XML request cannot be verified against the current "active user" and so has to come from a trusted source (HTTP authentication for example).

impersonate

impersonate

Syntax

[impersonate = string]

May occur in

<request>, any Command element

Description

A reference to a login user that is to be impersonated. See Impersonation.

lang

lang

Syntax

[lang = string]

May occur in

<request>, any Command element

Description

The ISO639 language code for the language to be used. Alternatively, the Aurea CRM language index can be specified for backwards compatibility. See the xml:lang attribute.

xml:lang

xml:lang

Syntax

[xml:lang = string]

May occur in

<request>, any Command element

Description

The ISO639 language code for the language to be used. The following table lists the languages supported by Aurea CRM.

ISO639indexLanguage

de0German

en1English

fr2French

es3Spanish

pt4Portuguese

nl5Dutch

da6Danish

it7Italian

cs8Czech

hu9Hungarian

sk10Slovak

pl11Polish

el12Greek

uk13Ukrainian

sl14Slovenian

ru15Russian

sv16Swedish

fi17Finnish

no18Norwegian

tr19Turkish

hr20Croatian

sr21Serbian

ro22Romanian

ja23Japanese

zh24Chinese

ko25Korean

bg26Bulgarian

th27Thai

langNo

langNo

Syntax

[langNo = unsignedShort]

May occur in

<request>, any Command element

Description

The language number as defined in the Language table (table 00).

module

module

Syntax

[module = string]

May occur in

<request>, any Command element

Values

interface connectlive connector webservice

Description

The name of the module to be assumed.

pwd

pwd

Syntax

[pwd = string]

May occur in

<request>, any Command element

Description

The login password (in plain text).

user

user

Syntax

[user = string]

May occur in

<request>, any Command element

Description

The login username. The user and pwd attributes can be used to authenticate a login in plain text if no encryption is desired (e.g. in a trusted local network) or necessary (e.g. if the request is transmitted using HTTPS).

If no pwd attribute, but a domain attribute is given, single sign-on (SSO) authentication is used (see the domain attribute).