Use the GET /authenticationSelectors endpoint to get the list of configured authentication selector instances.

Query parameters

Parameter Value Description
page integer Page number to retrieve.
numberPerPage integer Number of selectors per page.
filter string Filter criteria limits the authentication selector instances that are returned to only those that match it. The filter criteria is compared to the authentication selector instance 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 the appropriate IdP/SP role enabled. Operation not available.
422 Validation error(s) occurred.

AuthenticationSelectors - A collection of Authentication Selector instances.

Property Type Description
items array[AuthenticationSelector] The actual list of Authentication Selectors.

AuthenticationSelector - An Authentication Selector instance.

Property Type Description
attributeContract AuthenticationSelectorAttributeContract The list of attributes that the Authentication Selector provides.
configuration * PluginConfiguration Plugin instance configuration.
id * string The ID of the plugin instance. The ID cannot be modified once the instance is created.
Note: Ignored when specifying a connection’s adapter override.
name * string The plugin instance name. The name cannot be modified once the instance is created.
Note: Ignored when specifying a connection’s adapter override.
pluginDescriptorRef * ResourceLink Reference to the plugin descriptor for this instance. The plugin descriptor cannot be modified once the instance is created.
Note: Ignored when specifying a connection’s adapter override.

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.

PluginConfiguration - Configuration settings for a plugin instance.

Property Type Description
fields array[ConfigField] List of configuration fields.
tables array[ConfigTable] List of configuration tables.

ConfigTable - A plugin configuration table populated with values.

Property Type Description
inherited boolean Whether this table is inherited from its parent instance. If true, the rows become read-only. The default value is false.
name * string The name of the table.
rows array[ConfigRow] List of table rows.

ConfigRow - A row of configuration values for a plugin configuration table.

Property Type Description
defaultRow boolean Whether this row is the default.
fields * array[ConfigField] The configuration fields in the row.

ConfigField - A plugin configuration field value.

Property Type Description
encryptedValue string For encrypted or hashed fields, this attribute contains the encrypted representation of the field’s value, if a value is defined. If you do not want to update the stored value, this attribute should be passed back unchanged.
inherited boolean Whether this field is inherited from its parent instance. If true, the value/encrypted value properties become read-only. The default value is false.
name * string The name of the configuration field.
value string The value for the configuration field. For encrypted or hashed fields, GETs will not return this attribute. To update an encrypted or hashed field, specify the new value in this attribute.

AuthenticationSelectorAttributeContract - A set of attributes exposed by an Authentication Selector.

Property Type Description
extendedAttributes array[AuthenticationSelectorAttribute] A list of additional attributes that can be returned by the Authentication Selector. The extended attributes are only used if the Authentication Selector supports them.

AuthenticationSelectorAttribute - An attribute for the Authentication Selector attribute contract.

Property Type Description
name * string The name of this attribute.