Reseller Get User by Email API

Retrieve user details by email within reseller organization

Reseller

Reseller Get User by Email API

Look up a user by their email address within your reseller organization. Quick access to user details using email as the identifier.

Email Lookup

Find by email.

User Details

Complete profile.

Status

Account state.


Endpoint Overview

QUERY/graphql

Retrieve user details by email address within reseller's organization.

Authentication:Bearer Token
Required scopes:reseller

Request Parameters

emailString!Required

The email address of the user to retrieve.


GraphQL Query

query resellerGetUserByEmail($email: String!) {
  resellerGetUserByEmail(email: $email) {
    id
    email
    username
    resellerId
    role
    enabled
    radAccess
    radAccessClear
    createdAt
    updatedAt
  }
}

Variables:

{
  "email": "user@example.com"
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -d '{
    "query": "query resellerGetUserByEmail($email: String!) { resellerGetUserByEmail(email: $email) { id email username role enabled createdAt } }",
    "variables": { "email": "user@example.com" }
  }'

Response

200User Retrieved Successfully
{
  "data": {
    "resellerGetUserByEmail": {
      "id": 123,
      "email": "user@example.com",
      "username": "username123",
      "resellerId": 45,
      "role": "user",
      "enabled": true,
      "radAccess": true,
      "radAccessClear": false,
      "createdAt": "2023-01-01T12:00:00Z",
      "updatedAt": "2024-01-01T12:00:00Z"
    }
  }
}

Response Fields

idInt!

Unique identifier for the user.

emailString!

User's email address.

usernameString!

User's username.

resellerIdInt!

ID of the reseller this user belongs to.

roleString!

User's role.

enabledBoolean!

Whether the user account is enabled.

radAccessBoolean!

Whether RADIUS access is enabled.

createdAtDateTime!

Account creation timestamp.



Manage User

Edit user details after looking them up.

Edit User