User Management¶

Every method below exists identically on both AsyncAdminClient (as a coroutine) and AdminClient (as a plain method) — examples use the sync client for brevity.

create_user(user_id)¶

Create a new user account.

user = admin.create_user(user_id=12345)
print(user.api_token)

Returns: UserCreateResponse — see User Models.

Raises: ValidationError (invalid user_id), ConflictError (user already exists), AuthenticationError.

get_user(user_id)¶

Get user info.

user = admin.get_user(12345)
print(user.is_active)

Returns: UserResponse.

Raises: NotFoundError, AuthenticationError.

delete_user(user_id)¶

Delete a user account.

admin.delete_user(12345)

Returns: None.

Raises: NotFoundError, AuthenticationError.

set_user_status(user_id, is_active)¶

Activate or deactivate a user.

user = admin.set_user_status(12345, False)
print(user.is_active)  # False

Returns: UserResponse (updated).

Raises: NotFoundError, AuthenticationError.

refresh_token(user_id)¶

Issue a new API token for the user, invalidating the previous one.

result = admin.refresh_token(user_id=12345)
print(result.new_api_token)

Returns: TokenRefreshResponse.

Raises: NotFoundError, AuthenticationError.

get_user_providers(user_id)¶

List a user's provider connections and their authorization statuses.

connections = admin.get_user_providers(12345)
for conn in connections.connections:
    print(conn.provider_name, conn.status)

Returns: ConnectionsResponse (from v2hub.models — see Typed Models).

Raises: NotFoundError, AuthenticationError.

get_user_provider(user_id, provider_name)¶

Get one specific provider connection for a user.

conn = admin.get_user_provider(12345, "vpn123")
print(conn.status)

Returns: ConnectionResponse (from v2hub.models).

Raises: NotFoundError, AuthenticationError.

User Models¶

UserCreateRequest¶

UserResponse / UserCreateResponse¶

UserCreateResponse extends UserResponse with no additional fields — the same shape is returned by both create_user() and get_user()/set_user_status().

UserStatusUpdateRequest¶

TokenRefreshRequest¶

TokenRefreshResponse¶

Related¶

• Provider Management — the provider-side equivalent of these operations.
• Provider Authorization — connecting a user to a provider once both exist.
• v2hub-cli User Commands — the CLI wrapper around this API.