> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/pingone.md).

# PingOne

Connect to PingOne to provision and manage workforce and customer identities: create users, manage group membership, reset passwords, and audit MFA devices.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| PingOne   | Credentials    |

#### PingOne

Connect to PingOne with a Worker application to provision users, manage group membership, reset passwords, and audit MFA devices. The worker application must be granted the 'Identity Data Admin' role; for least privilege, limit that grant to the specific population your workflow manages.

**Set up in PingOne**

1. Prepare the PingOne account or service that the workflow will access. Grant access to the required resources and operations.
2. **Environment ID:** The PingOne environment ID. Find it in the admin console under Settings > Environment Properties (shown with the Region).
3. **Client ID:** Client ID of a PingOne Worker application. Create one under Applications > Applications (add an application, type 'Worker'); the Client ID is on its Configuration tab. The application must be enabled and have an admin role assigned on its Roles tab (e.g. Identity Data Admin) - PingOne will not issue a token otherwise - and use the 'Client Secret Basic' token endpoint authentication method.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **PingOne**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field  | Required                 | What to enter                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| -------------- | ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Environment ID | Yes                      | The PingOne environment ID. Find it in the admin console under Settings > Environment Properties (shown with the Region). [Provider instructions](https://docs.pingidentity.com/pingone/settings/p1_environments.html).                                                                                                                                                                                                                                                                                                     |
| Region         | Optional / as applicable | The PingOne region for your environment: 'com' (North America), 'eu' (Europe), 'ca' (Canada), or 'asia' (Asia-Pacific).                                                                                                                                                                                                                                                                                                                                                                                                     |
| Client ID      | Yes                      | Client ID of a PingOne Worker application. Create one under Applications > Applications (add an application, type 'Worker'); the Client ID is on its Configuration tab. The application must be enabled and have an admin role assigned on its Roles tab (e.g. Identity Data Admin) - PingOne will not issue a token otherwise - and use the 'Client Secret Basic' token endpoint authentication method. [Provider instructions](https://docs.pingidentity.com/pingone/applications/p1_applications_add_applications.html). |
| Client Secret  | Yes                      | Client Secret of the same PingOne Worker application. [Provider instructions](https://docs.pingidentity.com/pingone/applications/p1_view_client_secret_application.html).                                                                                                                                                                                                                                                                                                                                                   |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **PingOne** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create User

Create a new user in a PingOne environment.

**Inputs**

| Field       | Type            | Required | Description                                                                                      |
| ----------- | --------------- | -------- | ------------------------------------------------------------------------------------------------ |
| Username    | string          | Yes      | The unique username for the new account.                                                         |
| Email       | string          | Yes      | The user's email address.                                                                        |
| Population  | select (string) | Yes      | The population (directory group) the user belongs to. Options load from the selected connection. |
| Given Name  | string          | No       | The user's first (given) name.                                                                   |
| Family Name | string          | No       | The user's last (family) name.                                                                   |
| Enabled     | boolean         | No       | Whether the account is active on creation.                                                       |

**Outputs**

| Field         | Type    | Description                     |
| ------------- | ------- | ------------------------------- |
| User ID       | string  | Unique ID of the created user.  |
| Username      | string  | Username of the created user.   |
| Email         | string  | Email of the created user.      |
| Enabled       | boolean | Whether the account is active.  |
| Population ID | string  | Population the user belongs to. |

#### Disable User

Disable (or re-enable) a PingOne user account without deleting it. Use during offboarding to revoke access while preserving the identity.

**Inputs**

| Field   | Type    | Required | Description                                                          |
| ------- | ------- | -------- | -------------------------------------------------------------------- |
| User    | string  | Yes      | The user to disable, by id, username, or email.                      |
| Enabled | boolean | No       | Set the account active state. Defaults to disabling. Default: false. |

**Outputs**

| Field   | Type    | Description                                     |
| ------- | ------- | ----------------------------------------------- |
| User ID | string  | The id of the user whose enabled state changed. |
| Enabled | boolean | Whether the account is now active.              |

#### Add User to Group

Add a PingOne user to a group to grant access associated with that group.

**Inputs**

| Field | Type            | Required | Description                                                              |
| ----- | --------------- | -------- | ------------------------------------------------------------------------ |
| User  | string          | Yes      | The user to add, by id, username, or email.                              |
| Group | select (string) | Yes      | The group to add the user to. Options load from the selected connection. |

**Outputs**

| Field           | Type   | Description                                   |
| --------------- | ------ | --------------------------------------------- |
| User ID         | string | The id of the user added to the group.        |
| Group ID        | string | The id of the group.                          |
| Membership Type | string | How the membership was granted (e.g. direct). |

#### Reset User Password

Start a password reset for a PingOne user. PingOne emails the user a one-time recovery code they use to set a new password themselves. Use to respond to a locked-out account or a credential-exposure event. No password is entered here.

**Inputs**

| Field | Type   | Required | Description                                                  |
| ----- | ------ | -------- | ------------------------------------------------------------ |
| User  | string | Yes      | The user whose password to reset, by id, username, or email. |

**Outputs**

| Field              | Type    | Description                                                                |
| ------------------ | ------- | -------------------------------------------------------------------------- |
| User ID            | string  | The id of the user a recovery code was sent to.                            |
| Recovery Code Sent | boolean | Whether PingOne accepted the request and emailed the user a recovery code. |

#### Read User MFA Devices

List the MFA devices enrolled for a PingOne user, so you can audit multi-factor coverage.

**Inputs**

| Field           | Type    | Required | Description                                                    |
| --------------- | ------- | -------- | -------------------------------------------------------------- |
| User            | string  | Yes      | The user whose MFA devices to list, by id, username, or email. |
| Maximum results | integer | No       | Maximum number of devices to return. Minimum: 1. Default: 25.  |
| Page cursor     | string  | No       | Continue from a previous page.                                 |

**Outputs**

| Field       | Type          | Description                       |
| ----------- | ------------- | --------------------------------- |
| Devices     | object\_array | The user's enrolled MFA devices.  |
| Next cursor | string        | Cursor for the next page, if any. |

#### List Users

List PingOne users, optionally filtered by username, email, population, or account status. Use to look up a user or confirm one exists.

**Inputs**

| Field        | Type            | Required | Description                                                                      |
| ------------ | --------------- | -------- | -------------------------------------------------------------------------------- |
| Username     | string          | No       | Only return the user with this exact username.                                   |
| Email        | string          | No       | Only return the user with this exact email address.                              |
| Population   | select (string) | No       | Only return users in this population. Options load from the selected connection. |
| Enabled only | boolean         | No       | Filter by account status: true for enabled, false for disabled.                  |
| Max users    | integer         | No       | Maximum number of users to return.                                               |
| Page cursor  | string          | No       | Continue from a previous page.                                                   |

**Outputs**

| Field       | Type          | Description                       |
| ----------- | ------------- | --------------------------------- |
| Users       | object\_array | The matching PingOne users.       |
| Next cursor | string        | Cursor for the next page, if any. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/pingone.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
