Instance Configuration User Attributes

a class based approach to configuring your domo instance

source

UserAttribute

 UserAttribute (auth:domolibrary.client.DomoAuth.DomoAuth, id:str,
                name:str, description:str, issuer_type:domolibrary.routes.
                user_attributes.UserAttributes_IssuerType,
                customer_id:str, value_type:str, validator:str,
                validator_configuration:None, security_voter:str,
                custom:bool)

utility class that absorbs many of the domo instance configuration methods

source

UserAttribute.get_by_id

 UserAttribute.get_by_id (auth:domolibrary.client.DomoAuth.DomoAuth,
                          attribute_id:str,
                          session:httpx.AsyncClient=None,
                          debug_api:bool=False,
                          debug_num_stacks_to_drop=2,
                          return_raw:bool=False)
token_auth = dmda.DomoTokenAuth(
    domo_instance=os.environ['DOMO_INSTANCE'],
    domo_access_token=os.environ["DOMO_ACCESS_TOKEN"],
)

await UserAttribute.get_by_id(
    attribute_id="DomoLibraryTestFranchise", auth=token_auth, debug_api=False
)
UserAttribute(id='DomoLibraryTestFranchise', name='franchise_id', description='test', issuer_type=<UserAttributes_IssuerType.CUSTOM: 'customer-defined'>, customer_id='mmmm-0012-0200', value_type='STRING', validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=True)

source

UserAttribute.update

 UserAttribute.update (name=None, description=None, issuer_type:domolibrar
                       y.routes.user_attributes.UserAttributes_IssuerType=
                       None, data_type:str=None, security_voter=None,
                       session:httpx.AsyncClient=None,
                       debug_api:bool=False, debug_num_stacks_to_drop=2)
token_auth = dmda.DomoTokenAuth(
    domo_instance=os.environ['DOMO_INSTANCE'],
    domo_access_token=os.environ["DOMO_ACCESS_TOKEN"],
)
try:
    domo_user_attribute = await UserAttribute.get_by_id(
        auth=token_auth, attribute_id="TestLibraryStore"
    )

    res = await domo_user_attribute.update(
        description=f"domo_library test:  updated from classmethod, {dt.datetime.now().strftime('%Y-%m-%d - %H:%M')}"
    )
    print(res)

except (UserAttributes_GET_Error, UserAttributes_CRUD_Error) as e:
    print(e)
🛑  UserAttributes_GET_Error 🛑 - function: UserAttribute.get_traceback || status 200 || attribute TestLibraryStore not found at domo-community

source

UserAttributes

 UserAttributes (auth:domolibrary.client.DomoAuth.DomoAuth,
                 attributes:List[__main__.UserAttribute]=None)

source

UserAttributes.get

 UserAttributes.get (issuer_type_ls:List[domolibrary.routes.user_attribute
                     s.UserAttributes_IssuerType]=None,
                     session:httpx.AsyncClient=None, debug_api:bool=False,
                     debug_num_stacks_to_drop=2)
Type Default Details
issuer_type_ls List None
session AsyncClient None use UserAttributes_IssuerType enum
debug_api bool False
debug_num_stacks_to_drop int 2 
token_auth = dmda.DomoTokenAuth(
    domo_instance=os.environ['DOMO_INSTANCE'],
    domo_access_token=os.environ["DOMO_ACCESS_TOKEN"],
)

domo_user_attributes = UserAttributes(auth=token_auth)

