CyberArkAIM Deprecated

Deprecated. Use the CyberArk AIM v2 integration instead.

Authentication & Identity Management · CyberArk Central Credential Provider (CCP)

Details

ID	`CyberArkAIM`
Provider	Palo Alto Networks
Category	Authentication & Identity Management
From Version	5.0.0
Supported Modules	Agentix XSIAM

README

Deprecated. Use the CyberArk AIM v2 integration instead.

Configure CyberArkAIM on Cortex XSOAR

Navigate to Settings > Integrations > Servers & Services.
Search for CyberArkAIM.
Click Add instance to create and configure a new integration instance.
- Name: a textual name for the integration instance.
- Server URL (e.g. https://192.168.0.1)
- Port
- AppID as configured in AIM
- Trust any certificate (not secure)
- Use system proxy settings
- Folder to search in safe
- Safe to search in
- isFetchCredentials
- API Username
- API Password
- Credential names - comma-seperated list of credentials names in vault
Click Test to validate the URLs, token, and connection.

Commands

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

Search for credentials: cyber-ark-aim-query
Get a list of credentials: list-credentials
Reset account password: reset-credentials
Get information for an account: account-details

1. Search for credentials

Search credentials in CyberArk AIM. Only one result is returned.

Base Command

cyber-ark-aim-query

Input

Argument Name	Description	Required
username	Username to query	Optional
address	Address to query	Optional
safe	Safe to query	Optional
folder	Folder to query	Optional
object	Object to query	Optional
query	Defines a free query using account properties, including Safe, folder, and object. When this method is specified, all other search criteria are ignored	Optional
queryFormat	Defines the query format, which can optionally use regular expressions	Optional
reason	The reason for retrieving the password. This reason will be audited in the Credential Provider audit log.	Optional
database	Defines search criteria according to the database account property	Optional

Context Output

Path	Type	Description
CyberArk.AIM.Folder	unknown	Account folder
CyberArk.AIM.PasswordChangeInProcess	unknown	Is password change in process
CyberArk.AIM.Content	unknown	Account content
CyberArk.AIM.CreationMethod	unknown	Account creation method
CyberArk.AIM.Name	unknown	Account name
CyberArk.AIM.PolicyID	unknown	Account policy ID
CyberArk.AIM.CPMDisabled	unknown	Account CPM disabled
CyberArk.AIM.Address	unknown	Account address
CyberArk.AIM.Safe	unknown	Account safe
CyberArk.AIM.UserName	unknown	Account username
CyberArk.AIM.DeviceType	unknown	Account device type

2. Get a list of all credentials

Lists all credentials available.

Base Command

list-credentials

Input

Argument Name	Description	Required
identifier	When used, command will return a specific credential	Optional

Context Output

There is no context output for this command.

3. Reset account password

Resets the password for the specified account with a random password.

Base Command

reset-credentials

Input

Argument Name	Description	Required
immediateChangeByCPM	Flag the CPM that the change is effective immediately	Optional
accountId	Account ID to reset password	Required

Context Output

There is no context output for this command.

4. Get information for an account

This method returns information about an account. If more than one account meets the search criteria, only the first account will be returned.

Base Command

account-details

Input

Argument Name	Description	Required
keywords	Keywords matching the account	Required
safe	Specify a safe instead of a specific instance	Optional

Context Output

There is no context output for this command.

Configuration parameters

server — Server URL (e.g. https://192.168.0.1) (required)
port — Port
appid — AppID as configured in AIM (required)
username — API Username
password — API Password
isFetchCredentials — Fetches credentials
folder — Folder to search in safe (required)
safe — Safe to search in (required)
credentialNames — Credential names - comma-separated list of credentials names in vault
insecure — Trust any certificate (not secure)
proxy — Use system proxy settings

Commands (4)

account-details
This method returns information about an account. If more than one account meets the search criteria, only the first account will be returned.
cyber-ark-aim-query
Search credentials in CyberArk using arguments to narrow the search. Cannot return more than one result.
list-credentials
Lists all credentials available
reset-credentials
This method marks the account for an immediate password change by the CPM to a new random password.

Source

CyberArkAIM.js CyberArkAIM.yml

Download History Raw

commonfields:
  id: CyberArkAIM
  version: -1
name: CyberArkAIM
display: CyberArk AIM (Deprecated)
category: Authentication & Identity Management
provider: Palo Alto Networks
description: Deprecated. Use the CyberArk AIM v2 integration instead.
configuration:
- display: Server URL (e.g. https://192.168.0.1)
  name: server
  defaultvalue: ""
  type: 0
  required: true
- display: Port
  name: port
  defaultvalue: ""
  type: 0
  required: false
- display: AppID as configured in AIM
  name: appid
  defaultvalue: ""
  type: 0
  required: true
- display: API Username
  name: username
  defaultvalue: ""
  type: 0
  required: false
- display: API Password
  name: password
  defaultvalue: ""
  type: 4
  required: false
- display: "Fetches credentials"
  name: isFetchCredentials
  defaultvalue: "true"
  type: 8
  required: false
- display: Folder to search in safe
  name: folder
  defaultvalue: ""
  type: 0
  required: true
- display: Safe to search in
  name: safe
  defaultvalue: isFetchCredentials
  type: 0
  required: true
- display: Credential names - comma-separated list of credentials names in vault
  name: credentialNames
  defaultvalue: ""
  type: 12
  required: false
- display: Trust any certificate (not secure)
  name: insecure
  defaultvalue: ""
  type: 8
  required: false
- display: Use system proxy settings
  name: proxy
  defaultvalue: ""
  type: 8
  required: false
script:
  script: ''
  type: javascript
  commands:
  - name: cyber-ark-aim-query
    arguments:
    - name: username
      description: Username to query
    - name: address
      description: Address to query
    - name: safe
      description: Safe to query
    - name: folder
      description: Folder to query
    - name: object
      description: Object to query
    - name: query
      description: Defines a free query using account properties, including Safe, folder, and object. When this method is specified, all other search criteria are ignored
    - name: queryFormat
      auto: PREDEFINED
      predefined:
      - Exact
      - Regexp
      description: Defines the query format, which can optionally use regular expressions
    - name: reason
      description: The reason for retrieving the password. This reason will be audited in the Credential Provider audit log.
    - name: database
      description: Defines search criteria according to the Database account property
    outputs:
    - contextPath: CyberArk.AIM.Folder
      description: Account folder
    - contextPath: CyberArk.AIM.PasswordChangeInProcess
      description: Is password change in process
    - contextPath: CyberArk.AIM.Content
      description: Account content
    - contextPath: CyberArk.AIM.CreationMethod
      description: Account creation method
    - contextPath: CyberArk.AIM.Name
      description: Account name
    - contextPath: CyberArk.AIM.PolicyID
      description: Account policy ID
    - contextPath: CyberArk.AIM.CPMDisabled
      description: Account CPM disabled
    - contextPath: CyberArk.AIM.Address
      description: Account address
    - contextPath: CyberArk.AIM.Safe
      description: Account safe
    - contextPath: CyberArk.AIM.UserName
      description: Account username
    - contextPath: CyberArk.AIM.DeviceType
      description: Account device type
    description: Search credentials in CyberArk using arguments to narrow the search. Cannot return more than one result.
  - name: list-credentials
    arguments:
    - name: identifier
      default: true
      description: When used, command will return a specific credential
    description: Lists all credentials available
  - name: reset-credentials
    arguments:
    - name: immediateChangeByCPM
      description: Signal the CPM that the change is effective immediately
      auto: PREDEFINED
      predefined:
      - "Yes"
      - "No"
      defaultValue: "Yes"
    - name: accountId
      required: true
      default: true
      description: Account Id to reset password
    description: 'This method marks the account for an immediate password change by the CPM to a new random password. '
  - name: account-details
    arguments:
    - name: keywords
      required: true
      default: true
      description: Keywords matching the account
    - name: safe
      description: Specify a safe rather then using instance specific.
    description: This method returns information about an account. If more than one account meets the search criteria, only the first account will be returned.
  runonce: false
tests:
- No test
deprecated: true
fromversion: 5.0.0