Use the GET /idp/connectors/descriptors/{{identityProviderConnectorDescriptorId}} endpoint to retrieve information about the connector descriptor specified by its ID.

Path parameters

Parameter Value Description
identityProviderConnectorDescriptorId string(required) The type of connector descriptor to fetch.

Status codes

Code Reason
200 Success.
403 PingFederate does not have its IdP role enabled. Operation not available.

SaasPluginDescriptor - A SaaS Plugin.

Property Type Description
configDescriptor PluginConfigDescriptor The plugin configuration that includes information to access the target service provider.
description string The SaaS plugin description.
id string The SaaS plugin type.
saasPluginFieldInfoDescriptors array[SaasPluginFieldInfoDescriptor] The SaaS plugin attribute list for mapping from the local data store into Fields specified by the service provide.

PluginConfigDescriptor - Defines the configuration fields available for a plugin.

Property Type Description
actionDescriptors array[ActionDescriptor] The available actions for this plugin.
description string The description of this plugin.
fields array[FieldDescriptor] The configuration fields available for this plugin.
tables array[TableDescriptor] Configuration tables available for this plugin.

FieldDescriptor - Describes a plugin configuration field.

Property Type Description
advanced boolean Whether this is an advanced field or not.
defaultValue string Default value of the field.
description string Description of the field.
label string Label of the field to be displayed in the administrative console.
name string Name of the field.
required boolean Whether a value is required for this field or not.
type FieldDescriptorType The type of field descriptor.

RadioGroupFieldDescriptor : BaseSelectionFieldDescriptor - A selection-type field intended to be rendered as a group of radio buttons in a UI.

Property Type Description
advanced boolean Whether this is an advanced field or not.
defaultValue string Default value of the field.
description string Description of the field.
label string Label of the field to be displayed in the administrative console.
name string Name of the field.
optionValues array[OptionValue] The list of option values for this selection field.
required boolean Whether a value is required for this field or not.
type FieldDescriptorType The type of field descriptor.

OptionValue - An option name and value associated with a selection field.

Property Type Description
name string The name of the option.
value string The value associated with this option.

SelectFieldDescriptor : BaseSelectionFieldDescriptor - A selection field that is intended to be rendered as a dropdown list of options.

Property Type Description
advanced boolean Whether this is an advanced field or not.
defaultValue string Default value of the field.
description string Description of the field.
label string Label of the field to be displayed in the administrative console.
name string Name of the field.
optionValues array[OptionValue] The list of option values for this selection field.
required boolean Whether a value is required for this field or not.
type FieldDescriptorType The type of field descriptor.

CheckBoxFieldDescriptor : FieldDescriptor - A boolean field typically rendered as a checkbox in a configuration UI.

Property Type Description
advanced boolean Whether this is an advanced field or not.
defaultValue string Default value of the field.
description string Description of the field.
label string Label of the field to be displayed in the administrative console.
name string Name of the field.
required boolean Whether a value is required for this field or not.
type FieldDescriptorType The type of field descriptor.

UploadFileFieldDescriptor : FieldDescriptor - A field which allows the user to upload a file.

Property Type Description
advanced boolean Whether this is an advanced field or not.
defaultValue string Default value of the field.
description string Description of the field.
label string Label of the field to be displayed in the administrative console.
name string Name of the field.
required boolean Whether a value is required for this field or not.
type FieldDescriptorType The type of field descriptor.

TextAreaFieldDescriptor : FieldDescriptor - A field intended to be rendered as a text box in a UI.

Property Type Description
advanced boolean Whether this is an advanced field or not.
columns integer The number of columns for the text box.
defaultValue string Default value of the field.
description string Description of the field.
label string Label of the field to be displayed in the administrative console.
name string Name of the field.
required boolean Whether a value is required for this field or not.
rows integer The number of rows for the text box.
type FieldDescriptorType The type of field descriptor.

TextFieldDescriptor : FieldDescriptor - A text field.

Property Type Description
advanced boolean Whether this is an advanced field or not.
defaultValue string Default value of the field.
description string Description of the field.
encrypted boolean Determines whether the field value should be masked in the UI and encrypted on disk.
label string Label of the field to be displayed in the administrative console.
name string Name of the field.
required boolean Whether a value is required for this field or not.
size integer The size of the text field.
type FieldDescriptorType The type of field descriptor.

HashedTextFieldDescriptor : FieldDescriptor - A text field that will contain a secure salted hash.

Property Type Description
advanced boolean Whether this is an advanced field or not.
defaultValue string Default value of the field.
description string Description of the field.
label string Label of the field to be displayed in the administrative console.
name string Name of the field.
required boolean Whether a value is required for this field or not.
size integer The size of the text field.
type FieldDescriptorType The type of field descriptor.

TableDescriptor - Defines a plugin configuration table.

Property Type Description
columns array[FieldDescriptor] Get the columns in the table.
description string Description for the table.
label string Label for the table to be displayed in the administrative console.
name string The name of the table.
requireDefaultRow boolean Configure whether this table requires default row to be set.

ActionDescriptor - Describes an arbitrary action that is available for a plugin.

Property Type Description
description string The description of this action
download boolean Whether this action will trigger a download or invoke an internal action that will return a string result.
downloadContentType string If this is a download, this is the Content-Type of the downloaded file. Otherwise, this is null.
downloadFileName string If this is a download, this is the suggested file name of the downloaded file. Otherwise, this is null.
name string The name of this action

SaasPluginFieldInfoDescriptor - A Saas Plugin Field configuration.

Property Type Description
attributeGroup boolean Indicates whether this field belongs to group of attribute such as multivalued or sub-type custom attributes.
code * string The name or code that represents a field.
defaultValue string Default value for the field.
dsLdapMap boolean Indicates whether the field can be mapped raw to an LDAP attribute.
label * string The label for a field.
maxLength integer Maximum character length for a value.
minLength integer Minimum character length for a value.
multiValue boolean Whether the field can have multiple values.
notes array[string] Description or notes for the field.
options array[SaasPluginFieldOption] List of Option values available for this field.
pattern Pattern Pattern used to validate values of this field.
persistForMembership boolean The code that represents the field.
required boolean Indicates whether a value is required for this field.
unique boolean indicates whether the value of this field is unique.

SaasPluginFieldOption - A plugin configuration field value.

Property Type Description
code * string The code that represents the field.
label * string The label for the field.

Pattern

Property Type Description
flags integer
pattern string