update_administrative_user.py

"""

Example - Update an administrative user from your connector

Last update: 2024-03-28

This request updates an administrative user from your connector on a custom connector using a connection to the connector.
It uses a pre-established connection from the examples request to our connector.

The following operations are demonstrated:

    1. Load environment variables (your connector configs) from a `.env` file.
    2. Establish a connection to your TSG connector.
    3. Updates the administrative user from your connector.


Important:

    - Ensure that the required environment variables (Your Connector `API_KEY`, `CONNECTOR_ID`, `ACCESS_URL` and `AGENT_ID`) are set in the .env file before using this request.

    - The connector `API_KEY` can be retrieved by loging into the TSG connector UI and navigating to the 'API Keys' tab.

Execute the code below to publish a new administrative user on your connector.

Ensure that the required parameters are specified before executing the  request:

    - id: The id of the user (username).
    - new_password: The new secret and secure password.
    - new_roles: The new list of roles this user should have. (optional)

Note: The update method creates if the username does not exist
"""


if __name__ == "__main__":
    from loguru import logger
    from dotenv import dotenv_values
    from tsg_client.controllers import TSGController

    # Comment the line below to enable internal logger:
    logger.disable("")

    # Load environment variables:
    config = dotenv_values('.env')

    # Connect to our TSG connector:
    conn = TSGController(
        api_key=config['API_KEY'],
        connector_id=config['CONNECTOR_ID'],
        access_url=config['ACCESS_URL'],
        agent_id=config['AGENT_ID']
    )

    # Specify the required parameters:
    id = "test_id_"
    new_password = "test_password"
    new_roles = ["ROLE_ADMIN"]

    res = conn.update_administrative_user(id, new_password, new_roles)
    print(res)