List Users

Prerequisites

• imednet package installed

• Access to an iMednet environment

Environment variables

export IMEDNET_API_KEY
export IMEDNET_SECURITY_KEY
export IMEDNET_STUDY_KEY
export IMEDNET_BASE_URL (optional)

Description

Retrieve users in a study.

from imednet import ImednetSDK as ImednetClient

"""
Example script demonstrating how to retrieve users from an iMednet study using the iMednet SDK.
This script shows how to:
1. Initialize the iMednet SDK client with authentication credentials
2. List available studies
3. Get users for the first study
4. Print basic user information for up to 5 users
Required Parameters:
    api_key (str): API key for authentication
    security_key (str): Security key for authentication
    base_url (str, optional): Custom base URL if needed, defaults to None
    study_key (str): Study identifier key
Returns:
    Prints user information to console including:
    - Number of users in the study
    - Login and name details for up to 5 users
Raises:
    Exception: Any errors during API communication or data retrieval
"""

api_key = "XXXXXXXXXX"
security_key = "XXXXXXXXXX"
base_url = None  # Or set to your custom base URL if needed
study_key = "XXXXXXXXXX"

try:
    client = ImednetClient(api_key=api_key, security_key=security_key, base_url=base_url)
    studies = client.studies.list()
    if not studies:
        print("No studies returned from API.")
    for study in studies[:1]:
        study_key = study.study_key
        users = client.users.list(study_key=study_key)
        print(f"Users for study '{study_key}': {len(users)}")
        for user in users[:5]:
            print(f"- User Login: {user.login}, Name: {user.name}")
except Exception as e:
    print(f"Error: {e}")