US - User Status

Layer	Agent
Direction	From CallGem
Type of Service	CG
Interface ID	AG
Message Purpose	This message is sent to indicate user authentication status.
Example	US\TDlandlord\ANSYSTEM\RS0\PG65535
Explanation	CallGem is responding to a request authenticate the SYSTEM agent detailing successful authentication with all permissions.
Notes	This message is sent in response to the User Authenticate [UA] message.
Last Changed	10.0.0.16

Parameters

Code

Name

Type

Mandatory?

Min Val

Max Val

Description

AgentIdentifier

string

true

User defined parameter values may include any characters except / \ : * ? " < > | & % + ! ' ;

PermissionFlags

int

true

65535

This parameter is a bit flag field describing user permissions. This parameter may have the following values:

ResourceStatus

int

true

The parameter may have a value between 0 and 5.

0	User was authenticated.
1	User Authentication failed - user does not exist
2	User Authentication failed - bad password
3	User Authentication failed - badly-formed parameter(s)
4	User Authentication failed - proxy does not have SYSTEM permissions.
5	User Authentication failed - User account is locked out.
6	User Authentication failed - The password does not meet the tenant's complexity rules.
7	User Authentication failed - The endpoint is not configured as a member of the user's configuration.
5	User Authentication failed - The endpoint has no configuration.

TenantDescriptor

string

true

This parameter is alphanumeric and identifies to which tenant this message applies.