DelineaSS

category: Authentication & Identity Management
provider: Delinea
sectionorder:
- Connect
commonfields:
  id: DelineaSS
  version: -1
configuration:
- display: Server URL (e.g. https://example.net)
  name: url
  required: true
  type: 0
  section: Connect
- display: Username
  name: credentials
  required: true
  type: 9
  section: Connect
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
  section: Connect
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
  section: Connect
- display: Fetches Credentials
  name: isFetchCredentials
  type: 8
  required: false
  section: Connect
- display: Secret IDs (Provide multiple Id's by using ',' example- 1,2,3)
  name: secrets
  type: 12
  required: false
  section: Connect
description: Delinea Secret Server and Platform is the fully featured Privileged Account Management (PAM) solution available both on premise and in the cloud. It empowers security and IT ops teams to secure and manage all types of privileged accounts and offers the fastest time to value of any PAM solution.
display: DelineaSS
name: DelineaSS
script:
  commands:
  - arguments:
    - description: Secret ID.
      name: secret_id
      required: true
    - description: Notes to get the password.
      name: autoComment
    description: Extracting the password field from the required secret.
    name: delinea-secret-password-get
    outputs:
    - contextPath: Delinea.Secret.Password
      description: Password from secret.
      type: String
  - arguments:
    - description: Secret ID.
      name: secret_id
      required: true
    description: Extracting the username field from the required secret.
    name: delinea-secret-username-get
    outputs:
    - contextPath: Delinea.Secret.Username
      description: Username from secret.
      type: String
  - arguments:
    - description: Search for secret using secret name.
      name: search_name
      required: true
    description: Search for a secret using secret name.
    name: delinea-secret-search-name
    outputs:
    - contextPath: Delinea.Secret.Id
      description: List of Secret IDs.
      type: String
  - arguments:
    - description: Secret ID.
      name: secret_id
      required: true
    - description: New password value.
      name: newpassword
      required: true
      secret: true
    - description: Notes to update the password.
      name: autoComment
    description: Update password for a secret by ID.
    name: delinea-secret-password-update
    outputs:
    - contextPath: Delinea.Secret.Newpassword
      description: New password changed for secret.
      type: String
  - arguments:
    - description: Secret ID.
      name: secret_id
      required: true
    description: Check out a secret.
    name: delinea-secret-checkout
    outputs:
    - contextPath: Delinea.Secret.Checkout
      description: Returns response (None = Successful).
      type: String
  - arguments:
    - description: Secret ID.
      name: secret_id
      required: true
    description: Check in a secret.
    name: delinea-secret-checkin
    outputs:
    - contextPath: Delinea.Secret.Checkin
      description: Secret object.
      type: String
  - arguments:
    - description: Name for new folder.
      name: foldername
      required: true
    - defaultValue: '1'
      description: Folder type ID, 1 - for folder.
      name: foldertypeid
      predefined:
      - ''
      required: true
    - description: Parent folder ID.
      name: parentfolderid
      required: true
    - auto: PREDEFINED
      description: 'Whether the folder should inherit permissions from its parent (default: true).'
      name: inheritpermissions
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether the folder should inherit the secret policy. Defaults to true unless creating a root folder.
      name: inheritsecretpolicy
      predefined:
      - 'true'
      - 'false'
    - description: Secret policy ID.
      name: secretpolicyid
    description: Create a new folder.
    name: delinea-folder-create
    outputs:
    - contextPath: Delinea.Folder.Create
      description: New object folder.
      type: String
  - arguments:
    - description: Search folder name.
      name: foldername
      required: true
    description: Search a specific folder by name.
    name: delinea-folder-search
    outputs:
    - contextPath: Delinea.Folder.Id
      description: List of Folder IDs.
      type: String
  - arguments:
    - description: Folder ID.
      name: folder_id
      required: true
    description: Delete a folder by folder ID.
    name: delinea-folder-delete
    outputs:
    - contextPath: Delinea.Folder.Delete
      description: Folder ID.
      type: String
  - arguments:
    - description: Secret ID.
      name: secret_id
      required: true
    - description: Notes to get a secret.
      name: autoComment
    description: Get secret object by secret ID.
    name: delinea-secret-get
    outputs:
    - contextPath: Delinea.Secret
      description: Secret object.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: Whether to allow DoubleLocks as part of the search. True by default.
      name: filter_allowdoublelocks
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether to return the total number of secrets matching the filters. False by default.
      name: filter_donotcalculatetotal
      predefined:
      - 'true'
      - 'false'
    - description: Only include Secrets with this DoubleLock ID assigned in the search results.
      name: filter_doublelockid
    - description: Names of Secret Template fields to return. Only exposed fields can be returned.
      name: filter_extendedfields
    - description: Return only secrets matching a certain extended type.
      name: filter_extendedtypeid
    - description: Return only secrets within a certain folder.
      name: filter_folderid
    - description: Return only secrets with a certain heartbeat status.
      name: filter_heartbeatstatus
    - auto: PREDEFINED
      description: Whether to include active secrets in results (when excluded equals true).
      name: filter_includeactive
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether to include inactive secrets in results.
      name: filter_includeinactive
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: "Whether to include restricted secrets in results."
      name: filter_includerestricted
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether to do an exact match of the search text or a partial match.
      name: filter_isexactmatch
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether to only include secrets whose template has Remote Password Changing enabled.
      name: filter_onlyrpcenabled
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: When true only Secrets where you are not the owner and the Secret was shared explicitly with your user id will be returned.
      name: filter_onlysharedwithme
      predefined:
      - 'true'
      - 'false'
    - description: Return only secrets matching certain password types.
      name: filter_passwordtypelds
    - auto: PREDEFINED
      description: Specify whether to filter by List, View, Edit, or Owner permission. Default is List. (List = 1, View = 2, Edit = 3, Owner = 4).
      name: filter_permissionrequired
      predefined:
      - '1'
      - '2'
      - '3'
      - '4'
    - auto: PREDEFINED
      description: Specify whether to search AllSecrets, Recent, or Favorites (All = 1, Recent = 2, Favorites = 3).
      name: filter_scope
      predefined:
      - '1'
      - '2'
      - '3'
    - description: Field to search.
      name: filter_searchfield
    - description: Field-slug to search. This will override SearchField.
      name: filter_searchfieldslug
    - description: Search text.
      name: filter_searchtext
    - description: Return only secrets matching a certain template.
      name: filter_secrettemplateid
    - description: Return only secrets within a certain site.
      name: filter_siteid
    - description: Number of records to skip before taking results.
      name: skip
    - description: Sort direction.
      name: sortBy_direction
    - description: Sort field name.
      name: sortBy_name
    - description: Priority index. Sorts with lower values are executed earlier.
      name: sortBy_priority
    - description: Maximum number of records to include in results.
      name: take
    - auto: PREDEFINED
      description: Whether to include secrets in subfolders of the specified folder.
      name: filter_includesubfolders
      predefined:
      - 'true'
      - 'false'
    description: Search secret by multiply parameters.
    name: delinea-secret-search
    outputs:
    - contextPath: Delinea.Secret.Secret
      description: List of Folder IDs.
      type: String
  - arguments:
    - description: Folder name.
      name: foldername
    - description: Folder type ID.
      name: foldertypeid
    - description: Folder ID. Must match ID in path.
      name: id
      required: true
    - auto: PREDEFINED
      description: Whether the folder inherits permissions from its parent.
      name: inheritpermissions
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether the folder inherits the secret policy.
      name: inheritsecretpolicy
      predefined:
      - 'true'
      - 'false'
    - description: ID parent folder.
      name: parentfolderid
    - description: Secret Policy ID.
      name: secretpolicyid
    description: Update a single secret folder by ID.
    name: delinea-folder-update
    outputs:
    - contextPath: Delinea.Folder.Update
      description: Folder object.
      type: String
  - arguments:
    - auto: PREDEFINED
      description: Whether the secret’s password is automatically rotated on a schedule.
      name: autochangeenabled
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether the secret’s password is automatically changed when a secret is checked in. This is a security feature that prevents a use of the password retrieved from check-out after the secret is checked in.
      name: checkoutchangepasswordenabled
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether the user must check-out the secret to view it. Checking out gives the user exclusive access to the secret for a specified period or until the secret is checked in.
      name: checkoutenabled
      predefined:
      - 'true'
      - 'false'
    - description: The number of minutes that a secret will remain checked out.
      name: checkoutintervalminutes
    - auto: PREDEFINED
      description: Whether the secret inherits permissions from the containing folder.
      name: enableinheritpermissions
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether the secret policy is inherited from the containing folder.
      name: enableinheritsecretpolicy
      predefined:
      - 'true'
      - 'false'
    - description: Secret folder ID. If the secret is contained in a folder, the id of the containing folder. Use -1 for secrets that are in the root folder.
      name: folderid
    - description: When an SSH secret is proxied, you can choose to connect as another user and then do an su to the current secret’s user. This is a common practice for connecting with a lower privileged account and then switching to the root user.
      name: launcherconnectassecretid
    - description: Secret name.
      name: name
      required: true
    - description: The id of the password change script to use on applicable web password secrets.
      name: passwordtypewebscriptld
    - auto: PREDEFINED
      description: Whether the user must enter a comment to view the secret.
      name: requirescommen
      predefined:
      - 'true'
      - 'false'
    - description: The id of the secret policy that controls the security and other settings of the secret.
      name: secretpolicyid
    - description: Secret Template ID (integer).
      name: secrettemplateid
      required: true
    - auto: PREDEFINED
      description: Whether session recording is enabled.
      name: sessionrecordingenabled
      predefined:
      - 'true'
      - 'false'
    - defaultValue: '1'
      description: The id of the distributed engine site that is used by this secret for operations such as password changing.
      name: siteid
    - description: |-
        sshKeyArgs options. generateSshKeys (bool) – Whether to generate an SSH private key.
        generatePassphrase (bool) – Whether to generate an SSH private key passphrase. Only applicable when the Secret template has a password changer with the Private Key Passphrase field mapped. If it is not mapped, this setting is ignored.
      name: sshkeyargs
    - description: Item Domain for secret. If need to select template.
      name: domain_item
    - description: Item Machine for secret. If need to select template.
      name: machine_item
    - description: Item Username for secret. If need to select template.
      name: username_item
    - description: Item Password for secret. If need to select template.
      name: password_item
    - description: Item Notes for secret. If need to select template.
      name: notes_item
    - auto: PREDEFINED
      description: Whether the secret should be flagged for immediate password change.
      name: autochangenextpassword
      predefined:
      - 'true'
      - 'false'
    - description: The id of the mapping entity that associates this secret to a specific access request workflow.
      name: accessRequestWorkflowMapId
    description: Create a new secret.
    name: delinea-secret-create
    outputs:
    - contextPath: Delinea.Secret.Create
      description: Secret object.
      type: String
  - arguments:
    - description: ID secret for delete.
      name: id
      required: true
    - description: Notes to Delete the secret.
      name: autoComment
    description: Delete secret by id.
    name: delinea-secret-delete
    outputs:
    - contextPath: Delinea.Secret.Delete
      description: Secret object.
      type: String
  - arguments:
    - description: The user's name as displayed in the user interface.
      name: displayname
      required: true
    - description: Password for new user. The password used to log in.
      name: password
      required: true
    - description: Username.
      name: username
      required: true
    - description: Active Directory unique identifier.
      name: adguid
    - description: Active Directory domain ID.
      name: domainid
    - auto: PREDEFINED
      description: Whether Duo two-factor authentication is enabled.
      name: duotwofactor
      predefined:
      - 'true'
      - 'false'
    - description: The user's email address. Used by the system to send reports, access requests, and other notifications.
      name: emailaddress
    - auto: PREDEFINED
      defaultValue: 'true'
      description: Whether the user account is enabled. Disabled users are unable to log in and do not consume a user license.
      name: enabled
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether FIDO2 two-factor authentication is enabled.
      name: fido2twofactor
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether this is an application account. Application accounts are used for automation, cannot log in using the UI, and do not consume a user license.
      name: isapplicationaccount
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether OATH two-factor authentication is enabled.
      name: oathtwofactor
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether RADIUS two-factor authentication is enabled.
      name: radiustwofactor
      predefined:
      - 'true'
      - 'false'
    - description: When a user account uses RADIUS two-factor authentication, this property is the user name of the RADIUS account used to authenticate this user.
      name: radiususername
    - auto: PREDEFINED
      description: Whether two-factor authentication is enabled.
      name: twofactor
      predefined:
      - 'true'
      - 'false'
    description: Create a new user in Secret Server.
    name: delinea-secret-server-user-create
    outputs:
    - contextPath: Delinea.Secret.Server.User.Create
      description: User object.
      type: String
    compliantpolicies:
    - User Hard Remediation
  - arguments:
    - description: Filter users by Active Directory domain (integer).
      name: filter_domainid
    - auto: PREDEFINED
      description: Whether to include inactive users in the results.
      name: filter_includeinactive
      predefined:
      - 'true'
      - 'false'
    - description: Fields to search.
      name: filter_searchfields
    - description: Search text.
      name: filter_searchtext
    - description: Number of records to skip before taking results.
      name: skip
    - description: Sort direction.
      name: sortBy_direction
    - description: Sort field name.
      name: sortBy_name
    - description: Priority index. Sorts with lower values are executed earlier (integer).
      name: sortBy_priority
    - description: Maximum number of records to include in results (integer).
      name: take
    description: User search, filter and sort in Secret Server.
    name: delinea-secret-server-user-search
    outputs:
    - contextPath: Delinea.Secret.Server.User.Search
      description: List of User IDs.
      type: String
  - arguments:
    - description: User ID. Must match ID in path.
      name: id
      required: true
    - description: The id of the date format to use when displaying dates to this user. These options are defined in Admin > Configuration.
      name: dateoptionid
    - description: The user's name as displayed in the user interface.
      name: displayname
    - auto: PREDEFINED
      description: Whether Duo two-factor authentication is enabled.
      name: duotwofactor
      predefined:
      - 'true'
      - 'false'
    - description: The user's email address. Used by the system to send reports, access requests, and other notifications.
      name: emailaddress
    - auto: PREDEFINED
      description: Whether the user account is enabled. Disabled users are unable to log in and do not consume a user license.
      name: enabled
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether FIDO2 two-factor authentication is enabled.
      name: fido2twofactor
      predefined:
      - 'true'
      - 'false'
    - description: A list of group ids for the groups that can manage this user.
      name: groupowners
    - auto: PREDEFINED
      description: Whether this is an application account. Application accounts are used for automation, cannot log in using the UI, and do not consume a user license.
      name: isapplicationaccount
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether the user is managed by the groups specified in GroupOwners or is managed by all users with the 'Administer Users' role permission.
      name: isgroupownerupdate
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Whether the user is locked out.
      name: isLockedout
      predefined:
      - 'true'
      - 'false'
    - description: Number of login failures to allow before the account is locked out. Set to 0 for unlimited login attempts.
      name: loginfailures
    - auto: PREDEFINED
      description: Whether OATH two-factor authentication is enabled.
      name: oathtwofactor
      predefined:
      - 'true'
      - 'false'
    - description: Password for update user. The password used to log in.
      name: password
    - auto: PREDEFINED
      description: Whether RADIUS two-factor authentication is enabled.
      name: radiustwofactor
      predefined:
      - 'true'
      - 'false'
    - description: When a user account uses RADIUS two-factor authentication, this property is the user name of the RADIUS account used to authenticate this user.
      name: radiususername
    - description: The id of the time format to use when displaying times to this user. These options are defined in Admin > Configuration.
      name: timeoptionid
    - auto: PREDEFINED
      description: Whether two-factor authentication is enabled.
      name: twofactor
      predefined:
      - 'true'
      - 'false'
    - auto: PREDEFINED
      description: Determines the type of Unix authentication to use. Must be Password (0), PublicKey (1), PasswordOrPublicKey (2), or PasswordAndPublicKey (3).
      name: unixauthenticationmethodtype
      predefined:
      - '0'
      - '1'
      - '2'
      - '3'
    description: Update a single user by ID in Secret Server.
    name: delinea-secret-server-user-update
    outputs:
    - contextPath: Delinea.Secret.Server.User.Update
      description: User object.
      type: String
    compliantpolicies:
    - EndPoint Isolation
    - User Hard Remediation
  - arguments:
    - description: User ID.
      name: id
      required: true
    description: Delete Secret Server user by ID.
    name: delinea-secret-server-user-delete
    outputs:
    - contextPath: Delinea.Secret.Server.User.Delete
      description: User object.
      type: String
    compliantpolicies:
    - EndPoint Isolation
    - User Hard Remediation
  - arguments: []
    description: Get Secret Server users list.
    execution: false
    name: delinea-secret-server-user-get
    outputs:
    - contextPath: Delinea.Secret.Server.User
      description: User object.
      type: String
    compliantpolicies:
    - User Hard Remediation
  - arguments:
    - description: Secret ID.
      name: secret_id
      required: true
    - description: The new password.
      name: newpassword
      required: true
    - description: Notes to change the password.
      name: autoComment
    description: Remote password changing.
    name: delinea-secret-rpc-changepassword
    outputs:
    - contextPath: Delinea.Secret.ChangePassword
      description: Secret summary.
      type: String
  - arguments:
    - description: Mobile number of the user.
      name: MobileNumber
    - description: The UUID of the cloud user to change.
      name: ID
    - description: The user is in the Everybody role?
      name: InEverybodyRole
      predefined:
        - 'true'
        - 'false'
    - description: The MFA redirected user uuid.
      name: CmaRedirectedUserUuid
    - description: The user office number.
      name: OfficeNumber
    - description: The user reports to this user UUID.
      name: ReportsTo
    - description: The user preferred culture.
      name: PreferredCulture
    - description: The user display.
      name: DisplayName
    - description: Password for new user. The password used to log in.
      name: Password
      required: true
    - description: The user name.
      name: Name
      required: true
    - description: Account expires date/time.
      name: AccountExp
    - description: Does user's password expire?
      name: PasswordNeverExpire
      predefined:
        - 'true'
        - 'false'
    - description: The User email.
      name: Mail
    - description: Whether this is an service account. Service accounts are used for automation, cannot log in using the UI, and do not consume a user license.
      name: ServiceUser
      predefined:
        - 'true'
        - 'false'
    - description: The User description.
      name: Description
    - description: The user home number.
      name: HomeNumber
    description: Create a new user in Platform.
    name: delinea-platform-user-create
    outputs:
    - contextPath: Delinea.Platform.User.Create
      description: User object.
      type: String
  - arguments:
    - description: The name or UUID of the user to remove.
      name: id
      required: true
    description: Delete Platform user by ID.
    name: delinea-platform-user-delete
    outputs:
      - contextPath: Delinea.Platform.User.Delete
        description: User object.
        type: String
    compliantpolicies:
    - EndPoint Isolation
    - User Hard Remediation
  - arguments:
      - description: Mobile number of the user.
        name: MobileNumber
      - description: The UUID of the cloud user to change.
        name: ID
        required: true
      - description: The user is in the Everybody role?
        name: InEverybodyRole
        predefined:
          - 'true'
          - 'false'
      - description: The MFA redirected user uuid.
        name: CmaRedirectedUserUuid
      - description: The user office number.
        name: OfficeNumber
      - description: The user reports to this user UUID.
        name: ReportsTo
      - description: The user preferred culture.
        name: PreferredCulture
      - description: The user display .
        name: DisplayName
      - description: Password for new user. The password used to log in.
        name: Password
      - description: The user name.
        name: Name
      - description: Account expires date/time.
        name: AccountExp
      - description: Does user's password expire?
        name: PasswordNeverExpire
        predefined:
          - 'true'
          - 'false'
      - description: The User email.
        name: Mail
      - description: Whether this is an service account. Service accounts are used for automation, cannot log in using the UI, and do not consume a user license.
        name: ServiceUser
        predefined:
          - 'true'
          - 'false'
      - description: The User description.
        name: Description
      - description: The user home number.
        name: HomeNumber
    description: Update a Platform user by ID.
    name: delinea-platform-user-update
    outputs:
      - contextPath: Delinea.Platform.User.Update
        description: User object.
        type: String
  - arguments:
    - description: Fetches a platform user by uuid or upn (User Principal Name).
      name: userUuidOrUpn
      required: true
    description: Fetch a Platform user by uuid or upn.
    name: delinea-platform-user-get
    outputs:
    - contextPath: Delinea.Platform.User.Get
      description: User object.
      type: String
  - arguments:
    - description: Display name to filter users.
      name: filter_displayName
      required: false
    - description: Page size. Default 1000.
      name: pageSize
      required: false
    description: Fetch all users from the platform.
    name: delinea-platform-get-all-users
    outputs:
      - contextPath: Delinea.Platform.Users
        description: User object.
        type: String
  - arguments:
      - description: SearchText is looked for in multiple fields.
        name: filter.searchText
        required: true
      - description: Page size. Default 1000.
        name: pageSize
    description: List of platform users matching search text.
    name: delinea-platform-get-user-search-by-text
    outputs:
      - contextPath: Delinea.Platform.UserSearchResults
        description: User object.
        type: String
  dockerimage: demisto/python3:3.12.13.10116658
  runonce: false
  script: '-'
  subtype: python3
  type: python
tests:
- No tests (auto formatted)
fromversion: 6.5.0