khis_username: Retrieve the Configured Username

In khisr: An R Client to Retrieve Data from DHIS2

Retrieve the Configured Username

Description

This function returns the username from the configured credentials. If an auth object is provided, it retrieves the username from that object. Otherwise, it retrieves the username from the global auth object.

Usage

khis_username(auth = NULL)

Arguments

auth	(Optional) An auth object. If not provided, the function will retrieve the username from the global auth credentials.

Value

The username as a string, or NULL if no credentials are available.

See Also

Other credential functions: khis_base_url(), khis_cred(), khis_cred_clear(), khis_display_name(), khis_has_cred()

Examples

## Not run: 
    # Set the credentials using global .auth object
    khis_cred(username = 'DHIS2 username',
              password = 'DHIS2 password',
              base_url = 'https://dhis2-instance/api')

    # View the username (expect 'DHIS2 username')
    khis_username()

    # Clear credentials
    khis_cred_clear()

    # View the username (expect 'NULL')
    khis_username()

## End(Not run)

khisr documentation built on Oct. 7, 2024, 1:11 a.m.