Reseller Get User by Username API

Retrieve user details by username within reseller organization

Reseller

Reseller Get User by Username API

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

Username Lookup

Find by username.

User Details

Complete profile.

Access Rights

Role and permissions.


Endpoint Overview

QUERY/graphql

Retrieve user details by username within reseller's organization.

Authentication:Bearer Token
Required scopes:reseller

Request Parameters

usernameString!Required

The username of the user to retrieve.


GraphQL Query

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

Variables:

{
  "username": "username123"
}

HTTP Request:

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

Response

200User Retrieved Successfully
{
  "data": {
    "resellerGetUserByUsername": {
      "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.



List All Users

View all users in your reseller organization.

All Users