Skip to Content
Authgate 1.9.5 is released 🎉

Get User

Retrieve detailed information about a user by their username or license code.

Endpoint: GET /user/{username_or_license_code}

Headers:

  • Authorization: Bearer <admin_api_key> (required)

Path Parameters:

  • username_or_license_code - The user’s username or their license code

Response:

{ "application_id": "123e4567-e89b-12d3-a456-426614174000", "id": "456e7890-e89b-12d3-a456-426614174000", "credential_type": "username_password", "username": "john_doe", "allowed_number_of_devices": 2, "allowed_number_of_simultaneous_sessions": 1, "registered_devices": [ { "id": "789e0123-e89b-12d3-a456-426614174000", "hardware_id": "00:1B:44:11:3A:B7", "registered_at": "2024-01-15T10:30:00Z" } ], "membership": { "application_id": "123e4567-e89b-12d3-a456-426614174000", "user_id": "456e7890-e89b-12d3-a456-426614174000", "active_until": "2024-12-31T23:59:59Z", "is_lifetime": false, "is_active": true, "adjustments": [ { "id": "abc12345-e89b-12d3-a456-426614174000", "type": "license", "occurred_at": "2024-01-15T10:30:00Z", "minutes": 43200, "grants_lifetime_access": false, "revokes_lifetime_access": false, "license_id": "def67890-e89b-12d3-a456-426614174000" } ] } }

Fields:

  • credential_type - Either username_password or license_code
  • allowed_number_of_devices - Max devices the user can register
  • allowed_number_of_simultaneous_sessions - Max concurrent logins
  • membership.is_lifetime - Whether the user has lifetime access
  • membership.is_active - Whether the membership is currently valid
  • membership.adjustments - History of membership changes (licenses, bulk adjustments)

Errors:

  • 401 - Invalid Admin API Key
  • 404 - User not found
Last updated on