PingOne

Integrates with the PingOne Management API to unlock, create, delete and update users.

Authentication & Identity Management · PingIdentity

Details

IDPingOne
ProviderThoma Bravo
CategoryAuthentication & Identity Management
From Version6.0.0
Docker Imagedemisto/python3:3.12.13.10116658
Supported ModulesAgentix Cloud Runtime Security Cloud Posture Security XSIAM EDR Cortex Cloud

README

Integrates with the PingOne Management API to unlock, create, delete and update users.

Configure PingOne in Cortex

Parameter Description Required
Your PingOne Environment ID Environment ID is available under the PingOne Dashboard->Environment Properties. True
PingOne Region PingOne has 3 regions, US, EU and Asia. True
Client ID   True
Client Secret   True
Trust any certificate (not secure) Trust any certificate (not secure). False
Use system proxy settings Use system proxy settings. False

Commands

You can execute these commands from the 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.

pingone-unlock-user

Unlock a user’s account.

Base Command

pingone-unlock-user

Input

Argument Name Description Required
username Username to unlock. Required

Context Output

There is no context output for this command.

Command Example

!pingone-unlock-user username=emma.sharp

Human Readable Output

emma.sharp unlocked

pingone-deactivate-user

Deactivate a user’s account.

Base Command

pingone-deactivate-user

Input

Argument Name Description Required
username A username to deactivate. Required

Context Output

There is no context output for this command.

Command Example

!pingone-deactivate-user username=emma.sharp

Human Readable Output

User emma.sharp deactivated

pingone-activate-user

Activate a user’s account.

Base Command

pingone-activate-user

Input

Argument Name Description Required
username A username to activate. Required

Context Output

There is no context output for this command.

Command Example

!pingone-activate-user username=emma.sharp

Human Readable Output

emma.sharp is active now

pingone-set-password

Sets a user’s password. Further password details available here: https://apidocs.pingidentity.com/pingone/platform/v1/api/#put-update-password-self

Base Command

pingone-set-password

Input

Argument Name Description Required
username The username to change the password for. Required
password The new password. Required

Context Output

There is no context output for this command.

Command Example

!pingone-set-password username=emma.sharp password=OnePing123!

Human Readable Output

emma.sharp password was updated.

pingone-password-force-change

Force a user’s password change on next login.

Base Command

pingone-password-force-change

Input

Argument Name Description Required
username The username to force a password change for. Required

Context Output

There is no context output for this command.

Command Example

!pingone-password-force-change username=emma.sharp

Human Readable Output

emma.sharp password was set to force change.

pingone-read-password-state

Read a user’s password state.

Base Command

pingone-read-password-state

Input

Argument Name Description Required
username The username to read password state for. Required

Context Output

There is no context output for this command.

Command Example

!pingone-read-password-state username=emma.sharp

Human Readable Output

Password state for emma.sharp  
status MUST_CHANGE_PASSWORD

pingone-add-to-group

Add user to the group. One of the following has to be given username or userId and groupName or groupId.

Base Command

pingone-add-to-group

Input

Argument Name Description Required
username Username . Optional
groupName Group Name. Optional
groupId Group ID. Optional
userId User ID. Optional

Context Output

There is no context output for this command.

Command Example

!pingone-add-to-group username=richard.smith groupName=Sales

Human Readable Output

User: 9bc53389-f806-47b6-9480-ab1e3c6269b5 added to group: Sales successfully

pingone-remove-from-group

Remove user from the group. One of the following has to be given username or userId and groupName or groupId.

Base Command

pingone-remove-from-group

Input

Argument Name Description Required
username Username. Optional
groupName Group Name. Optional
userId User ID. Optional
groupId Group ID. Optional

Context Output

There is no context output for this command.

Command Example

!pingone-remove-from-group username=richard.smith groupName=Sales

Human Readable Output

User: 9bc53389-f806-47b6-9480-ab1e3c6269b5 was removed from group: Sales successfully

pingone-get-groups

Returns user’s group memberships.

Base Command

pingone-get-groups

Input

Argument Name Description Required
username Username. Required

Context Output

Path Type Description
PingOne.Account.Group string PingOne groups of the user.
PingOne.Account.ID string PingOne account ID.
PingOne.Account.Type string PingOne account type.
PingOne.Account.Group.ID string Group unique ID.
PingOne.Account.Group.Name string Group name.

