com.manageengine.pam360.sdk.model package

account_model module

class com.manageengine.pam360.sdk.model.account_model.AccountModel(account_name: str, account_password_policy: None | str = None, password: None | str = None, notes: None | str = None, account_custom_field: None | dict = None, command_set: None | str = None, record_rdp_sessions: None | bool = None, record_cli_sessions: None | bool = None, disable_password_resets: None | bool = None, configure_password_reset: None | bool = None, services_reset: None | bool = None, services_restart: None | bool = None, scheduled_task_reset: None | bool = None, iis_app_pool_reset: None | bool = None, iis_app_pool_restart: None | bool = None, iis_web_config_reset: None | bool = None)

Dataclass Model for creating and editing Account.

Note

All attributes are set to None by default except account_name.

Attention

account_name is mandatory.

Warning

password is unsupported for editing Account and should not be set.

account_name

Name of Account.

Type:

str

account_password_policy

Password Policy of Account.

Type:

str

password

Password of Account.

Type:

str

notes

Notes of Account.

Type:

str

account_custom_field

Custom Field of Account.

Type:

dict[str, str]

command_set

Command Set of Account.

Type:

str

record_rdp_sessions

Enable or Disable recording RDP Sessions.

Type:

bool

record_cli_sessions

Enable or Disable recording CLI Sessions.

Type:

bool

disable_password_resets

If Password Resets should be disabled.

Type:

bool

configure_password_reset

If Password Reset should be configured.

Type:

bool

services_reset

If services should be reset.

Type:

bool

services_restart

If services should be restarted.

Type:

bool

scheduled_task_reset

If Scheduled Task should be reset.

Type:

bool

iis_app_pool_reset

If IIS App Pool should be reset.

Type:

bool

iis_app_pool_restart

If IIS App Pool should be restarted.

Type:

bool

iis_web_config_reset

If IIS Web Config should be reset.

Type:

bool

audit_model module

class com.manageengine.pam360.sdk.model.audit_model.AuditModel(audit_type: Type, start_index: None | int = None, limit: None | int = None, audit_id: None | int = None, duration: None | Duration = None, date: None | datetime = None, start_time: None | datetime = None, end_time: None | datetime = None)

Dataclass Model for querying Audit Details.

Note

All attributes are set to None by default except audit_type.

Attention

audit_type is mandatory.

audit_type

Audit Type to query.

Type:

AuditConstant.Type

start_index

Index of list of Audit Details from which to start including.

Type:

int

limit

Total count of Audit Details to include.

Type:

int

audit_id

Audit ID from which to start including.

Type:

int

duration

Audit Duration Criteria.

Type:

AuditConstant.Duration

date

Date from which to start including.

Type:

datetime

start_time

Start Time from which to start including.

Type:

datetime

end_time

End Time up to which stop including.

Type:

datetime

dynamic_group_criteria module

class com.manageengine.pam360.sdk.model.dynamic_group_criteria.DynamicGroupCriteria(condition: Condition | str, value: str, operator: Operator = Operator.CONTAINS, custom_type: None | CustomType = None)

Dataclass Model for creating Dynamic Group Criteria for Dynamic Resource Group.

Note

Only custom_type Class Attribute is set to None by default.

condition

Condition to match from Resource or Account Attributes.

Type:

ResourceGroupConstant.Condition | str

value

Value of the condition to match.

Type:

str

custom_type

Custom Type if condition is a Custom Field Label.

Type:

ResourceGroupConstant.CustomType

operator

Type of Operator to match the condition.

Type:

ResourceGroupConstant.Operator

Attention

condition and value are mandatory for creating Dynamic Group Criteria.

Note

Use str type for Custom Type condition. Otherwise, It is recommended to use Condition type for regular condition.

Note

If operator is not set, CONTAINS operator will be set by default.

resource_group_model module

class com.manageengine.pam360.sdk.model.resource_group_model.ResourceGroupModel(resource_group_name: str, group_type: GroupType = GroupType.STATIC, parent_group: None | int | str = None, description: None | str = None, password_policy: None | str = None, no_help_desk_retrieval: None | bool = None, dynamic_group_criteria_list: None | list[DynamicGroupCriteria] = None, match_all_criteria: None | bool = None)

Dataclass Model for creating Static or Dynamic Resource Group.

Note

All attributes are set to None by default except resource_group_name and group_type.

Attention

resource_group_name is mandatory.

Warning

dynamic_group_criteria_list, match_all_criteria are unsupported for creating STATIC Resource Group and should not be set.

resource_group_name

Name of Resource Group.

Type:

str

group_type

Type of Resource Group.

Type:

ResourceGroupConstant.GroupType

Note

If group_type is not set, STATIC is set by default.

description

Description of Resource Group.

Type:

str

password_policy

Password policy of Resource Group.

Type:

str

no_help_desk_retrieval

Enable or Disable password retrieval and other operations without Ticket ID.

Type:

bool

dynamic_group_criteria_list

List of Criteria when creating Dynamic Resource Group.

