Previous Topic: login

Next Topic: loginServiceManaged

loginService

The following parameters apply to the loginService method:

Parameter

Type

Description

username

String

Identifies the user ID.

password

String

Identifies the password.

policy

String

(Required) Identifies the policy code, which must be in plain text. Although it is required, it may be empty.

Description

Lets users log in with a conventional username/password authentication scheme where if valid, the system returns a unique session ID. This key should be freed with logout(). A SID may expire if it is not used before a timeout elapses.

User authentication is performed on the username and password while access control is applied based on the policy specified. The authentication is performed as described in login(). Empty policy will allow default policy to be applied automatically. The login user (not the proxy contact specified in the policy) is responsible for subsequent web service activities. All function group security and data partitions are enforced for the login user.

Returns

The following is returned:

Parameter

Type

Description

SID

Integer

Specifies the unique SID to use for all other Web Services calls.