Inputs & Outputs

Account

Account Fields

• created_at: Date string.
• credentials_last_changed_at: Date string or null.
• has_password: Boolean.
• has_sshkey: Boolean.
• id: Integer.
• name: String.
• parent_id: Integer.
• parent_type: String (devices, active-directories, or static-vaults).
• state: String (Unapproved, Approved, Known, Managed, Fully Managed).

AccountMapping

AccountMapping Fields

• id: Integer.
• name: String.
• notes: String or null.
• pattern: String.
• account_source: String.

ActiveDirectory

ActiveDirectory Fields

• container: String (organizational unit used by PAM).
• control_account_id: Integer.
• created_at: Date string.
• device_count: Integer.
• domain: String.
• enabled: Integer.
• groups: List of strings (groups of interest).
• hostname: String.
• id: Integer.
• name: String.
• notes: String or null.
• user_authentication_service: Boolean.

ApplianceVersions

ApplianceVersions Fields

• api: Integer.
• appliance: String.
• build: String.

Connection

Connection Fields

• id: Integer.
• user_id: Integer.
• username: String.
• protocol: String.
• account: String.
• device_account_id: Integer.
• screenshot_count: Integer.
• device_id: Integer.
• device_name: String.
• map_server_id: Integer or null.
• start_time: Date string.
• end_time: Date string.
• session_id: Integer.

ConnectionParameter

ConnectionParameter Fields

• display_name: String.
• field_type: String.
• field_name: String.
• group_name: String.

Device

Device Fields

• account_source: String. (Local accounts or the name of an Active Directory).
• authentication_service_id: Integer or null.
• authentication_service_name: String or null.
• control_account_id: Integer.
• created_at: Date string.
• device_template_id: Integer.
• device_template_name: String.
• device_vendor_name: String.
• enabled: Boolean.
• hostname: String.
• id: Integer.
• ip_address: String.
• last_activity: Date string or null.
• maximum_connections: Integer or null.
• name: String. device name.
• notes: String or null. notes field for the device.
• profile_ids: List of integers (requires PAM version 9.0.0).
• profiles_count: Integer.

Profile

Profile Fields

• device_ids: List of integers (requires PAM version 9.0.0).
• device_count: Integer.
• groups: List of UserGroups.
• id: Integer.
• name: String.
• schedule_count: Integer.
• task_count: Integer.
• tool_count: Integer.
• user_count: Integer.
• user_group_count: Integer.

Query

• Contains a search query & value.

• Used as an input to the search actions in this plugin.

Searching with like & a wildcard

- pam.devices.search:
    pam_address: internal.pam.net
    queries:
      - attribute: hostname
        query: like
        value: "%-uat"

Searching with not & null

- pam.devices.search:
    pam_address: internal.pam.net
    queries:
      - attribute: authentication_service_id
        query: not
        value: null

Required Fields

• attribute: The name of the attribute to query against.
• query: The query type (see valid query types below).
• value: The value to use in the query. Use % as a wildcard.

Valid Query Types

• equal (string or integer)
• not_equal (string or integer)
• like (string)
• greater_than (integer)
• less_than (integer)
• is (null)
• not (null)

SSHKey

SSHKey Fields

• private: String (private key).
• passphrase: String or null.

Secret

Secret Fields

• account_id: Integer.
• account_usename: String. account username.
• password: String or null.
• ssh_key: SSH key or null.

Session

Session Fields

• id: Integer.
• user_id: Integer.
• username: String.
• client_ip_address: String.
• start_time: Date string.
• end_time: Date string.
• archived: Boolean.
• connection_count: Integer.

StaticVault

StaticVault Fields

• created_at: Date string.
• device_count: Integer.
• id: Integer.
• name: String.

Template

Template Fields

• auth_scheme: String.
• id: Integer.
• name: String.
• display_name: String.
• major_version: Integer.
• minor_version: Integer.
• vendor: String.
• connection_parameters: List of ConnectionParameters.

User

User Fields

• auth_type: String (Local, Local & Radius, Radius, Active Directory, or Active Directory & Radius).
• authentication_service_id: Integer or null.
• authentication_service_name: String or null.
• email_address: String or null.
• enabled: Boolean.
• expires_at: Date string or null.
• id: Integer.
• last_activity: Date string or null.
• name: String.
• notes: String or null.
• profiles_count: Integer.
• state: String.
• user_groups_count: Integer.
• username: String.

UserGroup

UserGroup Fields

• authentication_service_id: Integer or null.
• authentication_service_name: String or null.
• enabled: Boolean.
• id: Integer.
• is_synced_group: Boolean.
• name: String.
• notes: String or null.
• profile_count: Integer.
• profiles: List of Profiles.
• synced_at: Date string or null.
• user_count: Integer.