Type:

list[DynamicGroupCriteria]

match_all_criteria

If every DynamicGroupCriteria

Type:

bool

in :py:attr:`dynamic_group_criteria_list` should match or not *when creating Dynamic Resource Group*.

resource_model module

class com.manageengine.pam360.sdk.model.resource_model.ResourceModel(resource_name: str, dns_name: None | str = None, resource_type: None | str = None, resource_group_name: None | str = None, resource_description: None | str = None, domain_name: None | str = None, department: None | str = None, resource_url: None | str = None, location: None | str = None, resource_password_policy: None | str = None, resource_custom_field: None | dict = None, account_name: None | str = None, account_password: None | str = None, account_password_policy: None | str = None, enable_private_key: None | bool = None, owner_name: None | str = None, notes: None | str = None, account_custom_field: None | dict = None)

Dataclass Model for creating and editing Resource.

Note

All attributes are set to None by default except resource_name.

Attention

resource_name, account_name are mandatory when creating Resource.

Attention

resource_name is mandatory when editing Resource.

resource_name

Name of Resource.

Type:

str

dns_name

DNS Name of Resource.

Type:

str

resource_type

Type of Resource.

Type:

str

resource_description

Description of Resource.

Type:

str

department

Department of Resource.

Type:

str

resource_url

URL of Resource.

Type:

str

location

Location of Resource.

Type:

str

resource_password_policy

Password Policy of Resource.

Type:

str

resource_custom_field

Custom Field of Resource.

Type:

dict[str, str]

account_name

Name of first Account.

Type:

str

resource_group_name

Name of Resource Group to be associated with.

Type:

str

domain_name

Domain Name of Resource.

Type:

str

account_password

Password of Resource.

Type:

str

enable_private_key

Enable or Disable Private Key for Resource.

Type:

bool

owner_name

Owner Name of Resource.

Type:

str

notes

Notes for Resource.

Type:

str

account_custom_field

Custom Field of first Account of Resource.

Type:

dict[str, str]

account_password_policy

Password Policy of first Account of Resource.

Type:

str

Note

If resource_password_policy is not set, default Resource Password Policy will be set at server.

Note

If owner_name is not set, Current SDK User is set by default at server.

user_model module

class com.manageengine.pam360.sdk.model.user_model.UserModel(first_name: None | str = None, last_name: None | str = None, user_name: None | str = None, password: None | str = None, password_policy: None | str = None, role: None | str = None, email: None | str = None, secondary_email: None | str = None, department: None | str = None, location: None | str = None, user_group: None | str = None, super_admin: None | bool = None, allow_add_resources_for_other_users: None | bool = None, two_factor_authentication: None | bool = None, rsa_username: None | str = None, radius_username: None | str = None, phonefactor_username: None | str = None, duo_username: None | str = None, primary_contact: None | str = None, landline_extension: None | str = None, landline_countrycode: None | str = None, landline_number: None | str = None, mobile_countrycode: None | str = None, mobile_number: None | str = None, web_access: None | bool = None, language_code: None | str = None, mobile_access: None | bool = None, addon_access: None | bool = None, remote_connect_access: None | bool = None, remote_connect_via_ssh_proxy: None | bool = None, restapi_access: None | bool = None, sdk_access: None | bool = None, auth_token_validity: None | datetime = None, hostcheck: None | bool = None, hostname: None | str = None)

Dataclass Model for creating and editing User.

Note

All attributes are set to None by default.

Attention

user_name, first_name, last_name, email, password_policy, role are mandatory when creating User.

Warning

user_name is unsupported for editing User and should not be set.

user_name

Username of User when creating User.

Type:

str

first_name

First Name of User.

Type:

str

last_name

Last Name of User.

Type:

str

email

Email of User.

Type:

str

password_policy

Password Policy of User Password.

Type:

str

role

Role of User to specify Access Level.

Type:

str

secondary_email

Secondary Email of User.

Type:

str

department

Department of User.

Type:

str

location

Location of User.

Type:

str

super_admin

Type:

bool

remote_connect_access

Enable or Disable Remote Connect Access.

Type:

bool

password

Password of User.

Type:

str

user_group

User Group Name to which User is added.

Type:

str

web_access

Enable or Disable Web Access.

Type:

bool

language_code

Language of User.

Type:

UserConstant.LanguageCode

mobile_access

Enable or Disable Mobile Access.

Type:

bool

addon_access

Enable or Disable Browser Add-On Access.

Type:

bool

two_factor_authentication

Enable or Disable Two-Factor Authentication.

Type:

bool

restapi_access

Enable or Disable RestAPI Access.

Type:

bool

sdk_access

Enable or Disable SDK Access.

Type:

bool

auth_token_validity

Validity of Authentication Token of User.

Type:

datetime

allow_add_resources_for_other_users

Enable or Disable privilege to add Resources for other Users.

Type:

bool

hostcheck

Enable or Disable Hostname Check.

Type:

bool

hostname

Name of Allowed Hostname.

Type:

str