Use the GET /localIdentity/identityProfiles endpoint to retrieve a list of local identity profiles.

Query parameters

Parameter Value Description
page integer Page number to retrieve.
numberPerPage integer Number of local identity profiles per page.
filter string Filter criteria limits the local identity profiles that are returned to only those that match it. The filter criteria is compared to the local identity profile name and ID fields. The comparison is a case-insensitive partial match. No additional pattern based matching is supported.

Status codes

Code Reason
200 Success.
403 PingFederate does not have its IdP role enabled. Operation not available.
422 Validation error(s) occurred.

LocalIdentityProfiles - A collection of local identity profiles.

Property Type Description
items array[LocalIdentityProfile] The actual list of local identity profiles.

LocalIdentityProfile - A local identity profile.

Property Type Description
apcId * ResourceLink The reference to the authentication profile contract to use for this local identity profile.
authSourceUpdatePolicy LocalIdentityAuthSourceUpdatePolicy The attribute update policy for authentication sources.
authSources array[LocalIdentityAuthSource] The local identity authentication sources. Sources are unique.
dataStoreConfig DataStoreConfig The local identity profile data store configuration.
emailVerificationConfig EmailVerificationConfig The local identity email verification configuration.
fieldConfig FieldConfig The local identity profile field configuration.
id string The persistent, unique ID for the local identity profile. It can be any combination of [a-zA-Z0-9._-]. This property is system-assigned if not specified.
name * string The local identity profile name. Name is unique.
profileConfig ProfileConfig The local identity profile management configuration.
profileEnabled boolean Whether the profile configuration is enabled or not.
registrationConfig RegistrationConfig The local identity profile registration configuration.
registrationEnabled boolean Whether the registration configuration is enabled or not.

ResourceLink - A reference to a resource.

Property Type Description
id * string The ID of the resource.
location string A read-only URL that references the resource. If the resource is not currently URL-accessible, this property will be null.

LocalIdentityAuthSource - An authentication source name.

Property Type Description
id string The persistent, unique ID for the local identity authentication source. It can be any combination of [a-zA-Z0-9._-]. This property is system-assigned if not specified.
source string The local identity authentication source. Source is unique.

LocalIdentityAuthSourceUpdatePolicy - Settings to determine whether to store attributes that came from third-party authentication sources.

Property Type Description
retainAttributes boolean Whether or not to keep attributes after user disconnects.
storeAttributes boolean Whether or not to store attributes that came from authentication sources.
updateAttributes boolean Whether or not to update attributes when users authenticate.
updateInterval number The minimum number of days between updates.

RegistrationConfig - A local identity profile registration configuration.

Property Type Description
captchaEnabled boolean Whether CAPTCHA is enabled or not in the registration configuration.
templateName * string The template name for the registration configuration.

ProfileConfig - A local identity profile management configuration.

Property Type Description
deleteIdentityEnabled boolean Whether the end user is allowed to use delete functionality.
templateName * string The template name for end-user profile management.

FieldConfig - A local identity profile field configuration.

Property Type Description
fields array[LocalIdentityField] The field configuration for the local identity profile.

LocalIdentityField - Local identity profile fields.

Property Type Description
attributes Map[string, ] Attributes of the local identity field.
id * string Id of the local identity field.
label * string Label of the local identity field.
profilePageField boolean Whether this is a profile page field or not.
registrationPageField boolean Whether this is a registration page field or not.
type * LocalIdentityFieldType The type of the local identity field.

CheckboxGroupLocalIdentityField : LocalIdentityField - A checkbox group selection type field.

Property Type Description
attributes Map[string, ] Attributes of the local identity field.
id * string Id of the local identity field.
label * string Label of the local identity field.
options * array[string] The list of options for this selection field.
profilePageField boolean Whether this is a profile page field or not.
registrationPageField boolean Whether this is a registration page field or not.
type * LocalIdentityFieldType The type of the local identity field.

CheckboxLocalIdentityField : BaseDefaultValueLocalIdentityField - A checkbox selection type field.

Property Type Description
attributes Map[string, ] Attributes of the local identity field.
defaultValue string The default value for this field.
id * string Id of the local identity field.
label * string Label of the local identity field.
profilePageField boolean Whether this is a profile page field or not.
registrationPageField boolean Whether this is a registration page field or not.
type * LocalIdentityFieldType The type of the local identity field.

DateLocalIdentityField : BaseDefaultValueLocalIdentityField - A date type field.