Command Example

!pingone-get-groups username=emma.sharp

Context Example

{
    "Account": {
        "Group": [
            {
                "ID": "a5ec8d61-6291-4ebf-8630-135c2ecf1d10",
                "Name": "Marketing"
            },
            {
                "ID": "115458a4-5460-4514-802c-df153a6dcd47",
                "Name": "Standard"
            }
        ],
        "ID": "emma.sharp",
        "Type": "PingOne"
    }
}

Human Readable Output

PingOne groups for user: emma.sharp

Groups

ID Name
a5ec8d61-6291-4ebf-8630-135c2ecf1d10 Marketing
115458a4-5460-4514-802c-df153a6dcd47 Standard

pingone-get-user

Returns a PingOne user. One of the following has to be given username or userId.

Base Command

pingone-get-user

Input

Argument Name Description Required
username Username. Optional
userId User ID. Optional
detailed PingOne user details. Optional

Context Output

Path Type Description
PingOne.Account.ID string PingOne account ID.
PingOne.Account.Username string PingOne account username.
PingOne.Account.DisplayName string PingOne account display name.
PingOne.Account.Email string PingOne account email.
PingOne.Account.Enabled boolean PingOne account enabled status.
PingOne.Account.CreatedAt date PingOne account create date.
PingOne.Account.UpdatedAt date PingOne account updated date.

Command Example

!pingone-get-user username=emma.sharp

Context Example

{
    "Account": {
        "CreatedAt": "2021-09-03T18:04:03.916Z",
        "DisplayName": "Emma Testman",
        "Email": "emma.sharp@example.com",
        "Enabled": true,
        "ID": "a8890eb9-38ea-469a-bc00-b64be7903633",
        "UpdatedAt": "2021-09-23T17:18:11.747Z",
        "Username": "emma.sharp"
    }
}

Human Readable Output

User:emma.sharp

AccountStatus CreatedAt Email Enabled Environment First Name ID Last Name PopulationID UpdatedAt Username
OK 2021-09-03T18:04:03.916Z emma.sharp@example.com true b4f5e266-a946-4f77-9cc5-5dc91b046431 Emma a8890eb9-38ea-469a-bc00-b64be7903633 Sharp 4cd45bdb-0eb2-42fe-8475-4bcd908269f1 2021-09-23T17:18:11.747Z emma.sharp

pingone-create-user

Create a PingOne user.

Base Command

pingone-create-user

Input

Argument Name Description Required
username The username to create. Required
populationId PingOne population ID where the new user will be created. Required

Context Output

Path Type Description
PingOne.Account.ID string PingOne account ID.
PingOne.Account.Username string PingOne account username.
PingOne.Account.DisplayName string PingOne account display name.
PingOne.Account.Email string PingOne account email.
PingOne.Account.Enabled boolean PingOne account enabled status.
PingOne.Account.CreatedAt date PingOne account create date.
PingOne.Account.UpdatedAt date PingOne account updated date.

Command Example

!pingone-create-user username=richard.smith populationId=4cd45bdb-0eb2-42fe-8475-4bcd908269f1

Context Example

{
    "Account": {
        "CreatedAt": "2021-09-23T17:18:18.292Z",
        "DisplayName": null,
        "Email": null,
        "Enabled": true,
        "ID": "9bc53389-f806-47b6-9480-ab1e3c6269b5",
        "UpdatedAt": "2021-09-23T17:18:18.292Z",
        "Username": "richard.smith"
    }
}

Human Readable Output

PingOne user created: richard.smith

AccountStatus CreatedAt Email Enabled Environment First Name ID Last Name PopulationID UpdatedAt Username
OK 2021-09-23T17:18:18.292Z   true b4f5e266-a946-4f77-9cc5-5dc91b046431   9bc53389-f806-47b6-9480-ab1e3c6269b5   4cd45bdb-0eb2-42fe-8475-4bcd908269f1 2021-09-23T17:18:18.292Z richard.smith

pingone-update-user

Update a PingOne user.

Base Command

pingone-update-user

Input

