Skip to main content

User Functions

Get a Page of Users: get_users()​

This function uses the RP Applications > Application Properties > User Management call Get users (GET /cc/api/versioned/rpUser) API to get a page of users.

Parameters:

  • client (HYPRHttpClient): The HYPR client object
  • query_parameters (dict): The request parameters governing pagination of return data

Returns:

  • RPUserPageResponse: The response object containing the user data.

Example:

page_number = 1
page_size = 500
query_parameters = {'version': 4, 'size': page_size, 'page': page_number}
response: RPUserPageResponse = get_users(client=hypr_client, query_parameters=query_parameters)
user_list = response.data
metadata = response.metadata
print(user_list)
print(metadata)

Retrieve RP User Details: get_user_details()​

The Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.

Parameters:

  • client (HYPRHttpClient): The HYPR client object.
  • username (str): username, for which detailed information is sought

Returns:

  • GetUserDetailsResponseList: Response object containing a list of MachineDto objects.

Example:

username = "auser@example.com"
response: GetUserDetailsResponseList = get_user_details(hypr_client, username)
for item in response:
    print(item.name)
    print(item.devices)

Delete a User from an RP Application: delete_user()​

The Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.

Parameters:

  • client (HYPRHttpClient): The HYPR client object
  • request (RPUserPKRequest): Request object containing rp_app_id and username

Returns:

  • None

Example:

request = RPUserPKRequest(app_id='myapp', username='auser')
response = delete_user(hypr_client, request)

Returns a Count of Registered Users: get_registered_user_count()​

Retrieve the total count of registered users in the HYPR Control Center. Users who've paired multiple devices are only counted once.

This request requires a controlCenterAdmin access token.

Parameters:

  • client (HYPRHttpClient): The HYPR client object

Returns:

  • GetRegisteredUserCountResponse object containing the count of all users

Example:

num_users: GetRegisteredUserCountResponse = get_registered_user_count_by_rp(hypr_client)
print(num_users.count)

Return Registered User Count for an RP App: get_registered_user_count_by_rp()​

The Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.

Parameters:

  • client (HYPRHttpClient): The HYPR client object

Returns:

  • GetRegisteredUserCountResponse object containing the count of all users associated with the RP app

Example:

num_users: GetRegisteredUserCountResponse = get_registered_user_count_by_rp(hypr_client)
print(num_users.count)

List All Registered Users: get_all_users()​

User Count Limits

This function can only be called if you have fewer than 5000 users.

The Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.

Parameters:

  • client (HYPRHttpClient): The HYPR client object
  • pagesize (int): The number users per page to retrieve (default is 500)

Returns:

  • List of RPUserDto objects for all users

Example:

user_obj_list = get_all_users(hypr_client, page_size)
    for user in user_obj_list:
        print(user.username, user.email, user.devices)

Delete Users from HYPR: delete_users()​

The Bearer Token determines the affected RP application; this may be the controlCenterAdmin token.

Parameters:

  • client (HYPRHttpClient): The HYPR client object
  • username_list (List): List of usernames

Returns:

  • None

Example:

user_list = ['user1', 'user2', 'user3']
response =  delete_users(hypr_client, user_list)