com.manageengine.pam360.sdk.services package

pam_service module

class com.manageengine.pam360.sdk.services.pam_service.PAMService(service_config: ServiceConfiguration, user_token: str, org_name: None | str = None)

PAM Service Class through which Entity Class Instances are obtained to perform SDK Operations.

__init__(service_config: ServiceConfiguration, user_token: str, org_name: None | str = None)

Default Constructor.

Parameters:

• service_config (ServiceConfiguration) – Service Configuration Object containing configuration details.

• user_token (str) – Authentication Token of Current SDK User using SDK.

• org_name (str) – Organization Name where operations are performed.

Raises:

SDKRegistrationError – It occurs when: If any get_instance() function is called before registering the Client.

get_access_control_instance()

Get singleton Instance of com.manageengine.pam360.sdk.entity.access_control_entity.AccessControl Entity to perform AccessControl related functions.

Returns:

Singleton Instance of AccessControl Entity Class

Return type:

AccessControl

get_account_instance()

Get singleton Instance of com.manageengine.pam360.sdk.entity.account_entity.Account Entity to perform Account related functions.

Returns:

Singleton Instance of Account Entity Class

Return type:

Account

get_audit_instance()

Get singleton Instance of com.manageengine.pam360.sdk.entity.audit_entity.Audit Entity to perform Audit related functions.

Returns:

Singleton Instance of Audit Entity Class

Return type:

Audit

get_password_instance()

Get singleton Instance of com.manageengine.pam360.sdk.entity.password_entity.Password Entity to perform Password related functions.

Returns:

Singleton Instance of Password Entity Class

Return type:

Password

get_resource_group_instance()

Get singleton Instance of com.manageengine.pam360.sdk.entity.resource_group_entity.ResourceGroup Entity to perform ResourceGroup related functions.

Returns:

Singleton Instance of ResourceGroup Entity Class

Return type:

ResourceGroup

get_resource_instance()

Get singleton Instance of com.manageengine.pam360.sdk.entity.resource_entity.Resource Entity to perform Resource related functions.

Returns:

Singleton Instance of Resource Entity Class

Return type:

Resource

get_user_instance()

Get singleton Instance of com.manageengine.pam360.sdk.entity.user_entity.User Entity to perform User related functions.

Returns:

Singleton Instance of User Entity Class

Return type:

User

registration_utility module

class com.manageengine.pam360.sdk.services.registration_utility.ClientRegistrationManager(service_config: ServiceConfiguration, registration_handler: None | RegistrationHandler = None)

Bases: object

SDK Client Registration Manager for User to register the SDK Client.

__init__(service_config: ServiceConfiguration, registration_handler: None | RegistrationHandler = None)

Default Constructor.

Parameters:

service_config (ServiceConfiguration) – Service Configuration Object containing configuration details.

is_registered() → bool

Check If SDK Client is registered or not.

Returns:

True If SDK Client is registered.

Return type:

bool

service_configuration module

class com.manageengine.pam360.sdk.services.service_configuration.ServiceConfiguration(host: str, port: int, certificate_path: None | str = None, config_folder_path: None | str = None, configuration_handler: None | ConfigurationHandler = None)

Bases: object

PAM Service Configuration used when registering SDK Client and Services .

Attention

certificate_path is required for Self-signed Certificate. Otherwise, not required for CA signed Certificates.

host

Hostname of Machine.

Type:

str

port

Port Number at which Server is running.

Type:

int

certificate_path

Path to Server SSL Certificate.

Type:

str

config_folder_path

Set Config Folder Path manually.

Type:

str

Note

If config_folder_path is not set, config will be stored in <current-directory>/sdk_config Folder by default.

pam_sdk_logger module

class com.manageengine.pam360.sdk.services.pam_sdk_logger.PAMSDKLogger

SDK Logging utility to log internal errors.

Note

Log Files are created under current directory under <current-directory>/sdk_logs by default.

classmethod disable()

Disable SDK Logger.

classmethod enable()

Enable SDK Logger. Enabled by default.

classmethod set_log_file_path(log_file_path: str)

Set Path for Log file manually.

Note

Recommended way to provide log_file_path is to use os.path.join('<folder_path>').