Property Type Description
attributes Map[string, ] Attributes of the local identity field.
defaultValue string The default value for this field.
id * string Id of the local identity field.
label * string Label of the local identity field.
profilePageField boolean Whether this is a profile page field or not.
registrationPageField boolean Whether this is a registration page field or not.
type * LocalIdentityFieldType The type of the local identity field.

TextLocalIdentityField : BaseDefaultValueLocalIdentityField - A text type field.

Property Type Description
attributes Map[string, ] Attributes of the local identity field.
defaultValue string The default value for this field.
id * string Id of the local identity field.
label * string Label of the local identity field.
profilePageField boolean Whether this is a profile page field or not.
registrationPageField boolean Whether this is a registration page field or not.
type * LocalIdentityFieldType The type of the local identity field.

DropDownLocalIdentityField : BaseDefaultValueLocalIdentityField - A dropdown selection type field.

Property Type Description
attributes Map[string, ] Attributes of the local identity field.
defaultValue string The default value for this field.
id * string Id of the local identity field.
label * string Label of the local identity field.
options * array[string] The list of options for this selection field.
profilePageField boolean Whether this is a profile page field or not.
registrationPageField boolean Whether this is a registration page field or not.
type * LocalIdentityFieldType The type of the local identity field.

EmailLocalIdentityField : LocalIdentityField - An email type field.

Property Type Description
attributes Map[string, ] Attributes of the local identity field.
id * string Id of the local identity field.
label * string Label of the local identity field.
profilePageField boolean Whether this is a profile page field or not.
registrationPageField boolean Whether this is a registration page field or not.
type * LocalIdentityFieldType The type of the local identity field.

PhoneLocalIdentityField : LocalIdentityField - A phone type field.

Property Type Description
attributes Map[string, ] Attributes of the local identity field.
id * string Id of the local identity field.
label * string Label of the local identity field.
profilePageField boolean Whether this is a profile page field or not.
registrationPageField boolean Whether this is a registration page field or not.
type * LocalIdentityFieldType The type of the local identity field.

HiddenLocalIdentityField : BaseDefaultValueLocalIdentityField - A hidden selection type field.

Property Type Description
attributes Map[string, ] Attributes of the local identity field.
id * string Id of the local identity field.
label * string Label of the local identity field.
profilePageField boolean Whether this is a profile page field or not.
registrationPageField boolean Whether this is a registration page field or not.
type * LocalIdentityFieldType The type of the local identity field.

EmailVerificationConfig - A local identity email verification configuration.

Property Type Description
emailVerificationEnabled boolean Whether the email ownership verification is enabled.
emailVerificationErrorTemplateName string The template name for email verification error. The default is local.identity.email.verification.error.html.
emailVerificationSentTemplateName string The template name for email verification sent. The default is local.identity.email.verification.sent.html.
emailVerificationSuccessTemplateName string The template name for email verification success. The default is local.identity.email.verification.success.html.
fieldForEmailToVerify * string Field used for email ownership verification.
Note: Not required when emailVerificationEnabled is set to false.
fieldStoringVerificationStatus * string Field used for storing email verification status.
Note: Not required when emailVerificationEnabled is set to false.
notificationPublisherRef ResourceLink Reference to the associated notification publisher.
otlTimeToLive integer Field used OTL time to live. The default is 1440.
verifyEmailTemplateName string The template name for verify email. The default is message-template-email-ownership-verification.html.

DataStoreConfig - Local identity profile data store.

Property Type Description
dataStoreMapping Map[string, DataStoreAttribute] The data store mapping.
dataStoreRef * ResourceLink Reference to the associated data store.
type * DataStoreType The data store config type.

DataStoreAttribute - The data store attribute.

Property Type Description
metadata Map[string, ] The data store attribute metadata.
name * string The data store attribute name.
type * DataStoreType The data store attribute type.

LdapDataStoreAttribute : DataStoreAttribute - LDAP data store attribute.

Property Type Description
metadata Map[string, string]
name string
type * DataStoreType The data store type. [‘LDAP’ or ‘JDBC’ or ‘CUSTOM’]

LdapDataStoreConfig : DataStoreConfig - LDAP data store configuration.

Property Type Description
baseDn * string The base DN to search from. If not specified, the search will start at the LDAP’s root.
createPattern * string The Relative DN Pattern that will be used to create objects in the directory.
dataStoreMapping * Map[string, DataStoreAttribute] The data store mapping.
dataStoreRef * ResourceLink Reference to the associated data store.
objectClass * string The Object Class used by the new objects stored in the LDAP data store.
type * DataStoreType The data store config type.