PingOne

This Integration is part of the PingIdentity Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.0.0 and later.

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-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

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 Sharp",
        "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

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

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