# PingOne SaaS Connector > SailPoint PingOne SaaS Connector Documentation # Documentation # Connecting SailPoint and PingOne To connect SailPoint with PingOne, perform the following tasks: To connect SailPoint with PingOne, perform the following tasks: ## Adding the Source in SailPoint To connect to SailPoint, perform the following steps. Once the connection is made, you can configure it to meet your company's needs. > [!IMPORTANT] > > By default, the provisioning feature is **disabled**, and the connector only supports read-only operations. To support provisioning operations, you must manually enable the feature in the source configuration. **To configure a new source:** 1. Sign in to SailPoint. 2. Go to **Admin \> Connections \> Sources**. 3. Select **Create New**. 4. Search for the connector by entering the name in the search box, and then select **Actions**. 5. In the **Actions** dropdown list, select the setup method: - [**Express Setup**](<#configuring-a-source-using-express-setup>) - Quickly create a read-only connection to your target system by providing minimal configurations and authentication. On completion, aggregation is automatically started. > **Note** > > Express Setup supports Credential Providers. For information on supported credential providers and configuration, refer to [Credential Providers](). For more information, contact your SailPoint Customer Service Manager. - [**Standard Setup**](<#configuring-a-source-using-standard-setup>) - Provide detailed basic configuration to create the source. Once the source is created, continue with source setup. ### Configuring a Source Using Express Setup Express Setup minimizes the initial configuration process so you can quickly connect the application and immediately begin aggregating user account and entitlement data. 1. Review the directions and select **Start Express Setup**. 2. Review the pre-populated **Source Name**, **Source Owner**, and **Description**. To update, select **Edit**. > **Note** > > The source name must be unique. You can change these settings later in the source configuration. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a Credential Provider in SailPoint, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. For more information, refer to the **Connection Settings** section. 5. Select **Finish**. After a successful test connection, the system creates your source and prompts you to run an aggregation. - If you want to aggregate now, select **Aggregate**. - To see the latest account aggregation history, go to **Account Management \> Account Aggregation**. - To see the list of aggregated source accounts, go to **Account Management \> Accounts**. - If you want to aggregate later, select **Exit**. This returns you to the **Sources** page. Your new source is listed, but contains no accounts or aggregation history yet. ### Configuring a Source Using Standard Setup Use Standard Setup to configure the connector for full feature support. 1. In the **Source Name** field, enter a unique and descriptive name for your source. Source names cannot exceed 128 characters. 2. In the **Description** field, provide additional details about the source to help distinguish it from similar sources. This field allows a maximum of 2,000 characters. 3. In the **Source Owner** field, begin typing the name of an owner. Matches appear after you type two or more letters. For more information, refer to [Assigning a Source Owner](). 4. (Optional) Select a governance group to grant its members [source]() or [role]() sub-admin level oversight of the source and its access. For more information, refer to [Creating and Managing Governance Groups](). 5. If this source represents a primary system containing your organization's personnel records, select the **Authoritative Source** checkbox. For more information, refer to [Creating Identity Profiles](). 6. Select **Continue**. The source is created, and you are navigated to the **Source Setup \> Base Configuration** page. Continue to configure your connected source there. ## Base Configuration Provide the base configuration parameters. Information you entered in the Create New Source dialog is automatically entered into the fields in the Base Configuration page. You can edit this information if necessary. 1. Enter a unique name and description for the source. 2. In the **Source Owner** dropdown list, select the identity that owns this source. - To find a source owner, begin entering their name. 3. (Optional) If enabled for your organization, select the **Use a Credential Provider** checkbox to manage the source's authentication using a credential provider. > **Note** > > To add a credential provider, go to **Admin \> Connections \> Credential Providers**. For more information about credential providers, refer to [Credential Providers](). 4. Configure the authentication to allow SailPoint to connect to the source. Refer to [Connection Settings](<#connection-settings>) for more information. 5. (Optional) In the **Governance Group for Source Management** dropdown list, select a governance group to associate with this source. For more information about governance groups, refer to [Associating Governance Groups with a Source](). 6. (Optional) Choose whether to enable or disable provisioning for the source. Provisioning is disabled by default. - **Enable Provisioning** - Set the toggle to **Enabled** to allow the source to create, update, and deactivate accounts in the connected source system. - **Disable Provisioning** - Set the toggle to **Disabled** to disable provisioning for the source. Disabling provisioning will prevent the creation, updating, or deactivating of accounts on this source. 7. Select **Save**. ## Connection Settings The following information is required for SailPoint to connect and interact with PingOne. > [!NOTE] > > **Screenshot** > > [![Connection Settings]()]() 1. Enter the **API URL** and **Token URL**. The URLs are region based. Expand the table below for information: > **Table** > > | Region | API URL | Token URL | > | --- | --- | --- | > | North America | [https://api.pingone.com]() | [https://auth.pingone.com]() | > | European Union | [https://api.pingone.eu]() | [https://auth.pingone.eu]() | > | Canada | [https://api.pingone.ca]() | [https://auth.pingone.ca]() | > | Asia-Pacific | [https://api.pingone.asia]() | [https://auth.pingone.asia]() | 2. Open the PingOne application and select **Configuration**. The **General section** will contain the needed **Environment ID**, **Client ID**, and **Client Secret**. Enter the information from there into it's respective field here. 3. Select **Save**. ## Aggregation Settings > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() > [!NOTE] > > **Screenshot** > > [![Aggregation Settings]()]() 1. Enter the filter statements for **Account Filter**, **Group Filter**, and **Population Filter**. For example, `(type eq "Employee" or type eq "Consultant")` For more information, refer to [Configuring Filters](<#configuring-filters>). 2. In the **Page Size** field, enter the maximum size of each data set when querying a large number of accounts, groups, and populations. The default value is100, and the maximum value is 200. For more information about filters and page size, refer to [PingOne for Developers](). 3. Select **Save**. ### Configuring Filters Use Filter format as shown below: `("Enter Attribute Name" eq/sw/co/ew "Enter String to search")` > [!NOTE] > > Filters are only supported for accounts, groups, and population endpoints. #### Account Filter | Operator | Description | Supported Attributes | | --- | --- | --- | | eq | Equals | `accountId, address.streetAddress, address.locality, address.region, address.postalCode, address.countryCode, email, enabled, externalId, locale, mobilePhone, name.formatted, name.given, name.middle, name.family, name.honorificPrefix, name.honorificSuffix, nickname, population.id, preferredLanguage, primaryPhone, timezone, title, type, username` | | sw | Starts with | `accountId, address.streetAddress, address.locality, address.region, address.postalCode, address.countryCode, email, enabled, externalId, locale, mobilePhone, name.formatted, name.given, name.middle, name.family, name.honorificPrefix, name.honorificSuffix, nickname, photo.href, preferredLanguage, primaryPhone, timezone, title, type, username` | | ew | Ends with | `name.given, name.family, email` (only for the domain specified in the address, starting with and including the symbol "@", such as "@example.com"). | | co | Contains | `name.given, name.family` | Examples: `(username eq "example")` `(email sw "e")` #### Group Filter | Operator | Description | Supported Attributes | | --- | --- | --- | | eq | Equals | `id, name, population.id` | | sw | Starts with | `name` | Examples: `(name eq "sample group")` `(name sw "s")` #### Population Filter | Operator | Description | Supported Attributes | | --- | --- | --- | | eq | Equals | `id, name, population.id` | | sw | Starts with | `name` | Examples: `(name eq "sample population")` `(name sw "p")` ## Feature Management > [!NOTE] > > **Screenshot** > > [![Feature Management]()]() 1. Select **Manage PingOne Roles** if the source is intended to manage PingOne Roles. > **Caution** > > Managing the PingOne roles and fetching the `roles` attribute associated with accounts will increase the execution time for the aggregation operation. 2. Select **Save**. ## Review and Test Perform a test to confirm the connection to SailPoint. 1. Go to **Review and Test**. 2. Confirm that the entries in each field are correct. If you note any mistakes, return to the section and make corrections. 3. Select **Test Connection**. ## SailPoint Application Onboarding SailPoint application onboarding enables you to easily onboard new applications and create sources following the successful onboarding of a discovery source. To use this feature, continue to **Discovered Applications** in the SailPoint user interface. For more information, refer to [Application Onboarding]() in the SailPoint SaaS documentation. # Integrating SailPoint with PingOne PingOne is an Identity-as-a-service (IDaaS) solution that enables organizations to deliver secure cloud single sign-on (SSO) and multi-factor authentication for users with just one username and password - eliminating the multiple password security problem. It enables enterprises to give their users federated access to any application with a single click from a secure, cloud-based dock, accessible from any browser or mobile device. The PingOne source offers governance of the users in the PingOne system. This includes aggregation, provisioning, and the management of entitlements at the account level. > [!NOTE] > > To view the latest features, enhancements, and fixes for all SaaS connectors, refer to the [SaaS Release Notes]() page. ## Supported Features The PingOne source supports the following features: - Aggregation of Accounts - Aggregation of Entitlements (group, role and population) - Get Account - Get Entitlement - Provisioning - Create Account - Add/Remove Entitlement (group and role) - Update Account - Update Population - Enable Account - Disable Account - Delete Account - Unlock Account - Change Password - Access Certifications (Certifications of entitlements connected to the accounts) - Aggregation and Provisioning of [Custom Attributes]() > [!NOTE] > > The PingOne source manages one specific environment present within the PingOne Organization. ## Prerequisites The following prerequisites are required: 1. To connect with the PingOne system you will need to get an **API URL**, **Environment ID**, **Token URL**, **Client ID**, and **Client Secret**. These will be used to identify and authenticate your application. 2. Use the PingOne admin console to create your first application connection. To create the application connection, sign in and perform the following: 1. Select **Connections**. 2. Select the **\+** icon. 3. Enter an **Application Name**. 4. Under **Choose Application Type**, select **Worker**. 5. Select **Save**. 6. On the application's Overview page, select the toggle in the top-right corner of the page to enable the application. For information about authentication, refer to [PingOne for Developers](). ## Required Permissions You must have the **Environment Admin** and **Identity Data Admin** roles to access all APIs for users, groups, roles and populations. # Machine Account Attributes ## Machine Account Provisioning Attributes The following table lists the attributes in the machine account creation template, including the type, generator, and description for each attribute. > [!IMPORTANT] > > Account attributes marked with an asterisk (\*) are mandatory attributes for machine account creation. | Attribute | Type | Description | | --- | --- | --- | | username\* | string | Username of the account | | email | string | Email of the account | | name.given | string | First name of the account | | name.family | string | Last name of the account | | enabled | boolean | Active status of the account | | name.middle | string | Middle name of the account | | name.honorificPrefix | string | Honorific prefix of the account | | name.honorificSuffix | string | Honorific suffix of the account | | name.formatted | string | Full name of the account | | nickname | string | Nickname of the account | | mfaEnabled | boolean | Whether the account requires multifactor authentication (MFA) | | identityProvider.id | string | Identity provider ID of the account | | locale | string | Default location of the account | | password | string | Password of the account | | address.streetAddress | string | Street address of the account | | address.locality | string | Locality of the account | | address.region | string | Region of the account | | address.postalCode | string | ZIP or postal code of the account | | address.countryCode | string | Country code of the account | | lifecycle.status | string | Lifecycle status of the account | | lifecycle.suppressVerificationCode | boolean | Whether the verification code is suppressed for the account | | title | string | Title of the account | | type | string | Type of the account | | primaryPhone | string | Primary phone number of the account | | mobilePhone | string | Mobile phone number of the account | | preferredLanguage | string | Preferred written or spoken languages of the account | | timezone | string | Local timezone of the account | | population.id | string | Population ID of the account | For more information, refer to [Machine Identity Security Overview](). # Provisioning The PingOne connector supports provisioning, allowing you to create and manage accounts and entitlements in PingOne directly from SailPoint. **Prerequisite:** Your system is configured for provisioning. When SailPoint provisions new accounts to the source, it uses the attributes on the **Create Account** page as instructions or a template for what to include in the account. This page is also referred to as the *provisioning policy*. When new access is granted on a source where a user does not already have an account, SailPoint automatically includes account creation in the provisioning. This applies whether provisioning is started from an access request or from an automated role or lifecycle state assignment. For direct-connect sources, SailPoint automatically creates the account from this configuration. If the source is not configured as a direct-connect source, SailPoint creates and assigns a provisioning task to the source owner and includes the values for the source owner to use in manually creating the account. > [!IMPORTANT] > > This section describes the default **Create Account** configuration. SailPoint recommends that you work with Services to define a provisioning configuration specific to your company's needs. Be sure to verify large changes to the provisioning policy before implementation. Failure to do so might cause provisioning to fail. ## Default Create Account Attributes | Account Attribute | Generator | Description | | --- | --- | --- | | username | Identity Attribute - Work Email | The user's UserName. | | email | Identity Attribute - Work Email | The user's email. | | name.given | Identity Attribute - First Name (firstname) | The user's first name. | | name.family | Identity Attribute - Last Name (lastname) | The user's last name. | | name.middle | Disable | The user's middle name. | | name.honorificPrefix | Disable | The user's honorific prefix. | | name.honorificSuffix | Disable | The user's honorific suffix. | | nickname | Disable | The user's nickname. | | enable | Static true | Active status of the user. This attribute is set to 'true' by default when the user is created. Set the value to 'false' to create the user in a disabled state. | | mfaEnabled | Disable | Indicates if the user requires multifactor authentication (MFA). This attribute is set to 'false' by default when the user is created. | | identityProvider.id | Disable | The user's identityProvider id. | | locale | Disable | The user's default location. For example, en-US, es-419, az-Arab, x-pig-latin, man-Nkoo-GN. | | password | Disable | The password of the user. The password should meet the password policy set in the PingOne system. | | address.streetAddress | Disable | The user's street address. | | address.locality | Disable | The user's locality. | | address.region | Disable | The user's region. | | address.postalCode | Disable | The user's ZIP or postal code. | | address.countryCode | Disable | The user's country code. The country name component. When specified, the value MUST be in ISO 3166-1 \\"alpha-2\\". | | lifecycle.status | Disable | The user's lifecycle status. This attribute is set to 'ACCOUNT\_OK' by default when the user is created. It can be set as 'VERIFICATION\_REQUIRED' if email verification is required after creation of the new account. | | lifecycle.suppressVerificationCode | Disable | The user will receive a verification email automatically. This attribute is set to 'false' by default when the user is created. It can be set as 'true' for the user to receive a verification email automatically. | | title | Disable | The user's title. | | type | Disable | The user's type. | | primaryPhone | Disable | The user's primary phone number. It must consist of at least one digit and must not contain more than 32 characters. | | mobilePhone | Disable | The user's mobile phone number. It must consist of at least one digit and must not contain more than 32 characters. | | preferredLanguage | Disable | The user's preferred written or spoken languages. | | timezone | Disable | The user's local timezone. It must conform with the IANA Time Zone database format `[RFC6557]`, also known as the \\"Olson\\" time zone database format `[Olson-TZ]`. For example, America/Los\_Angeles. | | accountId | Disable | The user's account ID. This attribute is organization-specific and has no special meaning within the platform. | | population.id | Disable | The user's population ID. | ## Managing Population ### During Account Creation The population is set using the population.id attribute. If a default population is configured in PingOne, new accounts are automatically assigned to it. To use a different population, you can either: Add the population.id attribute to the Create Profile with the desired population ID, or Assign the population as an entitlement. ### After Account Creation You can only modify the population when it is added as an entitlement. # Schema Reference The application schema is used to configure the objects returned from a connector. > [!NOTE] > > - The **Account Schema** tab is used to define the attributes for each object type in the application being configured. The schema attributes can be defined as **Entitlement** or **Multi-Valued**. Refer to [Managing Source Account Schemas]() for more information. > - The schema attributes that are not present by [default](<#default-account-schema>) must be defined as strings if not specified. The PingOne connector uses the following default correlation and object configurations. ## Default Correlation Configuration Before you aggregate accounts from this source, you can map account attributes with their corresponding identity attributes based on your requirements. You can customize the correlation configuration. Refer to [Assigning Source Accounts to Identities]() for more information. When you first create the PingOne source, the default correlation mapping is: | Account Attribute | Operation | Identity Attribute | | --- | --- | --- | | username | Equals | SailPoint Username (uid) | | email | Equals | Work email (email) | ## Default Account Schema Each source supports a variety of details, or attributes, about each user who has an account, such as their name, email address, manager name, and location. The set of account attributes each source stores and how they're organized is known as the account's *schema*. To best represent your data, you can configure sources to use an account schema matching the one you use in the external connector. Refer to [Managing Source Account Schemas]() for more information. ### Default Account Attributes The PingOne connector supports the following default account schema attributes and customer configurable attributes. The attributes must be defined as strings if not specified. | Attribute Name | Description | | --- | --- | | id | The user's unique ID. | | username | The user's unique name. | | email | The user's email address. | | name.honorificPrefix | The user's honorific prefix. | | name.given | The user's first name. | | name.middle | The user's middle name. | | name.family | The user's last name. | | name.honorificSuffix | The user's honorific suffix. | | name.formatted | The user's full name. | | nickname | The user's nickname. | | enabled | The user's active status. | | mfaEnabled | Indicates if the user requires multifactor authentication (MFA). | | createdAt | Time and date when the user was originally created. | | updatedAt | Time and date when the user was most recently modified. | | verifyStatus | Indicates if the user requires ID Validation authentication. | | environment.id | The user's environment ID. | | account.canAuthenticate | Indicates if the user has authenticated and can log in to the system. | | account.status | The user's account status. | | emailVerified | The user's email verification status. | | address.streetAddress | The user's street address. | | address.locality | The user's locality. | | address.region | The user's region. | | address.postalCode | The user's ZIP or postal code. | | address.countryCode | The user's country code. | | identityProvider.type | The user's identity provider type. | | identityProvider.id | The user's identity provider ID. | | lastSignOn.at | Date and time for the user's last remote sign-in sessions. | | lastSignOn.remoteIp | The IP address used during the user's last remote sign-in session. | | lifecycle.status | The user's lifecycle status. | | locale | The user's default location. | | type | The user's type. | | title | The user's title. | | primaryPhone | The user's primary phone number. | | mobilePhone | The user's mobile phone number. | | preferredLanguage | The user's preferred written or spoken languages. | | timezone | The user's local timezone. | | groups | The groups assigned to the user. | | roles | The roles assigned to the user. | | population | The user's population. | > [!NOTE] > > The PingOne connector supports aggregation of custom attributes. For more information, refer to [Custom Attributes](<#custom-attributes>). ## Custom Attributes Following are the two types of Custom attributes supported in PingOne: #### Configuring Custom Attributes in Account schema and Create Account 1. Declared For example: ```text { CustomAttribute : "Value", CustomMultiValuedAtts : ["Value1", "Value2"] } ``` Declared attributes can be added directly in Account schema by attribute name. > **Note** > > While configuring multivalued attribute in Account schema Ensure to mark that attribute as multivalued. 2. JSON The following example outlines how to add the JSON attributes in Account schema ```text { CustomJSONAttribute : { "id" : "01", "name" : "Test" } } ``` Below ID and Name should be added as complex attributes: - `CustomJSONAttribute.id` - `CustomJSONAttribute.name` > [!NOTE] > > Provisioning of custom multi-valued JSON attribute is not supported in PingOne connector. ## Default Entitlement Attributes Entitlement attributes define the entitlements, such as groups or roles, that can be assigned to the managed system's user accounts. Refer to [Managing Entitlements]() for more information. > [!CAUTION] > > Changing the attribute marked as the Entitlement ID after aggregating accounts or entitlements can result in duplicate entitlements being created, or access profiles and roles breaking. To avoid this, edit the entitlement schema before performing any aggregations. The PingOne connector supports three types of entitlements: [group](<#default-group-attributes>), [role](<#default-role-attributes>), and [population](<#default-population-attributes>). ### Default Group Attributes The PingOne connector also supports groups. The following attributes must be configured on your source and within SailPoint in order to manage groups. | Attribute Name | Description | | --- | --- | | id | The group's unique ID. | | name | The group's display name. | | description | The group's description. | | environment.id | The group's environment ID. | | population.id | The group's population ID. | | directMemberCounts.users | Total number of users which belong to the group. | | directMemberCounts.groups | Total number of groups which belong to the group. | | createdAt | Time and date when the group was originally created. | | updatedAt | Time and date that the group was most recently modified. | | checkSum | The group's checkSum. | ### Default Role Attributes The PingOne connector supports roles. The following attributes must be configured on your source and within SailPoint in order to manage roles. Refer to [Managing Roles]() for more information. | Attribute Name | Description | | --- | --- | | id | The role's unique identifier. | | name | The role's display name. | | description | The role's description. | | type | The role's type. | ### Default Population Attributes The PingOne connector also supports population. The following attributes must be configured on your source and within SailPoint in order to manage population. | Attribute Name | Description | | --- | --- | | id | The population's unique ID. | | name | The population's display name. | | environment.id | The population's environment ID. | | description | The population's description. | | userCount | Total number of users that belong to the population. | | default | The default status of the population. | | createdAt | Date and time the population was created. | | updatedAt | Date and time that the population was most recently modified. | | passwordPolicy.id | The population's passwordPolicy ID. | # Troubleshooting If you encounter any of the following issues or errors, SailPoint recommends that you follow the guidance provided below to resolve the error before contacting SailPoint Support. For issues or errors that are not addressed in this connector guide, refer to the following resources for troubleshooting information: - [SailPoint Identity Services Documentation]() - [SailPoint Support Knowledge Base]() - [SailPoint Developer Community]() ## Debug Logs For information about managing additional source settings, including debug logging and downloading connector logs, refer to [Managing Additional Settings](). ## Create Account fails without defined Population ```text [ConnectorError] 400 ERR_BAD_REQUEST, Request failed with status code 400, Bad Request, {"id":"f773aa6f-b2f5-475b-a602-e2d81c387ac0","code":"INVALID_DATA","message":"The request could not be completed. One or more validation errors were in the request.","details":[{"code":"REQUIRED_VALUE","target":"population","message":"User population must be provided when created by a client."}]} ``` This error displays if the population is not provided during the account creation process or if any of the population is not marked as 'default' in the PingOne system. **Resolution**: Ensure the population is provided during account creation or mark any population as 'default' in the PingOne system as per your requirement. ## Create Account fails with invalid timezone ```text [ConnectorError] 400 ERR_BAD_REQUEST, Request failed with status code 400, Bad Request, {"id":"52a0ea76-157e-407f-9ce4-440167ebfae3","code":"INVALID_DATA","message":"Validation Error : [timezone must match \"^\\w+\\/[\\w-]+(\\/\\w+)?$\"]","details":[{"code":"INVALID_VALUE","target":"timezone","message":"must match \"^\\w+\\/[\\w-]+(\\/\\w+)?$\""}]} (requestId: 187df180b91348d4bd96360767e014bd) ``` This error displays if the time zone format is entered incorrectly during the account creation process. **Resolution**: Ensure the timezone entered during create account conforms with the IANA Time Zone database format `[RFC6557]`, also known as the "Olson" time zone database format `[Olson-TZ]`. For example, "America/Los\_Angeles"