Argument Name Description Required
username The username to be updated. Required
formatted Formatted PingOne name. Optional
given Given name. Optional
middle Middle name. Optional
family Family name. Optional
nickname Nickname. Optional
title Title. Optional
locale Locale. Optional
email Email. Optional
primaryPhone Primary phone number. Optional
mobilePhone Mobile phone number. Optional
streetAddress Street address. Optional
locality Locality. Optional
region Region. Optional
postalCode Zip code. Optional
countryCode Country code. Optional
Type Account type. Optional

Context Output

There is no context output for this command.

Command Example

!pingone-update-user username=richard.smith phoneNumber=604-998-7766

Human Readable Output

PingOne user updated: richard.smith

No entries.

pingone-delete-user

Delete a PingOne user. One of the following has to be given username or userId.

Base Command

pingone-delete-user

Input

Argument Name Description Required
username Username. Optional
userId User ID. Optional

Context Output

There is no context output for this command.

Command Example

!pingone-delete-user username=richard.smith

Human Readable Output

User: 9bc53389-f806-47b6-9480-ab1e3c6269b5 was Deleted successfully

Configuration parameters

  • environment_id — Your PingOne Environment ID (required)
  • region — PingOne Region (required)
  • credentials — Client ID (required)
  • insecure — Trust any certificate (not secure)
  • proxy — Use system proxy settings

Commands (13)

  • pingone-activate-user

    Activate a user's account.

  • pingone-add-to-group

    Add user to the group. One of the following has to be given username or userId and groupName or groupId.

  • pingone-create-user

    Create a PingOne user.

  • pingone-deactivate-user

    Deactivate a user's account.

  • pingone-delete-user

    Delete a PingOne user. One of the following has to be given username or userId.

  • pingone-get-groups

    Returns user's group memberships.

  • pingone-get-user

    Returns a PingOne user. One of the following has to be given username or userId.

  • pingone-password-force-change

    Force a user's password change on next login.

  • pingone-read-password-state

    Read a user's password state.

  • pingone-remove-from-group

    Remove user from the group. One of the following has to be given username or userId and groupName or groupId.

  • pingone-set-password

    Sets a user's password. Further password details available here: https://apidocs.pingidentity.com/pingone/platform/v1/api/#put-update-password-self .

  • pingone-unlock-user

    Unlock a user's account.

  • pingone-update-user

    Update a PingOne user.

Source

PingOne.py PingOne_test.py PingOne.yml PingOne_description.md command_examples.txt
Download History Raw 
commonfields:
  id: PingOne
  version: -1
sectionorder:
- Connect
name: PingOne
display: PingOne
category: Authentication & Identity Management
provider: Thoma Bravo
description: 'Integrates with the PingOne Management API to unlock, create, delete and update users. '
configuration:
- display: Your PingOne Environment ID
  name: environment_id
  type: 0
  required: true
  additionalinfo: Environment ID is available under the PingOne Dashboard->Environment Properties.
  section: Connect
- display: PingOne Region
  name: region
  defaultvalue: US
  type: 15
  required: true
  options:
  - US
  - EU
  - Asia
  additionalinfo: PingOne has 3 regions, US, EU and Asia.
  section: Connect
- display: Client ID
  displaypassword: Client Secret
  name: credentials
  type: 9
  required: true
  section: Connect
- display: Trust any certificate (not secure)
  name: insecure
  type: 8
  required: false
  advanced: true
  section: Connect
- display: Use system proxy settings
  name: proxy
  type: 8
  required: false
  advanced: true
  section: Connect
