Skip to main content

get-user-by-id

Look up a single ECGrid user by their numeric user ID. Use when the caller already has the integer ID (e.g. from a previous tool result, a ticket, or an admin reference). Returns the user's profile: login, name, company, contact info, network/mailbox affiliation, auth level, lockout status, timestamps. Returns NOT_FOUND when no user matches the ID. Results are limited to what the caller's APIKey can see; another tenant's user ID will surface as NOT_FOUND. For text identifiers (login name, email) use connectivity_user_get-user-by-login; for the caller's own profile use connectivity_user_get-user-me; for discovery (substring search, locked-out roster) use connectivity_user_list-users.

Tool Name

connectivity_user_get-user-by-id

Auth Level Required

Any (scoped to caller's APIKey)

Parameters

ParameterTypeRequiredDescription
request.userIdintegerYesThe numeric ECGrid user ID. Positive integer >= 1. Example: 42.

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-id",
"arguments": { "request": { "userId": 42 } }
}
}

Example Prompts

  • "Look up user 12345"
  • "Show me the profile for user ID 9876"

See Also