await domo_user_attributes.get(debug_api=False)
[UserAttribute(id='fzManagerEmail', name='ManagerEmail', description='FZ_POC', issuer_type=<UserAttributes_IssuerType.CUSTOM: 'customer-defined'>, customer_id='mmmm-0012-0200', value_type='STRING', validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=True),
 UserAttribute(id='fzFranchiseID', name='FranchiseID', description='FZ_POC', issuer_type=<UserAttributes_IssuerType.CUSTOM: 'customer-defined'>, customer_id='mmmm-0012-0200', value_type='STRING', validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=True),
 UserAttribute(id='fzStoreID', name='StoreID', description='FZ_POC', issuer_type=<UserAttributes_IssuerType.CUSTOM: 'customer-defined'>, customer_id='mmmm-0012-0200', value_type='STRING', validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=True),
 UserAttribute(id='DomoLibraryStore', name='store_id', description='store ids', issuer_type=<UserAttributes_IssuerType.CUSTOM: 'customer-defined'>, customer_id='mmmm-0012-0200', value_type='STRING', validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=True),
 UserAttribute(id='DomoLibraryTestFranchise', name='franchise_id', description='test', issuer_type=<UserAttributes_IssuerType.CUSTOM: 'customer-defined'>, customer_id='mmmm-0012-0200', value_type='STRING', validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=True),
 UserAttribute(id='domo.policy.managed_email_address', name=None, description=None, issuer_type=<UserAttributes_IssuerType.SYSTEM: 'domo-defined'>, customer_id=None, value_type=None, validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=False),
 UserAttribute(id='domo.policy.managed_employee_id', name=None, description=None, issuer_type=<UserAttributes_IssuerType.SYSTEM: 'domo-defined'>, customer_id=None, value_type=None, validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=False),
 UserAttribute(id='domo.policy.managed_employee_number', name=None, description=None, issuer_type=<UserAttributes_IssuerType.SYSTEM: 'domo-defined'>, customer_id=None, value_type=None, validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=False),
 UserAttribute(id='domo.policy.managed_hire_date', name=None, description=None, issuer_type=<UserAttributes_IssuerType.SYSTEM: 'domo-defined'>, customer_id=None, value_type=None, validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=False),
 UserAttribute(id='domo.policy.managed_user_department', name=None, description=None, issuer_type=<UserAttributes_IssuerType.SYSTEM: 'domo-defined'>, customer_id=None, value_type=None, validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=False),
 UserAttribute(id='domo.policy.managed_user_title', name=None, description=None, issuer_type=<UserAttributes_IssuerType.SYSTEM: 'domo-defined'>, customer_id=None, value_type=None, validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=False)]

source

UserAttributes.create

 UserAttributes.create (attribute_id:str, name=None, description='updated
                        via domolibrary 2025-03-11 - 23:23',
                        data_type:str='ANY_VALUE',
                        security_voter='FULL_VIS_ADMIN_IDP', issuer_type:d
                        omolibrary.routes.user_attributes.UserAttributes_I
                        ssuerType=<UserAttributes_IssuerType.CUSTOM:
                        'customer-defined'>,
                        session:httpx.AsyncClient=None,
                        debug_api:bool=False, debug_num_stacks_to_drop=2,
                        return_raw:bool=False)
token_auth = dmda.DomoTokenAuth(
    domo_instance=os.environ['DOMO_INSTANCE'],
    domo_access_token=os.environ["DOMO_ACCESS_TOKEN"],
)

domo_user_attributes = UserAttributes(auth=token_auth)
try:
    res = await domo_user_attributes.create(
        attribute_id="Test Library Store", name="test library store"
    )
    print(res)

except UserAttributes_CRUD_Error as e:
    print(e)
UserAttribute(id='TestLibraryStore', name='test library store', description='updated via domolibrary 2024-11-08 - 16:11', issuer_type=<UserAttributes_IssuerType.CUSTOM: 'customer-defined'>, customer_id='mmmm-0012-0200', value_type='STRING', validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=True)
token_auth = dmda.DomoTokenAuth(
    domo_instance=os.environ['DOMO_INSTANCE'],
    domo_access_token=os.environ["DOMO_ACCESS_TOKEN"],
)

domo_user_attributes = UserAttributes(auth=token_auth)

await domo_user_attributes.upsert(
    attribute_id="TestLibraryStore",
    description=f"domo_libary upsert test {dt.datetime.now().strftime('%Y-%m-%d - %H:%M')}",
    debug_prn=True,
    debug_api=False,
)
upserting TestLibraryStore in domo-community
UserAttribute(id='TestLibraryStore', name='test library store', description='domo_libary upsert test 2024-11-08 - 16:11', issuer_type=<UserAttributes_IssuerType.CUSTOM: 'customer-defined'>, customer_id='mmmm-0012-0200', value_type='STRING', validator='ANY_VALUE', validator_configuration=None, security_voter='FULL_VIS_ADMIN_IDP', custom=True)

source

UserAttributes.delete

 UserAttributes.delete (attribute_id:str, session:httpx.AsyncClient=None,
                        debug_api:bool=False, debug_num_stacks_to_drop=2,
                        return_raw:bool=False)
token_auth = dmda.DomoTokenAuth(
    domo_instance=os.environ['DOMO_INSTANCE'],
    domo_access_token=os.environ["DOMO_ACCESS_TOKEN"],
)

domo_user_attributes = UserAttributes(auth=token_auth)

await domo_user_attributes.delete(
    attribute_id="TestLibraryStore",
)
ResponseGetData(status=200, response='deleted TestLibraryStore', is_success=True, parent_class=None)