Skip to main content

get-user-by-login

Look up a single ECGrid user by their login name or email address. Use when the caller has a textual identifier (most ECGrid logins ARE full email addresses, e.g. jane.smith@example.com). Returns the same profile shape as connectivity_user_get-user-by-id. Returns NOT_FOUND when no user matches; VALIDATION_ERROR when the input contains control characters, null bytes, or injection characters (< > { } ' " ; \) — those are rejected before the backend is called. Results are limited to the caller's APIKey scope. If you only have a numeric ID use connectivity_user_get-user-by-id; for substring / partial-match discovery use connectivity_user_list-users with name.

Tool Name

connectivity_user_get-user-by-login

Auth Level Required

Any (scoped to caller's APIKey)

Parameters

ParameterTypeRequiredDescription
request.loginNamestringYesLogin name or full email address used to sign in to ECGrid. Most logins are email addresses (example: jane.smith@example.com). Length 8–128 characters after trim. Control characters, null bytes, and injection characters < > { } ' " ; \ are rejected before the backend is called.

Response

Returns the specified user's full profile.

{
"userId": 42,
"loginName": "jane.smith@example.com",
"firstName": "Jane",
"lastName": "Smith",
"company": "Acme Corp",
"email": "jane.smith@example.com",
"phone": "555-867-5309",
"timeZoneOffset": -5,
"authLevel": "MailboxAdmin",
"lockoutStatus": false,
"networkId": 7,
"mailboxId": 142,
"lastLogin": "2026-07-05T14:22:10Z",
"openSessions": 1,
"timeOut": 3600,
"created": "2024-03-15T08:00:00Z",
"modified": "2026-06-01T09:30:00Z"
}

Response Fields

FieldTypeDescription
userIdintegerUnique numeric user ID
loginNamestringLogin name / email address used to sign in
firstNamestringFirst name
lastNamestringLast name
companystringCompany or organization name
emailstringContact email address
phonestringPhone number
timeZoneOffsetintegerUTC offset in hours
authLevelstringAuthorization level (see AuthLevel enum)
lockoutStatusbooleantrue if the account is currently locked out
networkIdintegerECGrid network ID this user belongs to
mailboxIdintegerMailbox ID within the network
lastLoginstringISO 8601 timestamp of the most recent login
openSessionsintegerNumber of currently active sessions
timeOutintegerSession timeout in seconds
createdstringISO 8601 timestamp when this user account was created
modifiedstringISO 8601 timestamp of the most recent profile update

Example Call

{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "connectivity_user_get-user-by-login",
"arguments": { "request": { "loginName": "jane.smith@example.com" } }
}
}

Example Prompts

See Also