script:
  script: ''
  type: python
  commands:
  - name: pingone-unlock-user
    arguments:
    - name: username
      required: true
      default: true
      description: Username to unlock.
    description: Unlock a user's account.
  - name: pingone-deactivate-user
    arguments:
    - name: username
      required: true
      default: true
      description: A username to deactivate.
    description: Deactivate a user's account.
  - name: pingone-activate-user
    arguments:
    - name: username
      required: true
      default: true
      description: A username to activate.
    description: Activate a user's account.
  - name: pingone-set-password
    arguments:
    - name: username
      required: true
      default: true
      description: The username to change the password for.
    - name: password
      required: true
      description: The new password.
    description: "Sets a user's password. Further password details available here: https://apidocs.pingidentity.com/pingone/platform/v1/api/#put-update-password-self ."
  - name: pingone-password-force-change
    arguments:
    - name: username
      required: true
      default: true
      description: The username to force a password change for.
    description: Force a user's password change on next login.
  - name: pingone-read-password-state
    arguments:
    - name: username
      required: true
      default: true
      description: The username to read password state for.
    description: Read a user's password state.
  - name: pingone-add-to-group
    arguments:
    - name: username
      description: Username.
    - name: groupName
      description: Group name.
    - name: groupId
      description: Group id.
    - name: userId
      description: User id.
    description: Add user to the group. One of the following has to be given username or userId and groupName or groupId.
  - name: pingone-remove-from-group
    arguments:
    - name: username
      description: Username.
    - name: groupName
      description: Group name.
    - name: userId
      description: User id.
    - name: groupId
      description: Group id.
    description: Remove user from the group. One of the following has to be given username or userId and groupName or groupId.
  - name: pingone-get-groups
    arguments:
    - name: username
      description: Username.
      required: true
    outputs:
    - contextPath: PingOne.Account.Group
      description: PingOne groups of the user.
      type: string
    - contextPath: PingOne.Account.ID
      description: PingOne account id.
      type: string
    - contextPath: PingOne.Account.Type
      description: PingOne account type.
      type: string
    - contextPath: PingOne.Account.Group.ID
      description: Group unique id.
      type: string
    - contextPath: PingOne.Account.Group.Name
      description: Group name.
      type: string
    description: Returns user's group memberships.
  - name: pingone-get-user
    arguments:
    - name: username
      description: Username.
    - name: userId
      description: User id.
    - name: detailed
      description: PingOne user details.
    outputs:
    - contextPath: PingOne.Account.ID
      description: PingOne account ID.
      type: string
    - contextPath: PingOne.Account.Username
      description: PingOne account username.
      type: string
    - contextPath: PingOne.Account.DisplayName
      description: PingOne account display name.
      type: string
    - contextPath: PingOne.Account.Email
      description: PingOne account email.
      type: string
    - contextPath: PingOne.Account.Enabled
      description: PingOne account enabled status.
      type: boolean
    - contextPath: PingOne.Account.CreatedAt
      description: PingOne account create date.
      type: date
    - contextPath: PingOne.Account.UpdatedAt
      description: PingOne account updated date.
      type: date
    description: Returns a PingOne user. One of the following has to be given username or userId.
  - name: pingone-create-user
    arguments:
    - name: username
      required: true
      description: The username to create.
    - name: populationId
      description: PingOne population ID where the new user will be created.
      required: true
    outputs:
    - contextPath: PingOne.Account.ID
      description: PingOne account ID.
      type: string
    - contextPath: PingOne.Account.Username
      description: PingOne account username.
      type: string
    - contextPath: PingOne.Account.DisplayName
      description: PingOne account display name.
      type: string
    - contextPath: PingOne.Account.Email
      description: PingOne account email.
      type: string
    - contextPath: PingOne.Account.Enabled
      description: PingOne account enabled status.
      type: boolean
    - contextPath: PingOne.Account.CreatedAt
      description: PingOne account create date.
      type: date
    - contextPath: PingOne.Account.UpdatedAt
      description: PingOne account updated date.
      type: date
    description: Create a PingOne user.
  - name: pingone-update-user
    arguments:
    - name: username
      required: true
      description: The username to be updated.
    - name: formatted
      description: Formatted PingOne name.
    - name: given
      description: Given name.
    - name: middle
      description: Middle name.
    - name: family
      description: Family name.
    - name: nickname
      description: Nickname.
    - name: title
      description: Title.
    - name: locale
      description: Locale.
    - name: email
      description: Email.
    - name: primaryPhone
      description: Primary phone number.
    - name: mobilePhone
      description: Mobile phone number.
    - name: streetAddress
      description: Street address.
    - name: locality
      description: Locality.
    - name: region
      description: Region.
    - name: postalCode
      description: Zip code.
    - name: countryCode
      description: Country code.
    - name: Type
      description: Account type.
    description: Update a PingOne user.
  - name: pingone-delete-user
    arguments:
    - name: username
      description: Username.
    - name: userId
      description: User id.
    description: Delete a PingOne user. One of the following has to be given username or userId.
  dockerimage: demisto/python3:3.12.13.10116658
  runonce: false
  subtype: python3
fromversion: 6.0.0
tests:
- No tests